public interface AbstractActivityTemplateDefinition extends PluginDataContainer, UserAttributeContainer
ActivityTemplateDefinition used with inheritance (in the GUI) as
well as for storage.| Modifier and Type | Method and Description |
|---|---|
boolean |
areExecutionControlPropertiesInherited()
Gets whether this activity template definition inherits the execution
control properties from its operation.
|
ClassLoaderUsage |
getClassLoaderUsage()
Gets what classloader to use for the executable component of this activity
template definition.
|
java.lang.String |
getDescription()
Gets a description for this activity template definition for usage in the
process model.
|
java.lang.String |
getDeveloperDescription()
Gets a description for the developer of the activity template definition
and the administrator of the activity model.
|
ExecutionControlProperties |
getExecutionControlProperties()
Gets the interactions that the executable component of this activity
template definition supports for controlling its execution, that is whether
the component responds to signals from the outside to suspend, reset or
close the component.
|
java.lang.String |
getGUIContextID()
Gets the ID of the GUI context the executable component of this activity
template definition needs, for instance, an SWT or an AWT context.
|
java.util.UUID |
getIconID()
Gets the ID of the icon to use for process steps and worklist items of the
underlying executable component.
|
java.util.UUID |
getID()
Gets the (world-wide) unique ID of the
ActivityTemplateDefinition this activity template definition
is based upon. |
java.lang.String |
getImplementationClass()
Gets the name of the class implementing
ExecutableComponent
which is called when the process node is executed for which this activity
template definition is for. |
java.lang.String |
getLicenceInformation()
Gets the licence information for this activity template definition.
|
java.lang.String |
getName()
Gets the name of this activity template definition.
|
ParameterChangePolicy |
getParameterChangePolicy()
Gets the parameter change policy for the operation of this activity, that
is the supported interface changes for this operation (add, change and/or
remove parameters).
|
long |
getRevision()
Gets the (base) revision of this activity template definition which allows
to track changes.
|
java.lang.String |
getStaffAssignmentRule()
Gets the staff assignment rule that is proposed by the developer of the
operation or the administrator of the activity model.
|
State |
getState()
Gets the current deployment state of this activity template definition,
that is whether it is currently modified, it can be used or it may not be
used any more.
|
byte[] |
getSystemComponent()
Gets the signature in case the executable component of this activity
template definition is privileged component and may access system services.
|
boolean |
isClassLoaderUsageInherited()
Gets whether this activity template definition inherits the classloader
usage from its operation.
|
boolean |
isDescriptionInherited()
Gets whether this activity template definition inherits the description
from its operation.
|
boolean |
isDeveloperDescriptionInherited()
Gets whether this activity template definition inherits the developer
description from its operation.
|
boolean |
isGUIContextIDInherited()
Gets whether this activity template definition inherits the GUI context ID
from its operation.
|
boolean |
isIconIDInherited()
Gets whether this activity template definition inherits the icon from its
executable component description.
|
boolean |
isImplementationClassInherited()
Gets whether this activity template definition inherits the implementation
class from its operation.
|
boolean |
isLicenceInformationInherited()
Gets whether this activity template definition inherits the licence
information from its operation.
|
boolean |
isParameterChangePolicyInherited()
Gets whether this activity template definition inherits the parameter
change policy from its operation.
|
boolean |
isStaffAssignmentRuleInherited()
Gets whether this activity template definition inherits the staff
assignment rule from its configuration set or its operation (depending on
whether
ActivityTemplateDefinition.getConfigurationSet() returns a
valid configuration set). |
boolean |
isSupportsTestExecutionInherited()
Gets whether this activity template definition inherits the supports test
execution flag from its operation.
|
boolean |
isSupportsViewOnlyInherited()
Gets whether this activity template definition inherits the supports view
only flag from its operation.
|
boolean |
isSystemComponentInherited()
Gets whether this activity template definition inherits the system
component signature from its operation.
|
void |
removeOwnClassLoaderUsage()
Removes the classloader usage of this activity template definition and
inherits the value from the corresponding operation again.
|
void |
removeOwnDescription()
Removes the description of this activity template definition and inherits
the value from the corresponding operation again.
|
void |
removeOwnDeveloperDescription()
Removes the developer description of this activity template definition and
inherits the value from the corresponding operation again.
|
void |
removeOwnExecutionControlProperties()
Removes the execution control properties of this activity template
definition and inherits them from the corresponding operation again.
|
void |
removeOwnGUIContextID()
Removes the GUI context ID of this activity template definition and
inherits the value from the corresponding operation again.
|
void |
removeOwnIconID()
Removes the icon of this activity template definition and inherits the
value from the corresponding operation again.
|
void |
removeOwnImplementationClass()
Removes the implementation class of this activity template definition and
inherits the value from the corresponding operation again.
|
void |
removeOwnLicenceInformation()
Removes the licence information of this activity template definition and
inherits the value from the corresponding operation again.
|
void |
removeOwnParameterChangePolicy()
Removes the parameter change policy of this activity template definition
and inherits the value from the corresponding operation again.
|
void |
removeOwnStaffAssignmentRule()
Removes the staff assignment rule of this activity template definition and
inherits the value from the corresponding configuration set or operation
again.
|
void |
removeOwnSupportsTestExecution()
Removes the supports test execution flag of this activity template
definition and inherits the value from the corresponding operation again.
|
void |
removeOwnSupportsViewOnly()
Removes the supports view only flag of this activity template definition
and inherits the value from the corresponding operation again.
|
void |
removeOwnSystemComponent()
Removes the system component signature of this activity template definition
and inherits the value from the corresponding operation again.
|
void |
setClassLoaderUsage(ClassLoaderUsage classLoaderUsage)
Sets what classloader to use for the executable component of this activity
template definition.
|
void |
setDescription(java.lang.String description)
Sets a description for this activity template definition for usage in the
process model.
|
void |
setDeveloperDescription(java.lang.String developerDescription)
Sets a description for the developer of the operation of this activity
template definition and the administrator of the activity model.
|
void |
setExecutionControlProperties(ExecutionControlProperties ecp)
Sets the interactions that the executable component of this activity
template definition supports for controlling its execution, that is whether
the corresponding component responds to signals from the outside to
suspend, reset or close the component.
|
void |
setGUIContextID(java.lang.String guiContextID)
Sets the ID of the GUI context the executable component of this activity
template definition needs, for instance, an SWT or an AWT context; or
GUIConstants.NULL_CONTEXT if no GUI context is required. |
void |
setIconID(java.util.UUID iconID)
Sets the ID of the icon to use for process steps and worklist items for
this activity template definition.
|
void |
setID(java.util.UUID id)
sets the (world-wide) unique ID of the
ActivityTemplateDefinition this activity template definition
is based upon. |
void |
setImplementationClass(java.lang.String implementationClass)
Sets the name of the class implementing
ExecutableComponent
for the physical counterpart of the component description of this activity
template definition. |
void |
setLicenceInformation(java.lang.String licenceInformation)
Sets the licence information for this activity template definition.
|
void |
setName(java.lang.String name)
Sets the name of this activity template definition.
|
void |
setParameterChangePolicy(ParameterChangePolicy pcp)
Sets the parameter change policy for the operation of this activity
template definition, that is the supported interface changes for the
operation (add, change and/or remove parameters).
|
void |
setStaffAssignmentRule(java.lang.String staffAssignmentRule)
Sets the staff assignment rule that is proposed by the developer of the
operation of this activity template definition or the administrator of the
activity model.
|
void |
setSupportsTestExecution(boolean supportsTestExecution)
Sets whether the operation of this activity template definition supports a
test execution.
|
void |
setSupportsViewOnly(boolean supportsViewOnly)
Sets whether the operation of this activity template definition supports a
view only mode.
|
void |
setSystemComponent(byte[] signature)
Sets the signature for the executable component of this activity template
which allows privileged access to system services.
|
boolean |
supportsTestExecution()
Gets whether the operation if this activity template definition supports a
test execution.
|
boolean |
supportsViewOnly()
Gets whether the operation of this activity template definition supports a
view only mode.
|
getPluginData, getPluginDatas, getSupportedPluginsgetUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValuejava.util.UUID getID()
ActivityTemplateDefinition this activity template definition
is based upon. This changes with every revision and thus allows to identify
a revision since the
normal revision does not suffice to identify an
ActivityTemplateDefinition since two different activity models
usually go through the very same revisions but with different changes.ActivityTemplateDefinition this activity template
definition is based upon.void setID(java.util.UUID id)
ActivityTemplateDefinition this activity template definition
is based upon. This changes with every revision and thus allows to identify
a revision since the
normal revision does not suffice to identify an
ActivityTemplateDefinition since two different activity models
usually go through the very same revisions but with different changes.id - The (world-wide) unique ID (including the revision) of the
ActivityTemplateDefinition this activity template
definition is based upon.java.lang.String getName()
java.lang.String getDescription()
java.lang.String getDeveloperDescription()
This attribute overrides the corresponding
parent attribute.
long getRevision()
state is set to IN_DEVELOPMENT but the revision remains
until the branch is released. unique ID.State getState()
ExecutableComponentDescription, Operation and
ConfigurationSethave to be checked for their state.java.lang.String getImplementationClass()
ExecutableComponent
which is called when the process node is executed for which this activity
template definition is for. The
classpath needs to be set
appropriately. null may be
exceptionally returned.
This attribute overrides the corresponding parent attribute.
ExecutableComponent
which is called when the process node is executed for which this
activity template definition is for. This may exceptionally be
null for activity template definitions that are only
to be executed with the runtime service.ClassLoaderUsage getClassLoaderUsage()
This attribute overrides the corresponding parent attribute.
byte[] getSystemComponent()
This attribute overrides the corresponding parent attribute.
java.lang.String getGUIContextID()
This attribute overrides the corresponding parent attribute.
GUIConstants.NULL_CONTEXT
if no GUI context is required.ExecutionControlProperties getExecutionControlProperties()
This attribute overrides the corresponding parent attribute.
boolean supportsViewOnly()
SessionContext.isViewOnly()boolean supportsTestExecution()
ActivityTemplateDefinition.getTestConfiguration(),
SessionContext.isTestMode()java.util.UUID getIconID()
This attribute overrides the corresponding parent attribute.
java.lang.String getLicenceInformation()
This attribute overrides the corresponding
parent attribute.
ParameterChangePolicy getParameterChangePolicy()
java.lang.String getStaffAssignmentRule()
This rule is either set in this activity template definition or inherited from the corresponding operation.
void setName(java.lang.String name)
Operation. This name is used
as default name for the corresponding process node which in turn is used in
worklists to allow the end user to identify the corresponding worklist
item. This must neither be null nor the empty string. The designated name must not exist for the executable component description.
name - The name of this activity template definition (unique with
respect to the Operation) which is used as default
name for the corresponding process node. This must neither be null
nor the empty string.void setDescription(java.lang.String description)
This attribute overrides the corresponding
parent attribute.
description - A description for this activity template definition for
usage in the process model that may be displayed in worklists. Use
the empty string to unset the description.void setDeveloperDescription(java.lang.String developerDescription)
This attribute overrides the corresponding
parent attribute.
developerDescription - A description for the developer of the
operation and the administrator of the activity model. This
description is not propagated to the process and is only part of
the activity model. Use the empty string to unset the developer
description for this entity.void setImplementationClass(java.lang.String implementationClass)
ExecutableComponent
for the physical counterpart of the component description of this activity
template definition.
This attribute overrides the corresponding
parent attribute.
implementationClass - The name of the class implementing
ExecutableComponent for the physical counterpart of
the component description of this activity template definition
which is instantiated and called at runtime.void setClassLoaderUsage(ClassLoaderUsage classLoaderUsage)
This attribute overrides the corresponding
parent attribute.
classLoaderUsage - What classloader to use for executable component of
this activity template definition; one for each execution, shared
for all executions of the same activity or the classloader of the
AristaFlow platform.void setSystemComponent(byte[] signature)
This attribute overrides the corresponding
parent attribute. This is only
allowed in case this activity template definition provides an own
implementation.
signature - A signature to verify the component to prevent harmful
components from system access. Use null for a
non-system component.void setGUIContextID(java.lang.String guiContextID)
GUIConstants.NULL_CONTEXT if no GUI context is required.
This attribute overrides the corresponding
parent attribute. This is only
allowed in case this activity template definition provides an own
implementation.
guiContextID - The ID of the GUI context the executable component of
this activity template definition needs to render its graphical
user interface to. Use GUIConstants.NULL_CONTEXT in case
no GUI context is needed.void setExecutionControlProperties(ExecutionControlProperties ecp)
This attribute overrides the corresponding
parent attribute. Overriding will only be allowed to more restrictive
properties, that is, suspending, reseting or closing may be prevented by
overriding but not enabled if this activity template definition does not
specify an own implementation.
ecp - The interactions that the executable component of this activity
template definition supports for controlling its execution, that
is whether the component responds to signals from the outside to
suspend, reset or close the component. Only more restrictive
properties are allowed when overriding in case of an inherited
implementation. Call
removeOwnExecutionControlProperties() to inherit the
properties from the parent entity.void setSupportsViewOnly(boolean supportsViewOnly)
This attribute overrides the corresponding
parent attribute. Overriding
will only be allowed to restrict, that is, view only may be prohibited but
not allowed if this activity template definition does not specify an own
implementation.
supportsViewOnly - Whether the operation of this activity template
definition supports a view only mode to re-execute the operation
only for displaying input data as well as the formerly written
output data.SessionContext.isViewOnly()void setSupportsTestExecution(boolean supportsTestExecution)
This attribute overrides the corresponding
parent attribute.
Overriding will only be allowed to restrict, that is, view only may be
prohibited but not allowed if this activity template definition does not
specify an own implementation.
supportsTestExecution - Whether the operation of this activity
template definition supports a test mode without any critical side
effects.ActivityTemplateDefinition.getTestConfiguration(),
SessionContext.isTestMode()void setIconID(java.util.UUID iconID)
This attribute overrides the corresponding
parent attribute.
iconID - The ID of the icon to use for process steps and worklist
items; the corresponding icon may be retrieved in various sizes
and formats. This must not be null since it is not
allowed to remove the icon of the parent entity.void setLicenceInformation(java.lang.String licenceInformation)
This attribute overrides the corresponding
parent attribute.
licenceInformation - The licence information for this activity
template definition as arbitrary string or the empty string.void setParameterChangePolicy(ParameterChangePolicy pcp)
This attribute overrides the corresponding
parent
attribute. Overriding will only be allowed to restrict, that is, the
interface of the operation may be changed less if this activity template
definition does not specify an own implementation. The following order applies to the restrictions:
pcp - The parameter change policy for the operation of this activity
template definition that specifies the supported interface changes
for the operation. This must not be null. void setStaffAssignmentRule(java.lang.String staffAssignmentRule)
This attribute overrides the corresponding parent attribute
(AbstractConfigurationSet.setStaffAssignmentRule(String)
or AbstractOperation.setStaffAssignmentRule(String)).
staffAssignmentRule - The staff assignment rule that is proposed by
the developer of the operation of this activity template
definition or the administrator of the activity model or an empty
string.boolean isDescriptionInherited()
getDescription().void removeOwnDescription()
boolean isDeveloperDescriptionInherited()
getDeveloperDescription().void removeOwnDeveloperDescription()
boolean isImplementationClassInherited()
getImplementationClass().void removeOwnImplementationClass()
boolean isClassLoaderUsageInherited()
getClassLoaderUsage().void removeOwnClassLoaderUsage()
boolean isSystemComponentInherited()
getSystemComponent().void removeOwnSystemComponent()
boolean isGUIContextIDInherited()
getGUIContextID().void removeOwnGUIContextID()
boolean areExecutionControlPropertiesInherited()
getGUIContextID().void removeOwnExecutionControlProperties()
The execution control properties will also be removed from this activity template definition.
boolean isSupportsViewOnlyInherited()
supportsViewOnly().void removeOwnSupportsViewOnly()
boolean isSupportsTestExecutionInherited()
supportsViewOnly().void removeOwnSupportsTestExecution()
boolean isIconIDInherited()
getIconID().void removeOwnIconID()
boolean isLicenceInformationInherited()
getLicenceInformation().void removeOwnLicenceInformation()
boolean isParameterChangePolicyInherited()
getParameterChangePolicy().void removeOwnParameterChangePolicy()
boolean isStaffAssignmentRuleInherited()
ActivityTemplateDefinition.getConfigurationSet() returns a
valid configuration set). If it does not inherit the staff assignment rule,
it will override it with an own value.getStaffAssignmentRule().void removeOwnStaffAssignmentRule()