de.aristaflow.adept2.model.activitymodel

Interface AbstractConfigurationSet

All Superinterfaces:

PluginDataContainer, UserAttributeContainer

All Known Subinterfaces:

ConfigurationSet, StorageConfigurationSet

public interface AbstractConfigurationSet
extends PluginDataContainer, UserAttributeContainer

This interface unifies the methods of a ConfigurationSet used with inheritance (in the GUI) as well as for storage.

Author:

Ulrich Kreher

Method Summary

Modifier and Type	Method and Description
void	addOperation(java.lang.String ecName, java.lang.String operationName) Adds the designated operation to this configuration set.
java.lang.String	getDeveloperDescription() Gets a description for the developer of the configuration and the process modeler.
java.lang.String	getName() Gets the system-wide unique name of this ConfigurationSet.
java.util.Map<java.lang.String,java.util.Collection<java.lang.String>>	getOperationNames() Gets the operations, this ConfigurationSet may override configurations of.
long	getRevision() Gets the (base) revision of this configuration set which allows to track changes.
java.lang.String	getStaffAssignmentRule() Gets the staff assignment rule that is proposed by the administrator of the activity model for all the activity template definitions of this configuration set.
State	getState() Gets the current deployment state of this configuration set, that is whether it is currently modified, it can be used or it may not be used any more.
void	removeOperation(java.lang.String ecName, java.lang.String operationName) Removes the designated operation to this configuration set.
void	setDeveloperDescription(java.lang.String developerDescription) Sets a description for the developer of the configuration and the process modeler.
void	setName(java.lang.String name) Sets the system-wide unique name of this configuration set, choose it with care.
void	setStaffAssignmentRule(java.lang.String staffAssignmentRule) Sets the staff assignment rule that is proposed by administrator of the activity model for all the activity template definitions of this configuration set.
void	setStaffAssignmentRule(java.lang.String staffAssignmentRule, java.lang.String ecName, java.lang.String operationName) Sets the staff assignment rule that is proposed by administrator of the activity model for the activity template definitions of this configuration set that are based on the designated operation.

Methods inherited from interface de.aristaflow.adept2.model.common.PluginDataContainer

getPluginData, getPluginDatas, getSupportedPlugins

Methods inherited from interface de.aristaflow.adept2.model.common.UserAttributeContainer

getUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValue

Method Detail

getOperationNames

java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> getOperationNames()

Gets the operations, this ConfigurationSet may override configurations of. For these operations one may create activity template definitions that are then based on this ConfigurationSet.

Returns:

The operation names this configuration set provides configurations for and of which activity template definitions may be created based on this ConfigurationSet. The names are indexed by the names of the corresponding executable component descriptions.

getName

java.lang.String getName()

Gets the system-wide unique name of this ConfigurationSet. This name also identifies activity template definitions and configuration entries in the global configuration and configurations for the runtime manager. Therefore this name may only be changed for the initial revision (0) IN_DEVELOPMENT. If you want another name later, you will have to create a new configuration set (and adapt the global configuration as well as the configurations for the runtime manager).

Returns:

The system-wide unique name of this ConfigurationSet that may be used in the global configuration or configurations of the runtime manager to override values of this configuration set.

getDeveloperDescription

java.lang.String getDeveloperDescription()

Gets a description for the developer of the configuration and the process modeler.

Returns:

A description for the developer of the configuration set and the process modeler. This description is not propagated to the process and is only part of the activity model.

getRevision

long getRevision()

Gets the (base) revision of this configuration set which allows to track changes. To modify a configuration set it needs to be in a development branch. As soon as it is changed, its state is set to IN_DEVELOPMENT but the revision remains until the branch is released.

Only a configuration set having no released revision yet may change its name.

Returns:

The revision of this configuration or the revision which it is based upon.

getState

State getState()

Gets the current deployment state of this configuration set, that is whether it is currently modified, it can be used or it may not be used any more. This state also applies to all corresponding activity template definitions. An outdated ConfigurationSet implicitly also sets all its activity template definitions to outdated. However, the state is not directly propagated. Rather before using an entity all its parent entities have to be checked for their state.

