Package de.aristaflow.adept2.model.execution

Interface ExecutionFactory

public interface ExecutionFactory

To offer the possibility that each application can provide its own execution and termination context objects that fit the application's needs best a factory has to be provided that loads the corresponding implementations. This interface describes the methods to be implemented by the factory.

The factory is also used to create new EBPInstance objects.
Since executable business process instance objects themselves are never used the factory offers only methods to create the subclass objects ActivityInstance and LightWeightProcessInstance. The factory methods require all properties which belong directly to an EBP instance object.

Method Summary

Modifier and Type	Method	Description
ActivityConfiguration	createActivityConfiguration(Configuration configuration)	Creates a new ActivityConfiguration based on the designated configuration, that is, the returned configuration contains the very same entries and no value will be retrieved from a parameter or the process configuration.
ActivityInstance	createActivityInstance(UUID id, String processTypeName, String processTemplateVersion, String processTemplateName, String processInstanceName, String executableComponentDescriptionName, String operationName, String configurationSetName, String activityName, String name, String description, String implementationClass, Map<ActivityConstants.ActivityModelEntityType,List<String>> separatedClassPaths, ClassLoaderUsage classLoaderUsage, byte[] systemComponentSignature, String guiContextId, ExecutionControlProperties executionControlProperties, boolean supportsViewOnly, UUID iconId, Map<ActivityConstants.LocallyOverrideableActivityAttribute,ActivityConstants.ActivityModelEntityType> attributeOrigins, ActivityConfiguration configuration, Collection<ProcessModelParameter> inputParameters, Collection<ProcessModelParameter> outputParameters, ParameterDataContext attachedDataContext, String groupName, String groupExecutionContext, PluginDataContainer pluginData, Map<String,String> userAttributes)	Creates an ActivityInstance object
Configuration	createConfigurationWrapper(org.apache.commons.configuration2.Configuration configuration, String id)	Creates a new de.aristaflow.adept2.model.common.Configuration for the designated org.apache.commons.configuration2.Configuration which allows to merge process model configurations (for instance of activities) and runtime configurations (for instance from property files).
DecisionActivityInstance	createDecisionActivityInstance(ActivityInstance activityInstance, ProcessModelParameter decisionParameter, Collection<DecisionStatement> decisionStatements)	Creates a DecisionActivityInstance object.
default ParameterDataContext	createEmptyParameterDataContext()	Create an empty ParameterDataContext object.
Enquiry	createEnquiry(QualifiedAgent originator, Set<QualifiedAgent> recipients, String question)	Create an Enquiry object.
Enquiry	createEnquiry(QualifiedAgent originator, Set<QualifiedAgent> recipients, String question, String reply, QualifiedAgent replier)	Create an Enquiry object.
ExecutableInstance	createExecutableInstance(Instance instance)	Creates a new ExecutableInstance from the given instance.
ExecutableInstance	createExecutableInstance(Instance instance, ExecutableInstance executableInstance)	Creates a new ExecutableInstance from the given instance having the designated template and the additional attributes; additional with respect to the difference between a ChangeableInstance and an ExecutableInstance.
ExecutableInstance	createExecutableInstance(UUID instanceID, UUID logID, String instanceName, UUID baseTemplateID, Template template, QualifiedAgent supervisorAgent, QualifiedAgent initiatorAgent, EBPInstanceReference parentReference, long creationTime)	Creates a new executable instance without the need to specify all the details.
ExecutableInstance	createExecutableInstanceLwpIts(UUID instanceId, UUID logId, String instanceName, boolean modified, UUID baseTemplateId, Template template, QualifiedAgent supervisorAgent, QualifiedAgent initiatorAgent, EBPInstanceReference parentReference, long creationTime, Map<Integer,ProcessConstants.NodeState> nodeStates, Map<Integer,ProcessConstants.ExecutionMode> executionModes, Map<Integer,Integer> nodeIterations, Map<Integer,Map<Integer,List<UUID>>> nodeLwpInstanceIds, Map<Integer,QualifiedAgent> nodePerformingAgents, Map<Integer,List<Enquiry>> currentEnquiries, Map<Integer,Enquiry> repliedEnquiries, URI[] instanceTerminationCallbackUris, Map<Integer,URI[]> runtimeManagerUris, Map<String,Set<String>> supportedPlugins, Map<String,PluginData> pluginData, Map<String,String> userAttributes)	Creates an ExecutableInstance object.
ExecutableInstance	createExecutableInstanceLwpIts(UUID instanceId, UUID logId, String instanceName, boolean modified, UUID baseTemplateId, Template template, QualifiedAgent supervisorAgent, QualifiedAgent initiatorAgent, EBPInstanceReference parentReference, long creationTime, Map<Integer,ProcessConstants.NodeState> nodeStates, Map<Integer,ProcessConstants.ExecutionMode> executionModes, Map<Integer,Integer> nodeIterations, Map<Integer,Map<Integer,List<UUID>>> nodeLwpInstanceIds, Map<Integer,QualifiedAgent> nodePerformingAgents, Map<String,Set<String>> supportedPlugins, Map<String,PluginData> pluginData, Map<String,String> userAttributes)	Creates an ExecutableInstance object.
LightWeightProcessInstance	createLightWeightProcessInstance(UUID templateId, String processTypeName, String processTemplateVersion, String processTemplateName, String processInstanceName, String name, String description, UUID iconId, ExecutionControlProperties executionControlProperties, Configuration configuration, Set<ProcessModelParameter> inputParameters, Set<ProcessModelParameter> outputParameters, ParameterDataContext dataContext, String groupName, String groupExecutionContext, PluginDataContainer pluginData, Map<String,String> userAttributes, boolean fork, boolean isEmbedded)	Create a LightWeightProcessInstance object.
MergingConfiguration	createMergingConfiguration(Configuration initialConfiguration)	Creates a new MergingConfiguration with the designated initial configuration.
ParameterDataContext	createParameterDataContext(Map<String,ProcessConstants.AdeptDataType> types, Map<String,Serializable> parameters)	Deprecated. Use createParameterDataContext(Map, Map, Map, Map, Map) instead.
ParameterDataContext	createParameterDataContext(Map<String,ProcessConstants.AdeptDataType> types, Map<String,Serializable> parameters, Map<String,Set<String>> supportedPlugins, Map<String,PluginData> pluginData, Map<String,String> userAttributes)	Deprecated, for removal: This API element is subject to removal in a future version. Use createParameterDataContext(Map, Map, Map, Map, Map, Logger) instead.
ParameterDataContext	createParameterDataContext(Map<String,ProcessConstants.AdeptDataType> types, Map<String,Serializable> parameters, Map<String,Set<String>> supportedPlugins, Map<String,PluginData> pluginData, Map<String,String> userAttributes, Logger logger)	Create a ParameterDataContext object.
ProcessNodeContext	createProcessNodeContext(Instance inst, int nodeId, Integer nodeIteration, ParameterDataContext pdc, Map<String,Set<String>> supportedPlugins, Map<String,PluginData> pluginData, Map<String,String> userAttributes)	Creates a ProcessNodeContext for the designated node (with process instance).
ProcessNodeContext	createProcessNodeContext(UUID instId, int nodeId, Integer nodeIteration, ParameterDataContext pdc, Map<String,Set<String>> supportedPlugins, Map<String,PluginData> pluginData, Map<String,String> userAttributes)	Creates a ProcessNodeContext for the designated node (without process instance).
ExecutableBusinessProcessInstance	createTopLevelProcessInstance(UUID templateId, String processTypeName, String processTemplateVersion, String processTemplateName, String processInstanceName, String name, String description, UUID iconId, ExecutionControlProperties executionControlProperties, Configuration configuration, Set<ProcessModelParameter> inputParameters, Set<ProcessModelParameter> outputParameters, ParameterDataContext dataContext, String groupName, String groupExecutionContext, PluginDataContainer pluginData, Map<String,PluginData> addPluginData, Map<String,String> userAttributes)	Deprecated, for removal: This API element is subject to removal in a future version. Use createTopLevelProcessInstance(UUID, String, String, String, String, String, String, UUID, ExecutionControlProperties, Configuration, Set, Set, String, String, PluginDataContainer, Map, Map) instead.
ExecutableBusinessProcessInstance	createTopLevelProcessInstance(UUID templateId, String processTypeName, String processTemplateVersion, String processTemplateName, String processInstanceName, String name, String description, UUID iconId, ExecutionControlProperties executionControlProperties, Configuration configuration, Set<ProcessModelParameter> inputParameters, Set<ProcessModelParameter> outputParameters, ParameterDataContext dataContext, String groupName, String groupExecutionContext, PluginDataContainer pluginData, Map<String,String> userAttributes)	Deprecated, for removal: This API element is subject to removal in a future version. Use createTopLevelProcessInstance(UUID, String, String, String, String, String, String, UUID, ExecutionControlProperties, Configuration, Set, Set, String, String, PluginDataContainer, Map) instead.
default ExecutableBusinessProcessInstance	createTopLevelProcessInstance(UUID templateId, String processTypeName, String processTemplateVersion, String processTemplateName, String processInstanceName, String name, String description, UUID iconId, ExecutionControlProperties executionControlProperties, Configuration configuration, Set<ProcessModelParameter> inputParameters, Set<ProcessModelParameter> outputParameters, String groupName, String groupExecutionContext, PluginDataContainer pluginData, Map<String,PluginData> addPluginData, Map<String,String> userAttributes)	Create a top-level process instance object.
default ExecutableBusinessProcessInstance	createTopLevelProcessInstance(UUID templateId, String processTypeName, String processTemplateVersion, String processTemplateName, String processInstanceName, String name, String description, UUID iconId, ExecutionControlProperties executionControlProperties, Configuration configuration, Set<ProcessModelParameter> inputParameters, Set<ProcessModelParameter> outputParameters, String groupName, String groupExecutionContext, PluginDataContainer pluginData, Map<String,String> userAttributes)	Create a top-level process instance object.
ExecutionContext	getExecutionContext(QualifiedAgent agent, DataContainer dataContainer, Map<String,Set<String>> supportedPlugins, Map<String,PluginData> pluginData, Map<String,String> userAttributes)	Returns an execution context for a top-level instance its fields initialised with the provided values.
ExecutionContext	getExecutionContext(QualifiedAgent agent, ExecutableBusinessProcessInstance ebpInstance, DataContainer dataContainer, Enquiry currentEnquiry, Enquiry repliedEnquiry, Map<String,Set<String>> supportedPlugins, Map<String,PluginData> pluginData, Map<String,String> userAttributes)	Returns an application related execution context for production mode its fields initialised with the provided values.
ExecutionContext	getExecutionContext(QualifiedAgent agent, ExecutableBusinessProcessInstance ebpInstance, DataContainer dataContainer, ProcessConstants.ExecutionMode executionMode, boolean resume, Enquiry currentEnquiry, Enquiry repliedEnquiry, Map<String,Set<String>> supportedPlugins, Map<String,PluginData> pluginData, Map<String,String> userAttributes)	Returns an application related execution context its fields initialised with the provided values.

