public interface ActivityTemplate extends BuildtimeActivity
ActivityTemplate represents the object that is finally
assigned (dragged) to a process node; it is a self-contained artificial
vessel to transport all relevant information to the process model. Therefore
it contains the merged information that is provided by the activity model by
several entities, that is, it combines the attributes of an
ExecutableComponentDescription, an Operation, optionally a
ConfigurationSet and an ActivityTemplateDefinition. Besides its usage for the process model it can certainly also be used for other purposes, for instance, to display the merged attributes of the activity model in advance when editing it.
| Modifier and Type | Method and Description |
|---|---|
ActivityConfiguration |
getConfiguration()
Gets the configuration of this abstract activity.
|
ConfigurationDescription |
getConfigurationDescription()
Gets the configuration description for this activity template, that is a
description of all configuration values that are needed or supported at
runtime.
|
java.lang.String |
getDeveloperDescription()
Gets a description for the process modeler and the administrator of the
activity model.
|
java.util.Map<java.util.UUID,Identifier> |
getIdentifiers()
Gets all identifiers of all (defined) parameters of this activity template
independent from the access type of the parameters.
|
java.lang.String |
getLicenceInformation()
Gets the licence information for the operation of this activity template.
|
ATParameter |
getParameter(java.lang.String name,
ActivityConstants.AccessType accessType)
Gets the parameter object linked to the passed parameter name.
|
java.util.Set<ATParameter> |
getParameters(ActivityConstants.AccessType accessType)
Gets the parameters of the designated access type of the operation of this
activity template.
|
java.util.Map<java.lang.String,ATParameterTemplate> |
getParameterTemplates()
Gets parameter templates that are defined for this activity template.
|
java.lang.String |
getStaffAssignmentRule()
Gets the staff assignment rule that is proposed by the developer of the
operation of this activity template or the administrator of the activity
model.
|
State |
getState()
Gets the current deployment state of the activity model branch which is the
aggregated state of the
ActivityTemplateDefinition of this
activity template and the state of its parent entities. |
ActivityConfiguration |
getTestConfiguration()
Gets the (stand-alone) test configuration of this activity template that
corresponds to the (merged)
configuration description of this activity template. |
getParameterChangePolicy, supportsTestExecutiongetActivityName, getAttributeOrigins, getClassLoaderUsage, getClassPath, getConfigurationName, getDescription, getExecutableComponentName, getExecutionControlProperties, getGUIContextID, getIconID, getID, getImplementationClass, getOperationName, getSeparatedClassPaths, getSystemComponent, supportsViewOnlygetPluginData, getPluginDatas, getSupportedPluginsgetUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValuejava.lang.String getDeveloperDescription()
State getState()
ActivityTemplateDefinition of this
activity template and the state of its parent entities. The priority is as
follows:
IN_PRODUCTION if
all the corresponding activity model entities are also
IN_PRODUCTION. OUTDATED has the highest priority
and overrides all other states.OUTDATED
entity causes this activity template to be outdated; for being
IN_PRODUCTION, all entities also need to be
IN_PRODUCTION.java.lang.String getLicenceInformation()
ConfigurationDescription getConfigurationDescription()
ActivityConfiguration getConfiguration()
getConfiguration in interface AbstractActivityActivityConfiguration getTestConfiguration()
configuration description of this activity template. These configuration
values only apply when the operation is executed in test mode, that is the
operation is provided this configuration instead of the normal
configuration. This test configuration is already merged with the
normal (merged) configuration. Note that the
test configuration allows to override fixed values of the normal
configuration. Operation.getConfiguration()Operation.getTestConfiguration()ConfigurationSet.getConfiguration() (if there is a
configuration set)ConfigurationSet.getTestConfiguration() (if there is a
configuration set)ConfigurationSet.getConfiguration(ExecutableComponentDescription)
(if there is a configuration set)ConfigurationSet.getTestConfiguration(ExecutableComponentDescription)
(if there is a configuration set)ConfigurationSet.getConfiguration(Operation) (if there is a
configuration set)ConfigurationSet.getTestConfiguration(Operation) (if there is a
configuration set)ActivityTemplateDefinition.getConfiguration()ActivityTemplateDefinition.getTestConfiguration()getTestConfiguration in interface BuildtimeActivityjava.util.Set<ATParameter> getParameters(ActivityConstants.AccessType accessType)
parameter change policy of this
operation, its collection of parameters may be fix, parameters may be
changed and/or parameters may be added to the collection. Apparently this
requires the underlying implementation of this operation to check for the
defined parameters at runtime and react appropriately. The parameters need not be based on parameter templates of the activity template.
getParameters in interface AbstractActivityaccessType - The access type of the parameters to be retrieved (only
values in ActivityConstants.AccessType.activityRelatedValues() are allowed).ATParameter getParameter(java.lang.String name, ActivityConstants.AccessType accessType)
AbstractActivitygetParameter in interface AbstractActivityname - The name of the parameter.accessType - The access type of the parameter. Only values in
ActivityConstants.AccessType.activityRelatedValues() are allowed!null in case no
parameter of the designated name exists for the designated access
type.java.util.Map<java.lang.String,ATParameterTemplate> getParameterTemplates()
This templates need not be used at all when creating parameters. If an operation needs to ensure that only these templates are used, an appropriate check needs to be provided that verifies the created parameters.
java.lang.String getStaffAssignmentRule()
java.util.Map<java.util.UUID,Identifier> getIdentifiers()