Returns:

The current deployment state of this configuration set that implicitly also applies to all child entities.

getStaffAssignmentRule

java.lang.String getStaffAssignmentRule()

Gets the staff assignment rule that is proposed by the administrator of the activity model for all the activity template definitions of this configuration set. However, the process modeler can deviate from this.
An empty string will be returned if this is undefined.

This attribute overrides the attribute of the corresponding parent entities.

Returns:

The staff assignment rule that is proposed by the administrator of the activity model for all the activity template definitions or an empty string.

addOperation

void addOperation(java.lang.String ecName,
                  java.lang.String operationName)

Adds the designated operation to this configuration set. This is only allowed when being IN_DEVELOPMENT. Afterwards there may be activity templates definitions in this configuration set that are based on the designated operation.

Before adding an operation one has to check that there are no conflicts in the configuration descriptions that apply to all activity template definitions of this configuration set and the newly added operation (and its executable component description).

Parameters:

ecName - The name of the executable component description which is parent of the operation.

operationName - The name of the operation to be added to this configuration set which allows to have activity template definitions based on this operation in this configuration set.

removeOperation

void removeOperation(java.lang.String ecName,
                     java.lang.String operationName)

Removes the designated operation to this configuration set. This is only allowed when being IN_DEVELOPMENT. Afterwards there may not be any activity templates definitions in this configuration set that are based on the designated operation. Existing ones will have to be dropped by the corresponding repository manager.
All configurations (and configuration descriptions) provided for the operation are also removed (internally by this configuration set). This also includes configurations (and configuration descriptions) for the corresponding executable component description if there are no more operations left for the executable component description.

Parameters:

ecName - The name of the executable component description which is parent of the operation.

operationName - The name of the operation to be removed from this configuration set.

setName

void setName(java.lang.String name)

Sets the system-wide unique name of this configuration set, choose it with care. Since this name also identifies activity template definitions and configuration entries in the global configuration and configurations for the runtime manager, it cannot be changed after at least one revision of this configuration has been released. If you want another name later, you will have to create a new configuration set (and adapt the global configuration as well as the configurations for the runtime manager).

Note that changing the name for a configuration set having no released revision yet propagates the change to all existing activity template definitions since they reference this configuration set via its name.

Parameters:

name - The system-wide unique name of this ConfigurationSet that may be used in the global configuration or configurations of the runtime manager to override values of this configuration set.

setDeveloperDescription

void setDeveloperDescription(java.lang.String developerDescription)

Sets a description for the developer of the configuration and the process modeler.

Parameters:

developerDescription - A description of the configuration set and the process modeler. This description is not propagated to the process and is only part of the activity model.

setStaffAssignmentRule

void setStaffAssignmentRule(java.lang.String staffAssignmentRule)

Sets the staff assignment rule that is proposed by administrator of the activity model for all the activity template definitions of this configuration set. The designated operation has to be part of this configuration set.
Use the empty string if this is undefined.

This attribute overrides the attributes of the corresponding parent entities.

Parameters:

staffAssignmentRule - The staff assignment rule that is proposed by the administrator of the activity model for all the activity template definitions based or an empty string.

setStaffAssignmentRule

void setStaffAssignmentRule(java.lang.String staffAssignmentRule,
                            java.lang.String ecName,
                            java.lang.String operationName)

Sets the staff assignment rule that is proposed by administrator of the activity model for the activity template definitions of this configuration set that are based on the designated operation. However, the process modeler can deviate from this. The designated operation has to be part of this configuration set.
Use the empty string if this is undefined.

This attribute overrides the general one from this configuration set and the attribute of the corresponding parent entities.

Parameters:

ecName - The name of the executable component description which is parent of the operation.

operationName - The name of the operation of which the activity template definitions of this configuration set are provided the designated staff assignment rule.

staffAssignmentRule - The staff assignment rule that is proposed by the administrator of the activity model for the activity template definitions based on the designated operation or an empty string.