Method Detail

getExecutionContext

ExecutionContext getExecutionContext(QualifiedAgent agent,
                                     DataContainer dataContainer,
                                     Map<String,Set<String>> supportedPlugins,
                                     Map<String,PluginData> pluginData,
                                     Map<String,String> userAttributes)

Returns an execution context for a top-level instance its fields initialised with the provided values.

Parameters:

agent - The agent starting the process instance.

dataContainer - The data container providing input (and later) output parameters.

supportedPlugins - Mapping from extensionPointID to pluginIDs. This may be null.

pluginData - Mapping from pluginID to plugin data. This may be null.

userAttributes - The user attributes of the instance. This may be null.

Returns:

The execution context implementation having the designated attributes.

getExecutionContext

ExecutionContext getExecutionContext(QualifiedAgent agent,
                                     ExecutableBusinessProcessInstance ebpInstance,
                                     DataContainer dataContainer,
                                     ProcessConstants.ExecutionMode executionMode,
                                     boolean resume,
                                     Enquiry currentEnquiry,
                                     Enquiry repliedEnquiry,
                                     Map<String,Set<String>> supportedPlugins,
                                     Map<String,PluginData> pluginData,
                                     Map<String,String> userAttributes)

Returns an application related execution context its fields initialised with the provided values.

