de.aristaflow.adept2.model.execution

Interface ExecutableBusinessProcessInstance

All Superinterfaces:

PluginDataContainer, UserAttributeContainer

All Known Subinterfaces:

ActivityInstance, DecisionActivityInstance, LightWeightProcessInstance

public interface ExecutableBusinessProcessInstance
extends PluginDataContainer, UserAttributeContainer

The ExecutableBusinessProcessInstance is an instance of ExecutableBusinessProcess and also resembles the interface. It differs in its usage. The ExecutableBusinessProcessInstance is for provision of the appropriate information at runtime and may therefore contain instance-specific data, whereas ExecutableBusinessProcess only contains template-specific data. For instance, the name of an EBP may depend on the value of a data element; this dependency will be resolved in the ExecutableBusinessProcessInstance.

Author:

Ulrich Kreher

Method Summary

Modifier and Type	Method and Description
ParameterDataContext	getAttachedDataContext() Gets the data context which provides the values of attached data elements.
Configuration	getConfiguration() Gets the configuration of this executable business process.
java.lang.String	getDescription() Returns the description of this executable business process instance.
ExecutionControlProperties	getExecutionControlProperties() Returns the execution control properties that reflect the abilities of this executable business process instance on reacting to execution control requests from the outside.
java.lang.String	getGroupExecutionContext() Gets the execution context of the group this EBP instance can be part of.
java.lang.String	getGroupName() Gets the name of the group this EBP instance can be part of.
java.util.UUID	getIconID() Gets the ID of the icon to use for process steps and worklist items of this EBPInstance.
java.lang.String	getName() Returns the name of this node/subprocess to be displayed in the worklist or the called application.
ProcessModelParameter	getParameter(java.lang.String name, ActivityConstants.AccessType accessType) Returns the parameter object linked to the passed parameter name.
java.util.Set<ProcessModelParameter>	getParameters(ActivityConstants.AccessType accessType) Returns set of parameter objects by which this Activity/subprocess is provided with data values by the process management system or the set of parameter objects by which the process management system is provided with the calculation results of this component.
java.lang.String	getProcessInstanceName() Gets the resolved name of the (parent) process instance of the executable business process of this EBPInstance.
java.lang.String	getProcessTemplateName() Gets the name of the (parent) process template of the executable business process of this EBPInstance.
java.lang.String	getProcessTemplateVersion() Gets the logical version of the process template of the (parent) process template of the executable business process of this EBPInstance.
java.lang.String	getProcessType() Gets the process type of the (parent) process template of the executable business process of this EBPInstance.

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

getProcessType

java.lang.String getProcessType()

Gets the process type of the (parent) process template of the executable business process of this EBPInstance.

Returns:

The name of the process type of the (parent) process template of this executable business process.

getProcessTemplateVersion

java.lang.String getProcessTemplateVersion()

Gets the logical version of the process template of the (parent) process template of the executable business process of this EBPInstance. This may be the empty string.

Returns:

The logical version of the process template of the (parent) process template of this executable business process.

getProcessTemplateName

java.lang.String getProcessTemplateName()

Gets the name of the (parent) process template of the executable business process of this EBPInstance.

Returns:

The name of the (parent) process template of this executable business process.

getProcessInstanceName

java.lang.String getProcessInstanceName()

Gets the resolved name of the (parent) process instance of the executable business process of this EBPInstance.

Returns:

The resolved name of the (parent) process instance of this executable business process.

getName

java.lang.String getName()

Returns the name of this node/subprocess to be displayed in the worklist or the called application.

Returns:

The name of this node/subprocess.

getDescription

java.lang.String getDescription()

Returns the description of this executable business process instance.

Returns:

The description of this executable business process instance.

getIconID

java.util.UUID getIconID()

Gets the ID of the icon to use for process steps and worklist items of this EBPInstance. With the ID the corresponding item can be requested from an icon providing service in various sizes and formats.

Returns:

The ID of the icon to use for process steps and worklist items; the corresponding icon may be retrieved in various sizes and formats or null in case the EBPInstance does not have a specific icon.

getExecutionControlProperties

ExecutionControlProperties getExecutionControlProperties()

Returns the execution control properties that reflect the abilities of this executable business process instance on reacting to execution control requests from the outside. This includes e.g. if it is possible to abort or suspend the application.

Returns:

the execution control properties of this EBP instance

getConfiguration

Configuration getConfiguration()

Gets the configuration of this executable business process. It is ensured that all values that are necessary (of which the configuration entry is mandatory) have an appropriate value.

Returns:

The configuration values set for this executable business process based on the configuration description and providing all values for all mandatory entries.

getParameter

ProcessModelParameter getParameter(java.lang.String name,
                                   ActivityConstants.AccessType accessType)

Returns the parameter object linked to the passed parameter name. The parameter name is the symbolic name by which an application component can retrieve a data value from the data context of the process management system.

Parameters:

name - The name of the parameter

accessType - The access type of the parameter.

Returns:

the corresponding parameter object

See Also:

ProcessModelParameter

getParameters

java.util.Set<ProcessModelParameter> getParameters(ActivityConstants.AccessType accessType)

Returns set of parameter objects by which this Activity/subprocess is provided with data values by the process management system or the set of parameter objects by which the process management system is provided with the calculation results of this component. The actual content of the set depends on the parameter accessType which determines, if the parameters for READ or WRITE access are required.

Parameters:

accessType - the type of the parameter, i.e. READ or WRITE access

Returns:

the set of the parameters of this component, either READ or WRITE parameters, according to the parameter accessType

See Also:

ProcessModelParameter

getAttachedDataContext

ParameterDataContext getAttachedDataContext()

Gets the data context which provides the values of attached data elements. This allows display these values in worklists and use them for filtering and ordering.

Returns:

The data context containing data values attached to this EBP which allow for filtering and ordering worklists.

getGroupName

java.lang.String getGroupName()

Gets the name of the group this EBP instance can be part of. EBP instances with the same group name and execution context can be represented by the same worklist item. They can also be executed as group via an appropriate list, form or a similar UI element.
If the EBP instance cannot be part of a group, this will be the empty string.

Returns:

The name of the group this EBP instance can be part of, the empty string for an EPB instance that cannot be part of a group.

getGroupExecutionContext

java.lang.String getGroupExecutionContext()

Gets the execution context of the group this EBP instance can be part of. EBP instances with the same group name and execution context can be represented by the same worklist item. They can also be executed as group via an appropriate list, form or a similar UI element. This element is specified by this group execution context.
If this is null or the empty string, the group is merely for structuring purpose.

Returns:

The execution context of the group this EBP instance can be part of, null or the empty string for a group for structuring purpose. The execution context specifies the UI element to use for the combined execution of the EBP instances of the group.