Parameters:

agent - The user agent

ebpInstance - The executable business process instance to execute

dataContainer - the related data container

executionMode - The mode of execution

resume - Whether to resume the execution of the activity.

currentEnquiry - The current enquiry

repliedEnquiry - The replied enquiry

supportedPlugins - Mapping from extensionPointID to pluginIDs. This may be null.

pluginData - Mapping from pluginID to plugin data. This may be null.

userAttributes - The user attributes of the instance. This may be null.

Returns:

The execution context implementation having the designated attributes.

getExecutionContext

ExecutionContext getExecutionContext(QualifiedAgent agent,
                                     ExecutableBusinessProcessInstance ebpInstance,
                                     DataContainer dataContainer,
                                     Enquiry currentEnquiry,
                                     Enquiry repliedEnquiry,
                                     Map<String,Set<String>> supportedPlugins,
                                     Map<String,PluginData> pluginData,
                                     Map<String,String> userAttributes)

Returns an application related execution context for production mode its fields initialised with the provided values.

Parameters:

agent - the user agent

ebpInstance - the activity to execute

dataContainer - the related dataContainer

currentEnquiry - The current enquiry

repliedEnquiry - The replied enquiry

supportedPlugins - Mapping from extensionPointID to pluginIDs. This may be null.

pluginData - Mapping from pluginID to plugin data. This may be null.

userAttributes - The user attributes of the instance. This may be null.

Returns:

The execution context implementation having the designated attributes.

createExecutableInstanceLwpIts

ExecutableInstance createExecutableInstanceLwpIts(UUID instanceId,
                                                  UUID logId,
                                                  String instanceName,
                                                  boolean modified,
                                                  UUID baseTemplateId,
                                                  Template template,
                                                  QualifiedAgent supervisorAgent,
                                                  QualifiedAgent initiatorAgent,
                                                  EBPInstanceReference parentReference,
                                                  long creationTime,
                                                  Map<Integer,ProcessConstants.NodeState> nodeStates,
                                                  Map<Integer,ProcessConstants.ExecutionMode> executionModes,
                                                  Map<Integer,Integer> nodeIterations,
                                                  Map<Integer,Map<Integer,List<UUID>>> nodeLwpInstanceIds,
                                                  Map<Integer,QualifiedAgent> nodePerformingAgents,
                                                  Map<String,Set<String>> supportedPlugins,
                                                  Map<String,PluginData> pluginData,
                                                  Map<String,String> userAttributes)

Creates an ExecutableInstance object. This method resembles ProcessModelFactory.createInstanceLwpIts(UUID, UUID, String, boolean, UUID, Template, QualifiedAgent, QualifiedAgent, EBPInstanceReference, long, Map, Map, Map, Map, Map, Map, Map, Map) .

Parameters:

instanceId - The logical ID of the instance. Instance.getID()

logId - The log ID of the instance. Instance.getLogID()

instanceName - The name of the instance. Instance.getName()

modified - Whether the instance is modified Instance.isModified()

baseTemplateId - The ID of the base template.

template - The underlying template of the instance. Instance.getTemplate()

supervisorAgent - The supervisor agent of the instance. Instance.getSupervisorAgent()

initiatorAgent - The initiator agent of the instance. Instance.getInitiatorAgent()

parentReference - The reference to the parent process (in case of a subprocess) Instance.getParentEBPReference()

creationTime - The creation time of the instance.

nodeStates - The node states of the instance nodes. Instance.getNodeState(int)

executionModes - The execution mode of the instance nodes. Instance.getExecutionMode(int)

nodeIterations - The iteration of the instance nodes. Instance.getNodeIteration(int)

nodeLwpInstanceIds - The instanceIDs of the process started by the instance nodes provided for each node and each iteration. Instance.getNodeLWPInstanceID(int, int)

nodePerformingAgents - The performing agents of the instance nodes. Instance.getPerformingAgent(int)

supportedPlugins - Mapping from extensionPointID to pluginIDs.

pluginData - Mapping from pluginID to plugin data.

userAttributes - The user attributes of the instance.

Returns:

A new ExecutableInstance object.

createExecutableInstanceLwpIts

ExecutableInstance createExecutableInstanceLwpIts(UUID instanceId,
                                                  UUID logId,
                                                  String instanceName,
                                                  boolean modified,
                                                  UUID baseTemplateId,
                                                  Template template,
                                                  QualifiedAgent supervisorAgent,
                                                  QualifiedAgent initiatorAgent,
                                                  EBPInstanceReference parentReference,
                                                  long creationTime,
                                                  Map<Integer,ProcessConstants.NodeState> nodeStates,
                                                  Map<Integer,ProcessConstants.ExecutionMode> executionModes,
                                                  Map<Integer,Integer> nodeIterations,
                                                  Map<Integer,Map<Integer,List<UUID>>> nodeLwpInstanceIds,
                                                  Map<Integer,QualifiedAgent> nodePerformingAgents,
                                                  Map<Integer,List<Enquiry>> currentEnquiries,
                                                  Map<Integer,Enquiry> repliedEnquiries,
                                                  URI[] instanceTerminationCallbackUris,
                                                  Map<Integer,URI[]> runtimeManagerUris,
                                                  Map<String,Set<String>> supportedPlugins,
                                                  Map<String,PluginData> pluginData,
                                                  Map<String,String> userAttributes)

Creates an ExecutableInstance object. This method is used for the xml import of an executable instance.

Parameters:

instanceId - The logical ID of the instance. Instance.getID()

logId - The log ID of the instance. Instance.getLogID()

instanceName - The name of the instance. Instance.getName()

modified - Whether the instance is modified Instance.isModified()

baseTemplateId - The ID of the base template.

template - The underlying template of the instance. Instance.getTemplate()

supervisorAgent - The supervisor agent of the instance. Instance.getSupervisorAgent()

initiatorAgent - The initiator agent of the instance. Instance.getInitiatorAgent()

parentReference - The reference to the parent process (in case of a subprocess) Instance.getParentEBPReference()

creationTime - The creation time of the instance.

nodeStates - The node states of the instance nodes. Instance.getNodeState(int)

executionModes - The execution mode of the instance nodes. Instance.getExecutionMode(int)

nodeIterations - The iteration of the instance nodes. Instance.getNodeIteration(int)

nodeLwpInstanceIds - The instanceIDs of the process started by the instance nodes provided for each node and each iteration. Instance.getNodeLWPInstanceID(int, int)

nodePerformingAgents - The performing agents of the instance nodes. Instance.getPerformingAgent(int)

currentEnquiries - The current enquiries of the instance nodes.

repliedEnquiries - The replied enquiries of the instance nodes.

instanceTerminationCallbackUris - The instance termination callback URIs of the instance.

runtimeManagerUris - The runtime manager URIs of the instance nodes.

supportedPlugins - Mapping from extensionPointID to pluginIDs.

pluginData - Mapping from pluginID to plugin data.

userAttributes - The user attributes of the instance.

Returns:

A new ExecutableInstance object.

createExecutableInstance

ExecutableInstance createExecutableInstance(UUID instanceID,
                                            UUID logID,
                                            String instanceName,
                                            UUID baseTemplateID,
                                            Template template,
                                            QualifiedAgent supervisorAgent,
                                            QualifiedAgent initiatorAgent,
                                            EBPInstanceReference parentReference,
                                            long creationTime)

Creates a new executable instance without the need to specify all the details.

Parameters:

instanceID - The ID of the instance to be created.

logID - The log ID of the instance to be created.

instanceName - The name of the instance to be created.

baseTemplateID - The ID of the base template.

template - The template the created instance is based on.

supervisorAgent - The supervisor of the created instance.

initiatorAgent - The agent who started/created the instance.

parentReference - If the instance to create is a subprocess instance it expects the reference to the activity the subprocess instance is assigned to, otherwise it expects NULL.

creationTime - The creation time of the instance.

Returns:

A new ExecutableInstance object.

createExecutableInstance

ExecutableInstance createExecutableInstance(Instance instance)

Creates a new ExecutableInstance from the given instance.
Note that you will loose information when calling this method for replacing an ExecutableInstance! If you have an old executable instance for the designated instance, use createExecutableInstance(Instance, ExecutableInstance).

Parameters:

instance - the instance form which the executable instance is to be created from

Returns:

A new ExecutableInstance object.

createExecutableInstance

ExecutableInstance createExecutableInstance(Instance instance,
                                            ExecutableInstance executableInstance)

Creates a new ExecutableInstance from the given instance having the designated template and the additional attributes; additional with respect to the difference between a ChangeableInstance and an ExecutableInstance.

Parameters:

instance - The instance form which the executable instance is to be created from

executableInstance - The executable instance that contains the additional attributes of an ExecutableInstance a normal instance does not provide.

Returns:

A new ExecutableInstance object.

createActivityInstance

ActivityInstance createActivityInstance(UUID id,
                                        String processTypeName,
                                        String processTemplateVersion,
                                        String processTemplateName,
                                        String processInstanceName,
                                        String executableComponentDescriptionName,
                                        String operationName,
                                        String configurationSetName,
                                        String activityName,
                                        String name,
                                        String description,
                                        String implementationClass,
                                        Map<ActivityConstants.ActivityModelEntityType,List<String>> separatedClassPaths,
                                        ClassLoaderUsage classLoaderUsage,
                                        byte[] systemComponentSignature,
                                        String guiContextId,
                                        ExecutionControlProperties executionControlProperties,
                                        boolean supportsViewOnly,
                                        UUID iconId,
                                        Map<ActivityConstants.LocallyOverrideableActivityAttribute,ActivityConstants.ActivityModelEntityType> attributeOrigins,
                                        ActivityConfiguration configuration,
                                        Collection<ProcessModelParameter> inputParameters,
                                        Collection<ProcessModelParameter> outputParameters,
                                        ParameterDataContext attachedDataContext,
                                        String groupName,
                                        String groupExecutionContext,
                                        PluginDataContainer pluginData,
                                        Map<String,String> userAttributes)

Creates an ActivityInstance object

Parameters:

id -

processTypeName - The name of the process type of the activity.

processTemplateVersion - The logical version of the process template of the activity. This may be null.

name - The name of the activity template. ExecutableBusinessProcessInstance.getName()

inputParameters - The input parameters of the activity template.

outputParameters - The output parameters of the activity template.

executionControlProperties - The execution control properties ExecutableBusinessProcessInstance.getExecutionControlProperties()

operationName - The name of the application operation the activity instance represents. AbstractActivity.getOperationName()

userAttributes - User defined Attributes for the activity instance.

description - The description of the activity instance. ExecutableBusinessProcessInstance.getDescription()

guiContextId - The GUI context for the activity instance AbstractActivity.getGUIContextID()

pluginData - Mapping from pluginID to plugin data

processInstanceName - The process instance name

processTemplateName - The process template name ExecutableBusinessProcessInstance.getProcessTemplateName()

executableComponentDescriptionName -

configurationSetName -

activityName -

implementationClass -

separatedClassPaths -

classLoaderUsage -

systemComponentSignature -

supportsViewOnly - The support view only flag

iconId -

attributeOrigins -

configuration -

attachedDataContext -

groupName - The name of the group ExecutableBusinessProcessInstance.getGroupName().

groupExecutionContext - The execution context of the group ExecutableBusinessProcessInstance.getGroupExecutionContext().

Returns:

A new ActivityInstance object.

createDecisionActivityInstance

DecisionActivityInstance createDecisionActivityInstance(ActivityInstance activityInstance,
                                                        ProcessModelParameter decisionParameter,
                                                        Collection<DecisionStatement> decisionStatements)

Creates a DecisionActivityInstance object.

Parameters:

activityInstance - The superior activity instance that contains the standard data for the decision activity instance ActivityInstance

decisionParameter - The decision parameter of the decision activity instance DecisionActivityInstance.getDecisionParameter()

decisionStatements - The decision statements of the decision activity instance DecisionActivityInstance.getDecisionStatements()

Returns:

A new DecisionActivityInstance object

createLightWeightProcessInstance

LightWeightProcessInstance createLightWeightProcessInstance(UUID templateId,
                                                            String processTypeName,
                                                            String processTemplateVersion,
                                                            String processTemplateName,
                                                            String processInstanceName,
                                                            String name,
                                                            String description,
                                                            UUID iconId,
                                                            ExecutionControlProperties executionControlProperties,
                                                            Configuration configuration,
                                                            Set<ProcessModelParameter> inputParameters,
                                                            Set<ProcessModelParameter> outputParameters,
                                                            ParameterDataContext dataContext,
                                                            String groupName,
                                                            String groupExecutionContext,
                                                            PluginDataContainer pluginData,
                                                            Map<String,String> userAttributes,
                                                            boolean fork,
                                                            boolean isEmbedded)

Create a LightWeightProcessInstance object.

Parameters:

templateId - The references template ID of the lightweight process instance. LightWeightProcessInstance.getTemplateID()

processTypeName - The name of the process type of the activity.

processTemplateVersion - The logical version of the process template of the activity. This may be null.

name - The name of the lightweight process instance. ExecutableBusinessProcessInstance.getName()

executionControlProperties - the execution control properties ExecutableBusinessProcessInstance.getExecutionControlProperties()

description - the description of the light weight process instance. ExecutableBusinessProcessInstance.getDescription()

inputParameters - The input parameters of the lightweight process instance. ExecutableBusinessProcessInstance.getParameters(de.aristaflow.adept2.model.globals.ActivityConstants.AccessType READ)

outputParameters - The output parameters of the lightweight process instance. ExecutableBusinessProcessInstance.getParameters(de.aristaflow.adept2.model.globals.ActivityConstants.AccessType WRITE)

userAttributes - User defined Attributes for the lightweight process instance.

dataContext - The input data context for the lightweight process instance. ExecutableBusinessProcessInstance.getAttachedDataContext()

processInstanceName - The process instance name ExecutableBusinessProcessInstance.getProcessInstanceName()

processTemplateName - The process template name ExecutableBusinessProcessInstance.getProcessTemplateName()

iconId -

configuration -

groupName - The name of the group ExecutableBusinessProcessInstance.getGroupName().

groupExecutionContext - The execution context of the group ExecutableBusinessProcessInstance.getGroupExecutionContext().

pluginData -

fork - Whether the process will be started as fork.

isEmbedded - Whether the process is embedded. LightWeightProcessInstance.isEmbedded()

Returns:

A new LightWeightProcessInstance object.

createTopLevelProcessInstance

@Deprecated(since="15.0.0",
            forRemoval=true)
ExecutableBusinessProcessInstance createTopLevelProcessInstance(UUID templateId,
                                                                String processTypeName,
                                                                String processTemplateVersion,
                                                                String processTemplateName,
                                                                String processInstanceName,
                                                                String name,
                                                                String description,
                                                                UUID iconId,
                                                                ExecutionControlProperties executionControlProperties,
                                                                Configuration configuration,
                                                                Set<ProcessModelParameter> inputParameters,
                                                                Set<ProcessModelParameter> outputParameters,
                                                                ParameterDataContext dataContext,
                                                                String groupName,
                                                                String groupExecutionContext,
                                                                PluginDataContainer pluginData,
                                                                Map<String,String> userAttributes)

Deprecated, for removal: This API element is subject to removal in a future version.

Use createTopLevelProcessInstance(UUID, String, String, String, String, String, String, UUID, ExecutionControlProperties, Configuration, Set, Set, String, String, PluginDataContainer, Map) instead.

Create a top-level process instance object.

Parameters:

templateId -

processTypeName -

processTemplateVersion -

processTemplateName -

processInstanceName -

name -

description -

iconId -

executionControlProperties -

configuration -

inputParameters -

outputParameters -

dataContext -

groupName - The name of the group ExecutableBusinessProcessInstance.getGroupName().

groupExecutionContext - The execution context of the group ExecutableBusinessProcessInstance.getGroupExecutionContext().

pluginData -

userAttributes -

Returns:

A new top-level process instance object.

createTopLevelProcessInstance

default ExecutableBusinessProcessInstance createTopLevelProcessInstance(UUID templateId,
                                                                        String processTypeName,
                                                                        String processTemplateVersion,
                                                                        String processTemplateName,
                                                                        String processInstanceName,
                                                                        String name,
                                                                        String description,
                                                                        UUID iconId,
                                                                        ExecutionControlProperties executionControlProperties,
                                                                        Configuration configuration,
                                                                        Set<ProcessModelParameter> inputParameters,
                                                                        Set<ProcessModelParameter> outputParameters,
                                                                        String groupName,
                                                                        String groupExecutionContext,
                                                                        PluginDataContainer pluginData,
                                                                        Map<String,String> userAttributes)

Create a top-level process instance object.

Parameters:

templateId -

processTypeName -

processTemplateVersion -

processTemplateName -

processInstanceName -

name -

description -

iconId -

executionControlProperties -

configuration -

inputParameters -

outputParameters -

groupName - The name of the group ExecutableBusinessProcessInstance.getGroupName().

groupExecutionContext - The execution context of the group ExecutableBusinessProcessInstance.getGroupExecutionContext().

pluginData -

userAttributes -

Returns:

A new top-level process instance object.

createTopLevelProcessInstance

@Deprecated(since="15.0.0",
            forRemoval=true)
ExecutableBusinessProcessInstance createTopLevelProcessInstance(UUID templateId,
                                                                String processTypeName,
                                                                String processTemplateVersion,
                                                                String processTemplateName,
                                                                String processInstanceName,
                                                                String name,
                                                                String description,
                                                                UUID iconId,
                                                                ExecutionControlProperties executionControlProperties,
                                                                Configuration configuration,
                                                                Set<ProcessModelParameter> inputParameters,
                                                                Set<ProcessModelParameter> outputParameters,
                                                                ParameterDataContext dataContext,
                                                                String groupName,
                                                                String groupExecutionContext,
                                                                PluginDataContainer pluginData,
                                                                Map<String,PluginData> addPluginData,
                                                                Map<String,String> userAttributes)

Deprecated, for removal: This API element is subject to removal in a future version.

Use createTopLevelProcessInstance(UUID, String, String, String, String, String, String, UUID, ExecutionControlProperties, Configuration, Set, Set, String, String, PluginDataContainer, Map, Map) instead.

Create a top-level process instance object.

Parameters:

templateId -

processTypeName -

processTemplateVersion -

processTemplateName -

processInstanceName -

name -

description -

iconId -

executionControlProperties -

configuration -

inputParameters -

outputParameters -

dataContext -

groupName - The name of the group ExecutableBusinessProcessInstance.getGroupName().

groupExecutionContext - The execution context of the group ExecutableBusinessProcessInstance.getGroupExecutionContext().

pluginData -

addPluginData -

userAttributes -

Returns:

A new top-level process instance object.

createTopLevelProcessInstance

default ExecutableBusinessProcessInstance createTopLevelProcessInstance(UUID templateId,
                                                                        String processTypeName,
                                                                        String processTemplateVersion,
                                                                        String processTemplateName,
                                                                        String processInstanceName,
                                                                        String name,
                                                                        String description,
                                                                        UUID iconId,
                                                                        ExecutionControlProperties executionControlProperties,
                                                                        Configuration configuration,
                                                                        Set<ProcessModelParameter> inputParameters,
                                                                        Set<ProcessModelParameter> outputParameters,
                                                                        String groupName,
                                                                        String groupExecutionContext,
                                                                        PluginDataContainer pluginData,
                                                                        Map<String,PluginData> addPluginData,
                                                                        Map<String,String> userAttributes)

Create a top-level process instance object.

Parameters:

templateId -

processTypeName -

processTemplateVersion -

processTemplateName -

processInstanceName -

name -

description -

iconId -

executionControlProperties -

configuration -

inputParameters -

outputParameters -

groupName - The name of the group ExecutableBusinessProcessInstance.getGroupName().

groupExecutionContext - The execution context of the group ExecutableBusinessProcessInstance.getGroupExecutionContext().

pluginData -

addPluginData -

userAttributes -

Returns:

A new top-level process instance object.

createEmptyParameterDataContext

default ParameterDataContext createEmptyParameterDataContext()

Create an empty ParameterDataContext object.

Returns:

A new empty ParameterDataContext object.

createParameterDataContext

@Deprecated
ParameterDataContext createParameterDataContext(Map<String,ProcessConstants.AdeptDataType> types,
                                                Map<String,Serializable> parameters)

Deprecated.

Use createParameterDataContext(Map, Map, Map, Map, Map) instead.

Create a ParameterDataContext object.

Parameters:

types - A mapping from a parameter name to a data type.

parameters - A mapping from a parameter name to a parameter value.

Returns:

A new ParameterDataContext object.

createParameterDataContext

@Deprecated(since="15.0.0",
            forRemoval=true)
ParameterDataContext createParameterDataContext(Map<String,ProcessConstants.AdeptDataType> types,
                                                Map<String,Serializable> parameters,
                                                Map<String,Set<String>> supportedPlugins,
                                                Map<String,PluginData> pluginData,
                                                Map<String,String> userAttributes)

Deprecated, for removal: This API element is subject to removal in a future version.

Use createParameterDataContext(Map, Map, Map, Map, Map, Logger) instead.

Create a ParameterDataContext object.

Parameters:

types - A mapping from a parameter name to a data type.

parameters - A mapping from a parameter name to a parameter value. The caller is responsible for closing the values if appropriate.

supportedPlugins - Mapping from extensionPointID to pluginIDs. This may be null.

pluginData - Mapping from pluginID to plugin data. This may be null.

userAttributes - The user attributes of the parameter data context. This may be null.

Returns:

A new ParameterDataContext object.

createParameterDataContext

ParameterDataContext createParameterDataContext(Map<String,ProcessConstants.AdeptDataType> types,
                                                Map<String,Serializable> parameters,
                                                Map<String,Set<String>> supportedPlugins,
                                                Map<String,PluginData> pluginData,
                                                Map<String,String> userAttributes,
                                                Logger logger)

Create a ParameterDataContext object.

Parameters:

types - A mapping from a parameter name to a data type.

parameters - A mapping from a parameter name to a parameter value. The caller is responsible for closing the values if appropriate.

supportedPlugins - Mapping from extensionPointID to pluginIDs. This may be null.

pluginData - Mapping from pluginID to plugin data. This may be null.

userAttributes - The user attributes of the parameter data context. This may be null.

logger - The logger of the using service-instance specific for data context.

Returns:

A new ParameterDataContext object.

createProcessNodeContext

ProcessNodeContext createProcessNodeContext(UUID instId,
                                            int nodeId,
                                            Integer nodeIteration,
                                            ParameterDataContext pdc,
                                            Map<String,Set<String>> supportedPlugins,
                                            Map<String,PluginData> pluginData,
                                            Map<String,String> userAttributes)

Creates a ProcessNodeContext for the designated node (without process instance).

Parameters:

instId - The ID of the instance this context refers to.

nodeId - The ID of the node this context refers to.

nodeIteration - The optional iteration of the node this context refers to or null.

pdc - The optional parameter data context of the node this context refers to or null.

supportedPlugins - Mapping from extensionPointID to pluginIDs. This may be null.

pluginData - Mapping from pluginID to plugin data. This may be null.

userAttributes - The user attributes of the parameter data context. This may be null.

Returns:

A new ProcessNodeContext for the designated node (without process instance).

createProcessNodeContext

ProcessNodeContext createProcessNodeContext(Instance inst,
                                            int nodeId,
                                            Integer nodeIteration,
                                            ParameterDataContext pdc,
                                            Map<String,Set<String>> supportedPlugins,
                                            Map<String,PluginData> pluginData,
                                            Map<String,String> userAttributes)

Creates a ProcessNodeContext for the designated node (with process instance).

Parameters:

inst - The instance this context refers to if it can be provided by the using service or client or null.

nodeId - The ID of the node this context refers to.

nodeIteration - The optional iteration of the node this context refers to or null.

pdc - The optional parameter data context of the node this context refers to or null.

supportedPlugins - Mapping from extensionPointID to pluginIDs. This may be null.

pluginData - Mapping from pluginID to plugin data. This may be null.

userAttributes - The user attributes of the parameter data context. This may be null.

Returns:

A new ProcessNodeContext for the designated node (with process instance).

createEnquiry

Enquiry createEnquiry(QualifiedAgent originator,
                      Set<QualifiedAgent> recipients,
                      String question)

Create an Enquiry object.

Parameters:

originator - The initiator of the enquiry.

recipients - The recipients of the enquiry.

question - The reason for the enquiry.

Returns:

An enquiry object that is initialised with the given parameters.

createEnquiry

Enquiry createEnquiry(QualifiedAgent originator,
                      Set<QualifiedAgent> recipients,
                      String question,
                      String reply,
                      QualifiedAgent replier)

Create an Enquiry object.

Parameters:

originator - The initiator of the enquiry.

recipients - The recipients of the enquiry.

question - The reason for the enquiry.

reply - The reply for the enquiry.

replier - The agent that replied the enquiry.

Returns:

An enquiry object that is initialised with the given parameters.

createConfigurationWrapper

Configuration createConfigurationWrapper(org.apache.commons.configuration2.Configuration configuration,
                                         String id)

Creates a new de.aristaflow.adept2.model.common.Configuration for the designated org.apache.commons.configuration2.Configuration which allows to merge process model configurations (for instance of activities) and runtime configurations (for instance from property files).

Parameters:

configuration - The org.apache.commons.configuration2.Configuration to be wrapped by a de.aristaflow.adept2.model.common.Configuration.

id - The ID of this configuration for usage in check reports.

Returns:

A new de.aristaflow.adept2.model.common.Configuration wrapping the designated org.apache.commons.configuration2.Configuration.

createMergingConfiguration

MergingConfiguration createMergingConfiguration(Configuration initialConfiguration)

Creates a new MergingConfiguration with the designated initial configuration.

Parameters:

initialConfiguration - The initial configuration for the created MergingConfiguration. This must not be null.

Returns:

A new MergingConfiguration with the designated initial configuration

createActivityConfiguration

ActivityConfiguration createActivityConfiguration(Configuration configuration)

Creates a new ActivityConfiguration based on the designated configuration, that is, the returned configuration contains the very same entries and no value will be retrieved from a parameter or the process configuration.

Parameters:

configuration - The configuration to convert to an activity configuration. This must not be null.

Returns:

A new ActivityConfiguration based on the designated configuration.