de.aristaflow.adept2.model.worklistmodel

Class ADEPT2ActivityReference

java.lang.Object

de.aristaflow.adept2.model.common.defaultimplementation.DefaultUserAttributeContainer

de.aristaflow.adept2.model.common.defaultimplementation.SerialisableUserAttributeContainer

de.aristaflow.adept2.model.worklistmodel.ADEPT2EBPReference

de.aristaflow.adept2.model.worklistmodel.ADEPT2ActivityReference

All Implemented Interfaces:

PropertyTracker, UserAttributeContainer, EBPInstanceReference, ActivityReference, Adept2EbpRefProperties, java.io.Serializable

public class ADEPT2ActivityReference
extends ADEPT2EBPReference

An activity reference to an ADEPT2 activity represented by a node of a process instance.

Author:

Kevin Goeser, Ulrich Kreher

See Also:

Serialized Form

Field Summary

Fields inherited from class de.aristaflow.adept2.model.worklistmodel.ADEPT2EBPReference

changedProperties, lock

Fields inherited from interface de.aristaflow.adept2.model.worklistmodel.Adept2EbpRefProperties

RUNTIME_MANAGER_URIS

Constructor Summary

Constructors

Constructor and Description
ADEPT2ActivityReference(EBPInstanceReference ebpInstanceReference, ActivityInstance activityInstance, java.util.Map<java.lang.String,java.lang.String> userAttributes) Creates a new activity reference object for ADEPT2-activities based on the designated EBP-Instance-Reference.
ADEPT2ActivityReference(EBPType type, java.util.UUID instanceId, java.util.UUID instanceLogId, java.util.UUID baseTemplateId, int nodeId, int iteration, java.lang.String executableComponentName, java.lang.String guiContextId, boolean supportsViewOnly, java.net.URI[] executionManagerUris, java.net.URI[] runtimeManagerUris, ExecutionControlProperties executionControlProperties, java.util.Map<java.lang.String,java.lang.String> userAttributes) Creates a new activity reference object for ADEPT2-activities.
ADEPT2ActivityReference(java.util.UUID instanceId, java.util.UUID instanceLogId, java.util.UUID baseTemplateId, int nodeId, int iteration, java.lang.String executableComponentName, java.lang.String guiContextId, java.net.URI[] executionManagerUris, ExecutionControlProperties executionControlProperties, java.util.Map<java.lang.String,java.lang.String> userAttributes, boolean supportsViewOnly) Creates a new activity reference object for ADEPT2-activities with no runtime manager set.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getExecutableComponentName() Gets the name of the executable component of the underlying activity in case this is an activity.
java.lang.String	getGUIContextID() Gets the ID of the GUIContext the referenced activity/EBP needs.
boolean	supportsViewOnly() Whether the activity supports the view-only-mode.

Methods inherited from class de.aristaflow.adept2.model.worklistmodel.ADEPT2EBPReference

equals, getActivityReferenceType, getBaseTemplateID, getChangedProperties, getExecutionControlProperties, getExecutionManagerURIs, getInstanceID, getInstanceLogId, getNodeID, getNodeIteration, getRuntimeManagerURIs, getType, hashCode, setRuntimeManagerURIs, toString

Methods inherited from class de.aristaflow.adept2.model.common.defaultimplementation.DefaultUserAttributeContainer

getUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributes, setUserAttributeValue, subEquals, subHashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValue

Constructor Detail

ADEPT2ActivityReference

public ADEPT2ActivityReference(EBPType type,
                               java.util.UUID instanceId,
                               java.util.UUID instanceLogId,
                               java.util.UUID baseTemplateId,
                               int nodeId,
                               int iteration,
                               java.lang.String executableComponentName,
                               java.lang.String guiContextId,
                               boolean supportsViewOnly,
                               java.net.URI[] executionManagerUris,
                               java.net.URI[] runtimeManagerUris,
                               ExecutionControlProperties executionControlProperties,
                               java.util.Map<java.lang.String,java.lang.String> userAttributes)

Creates a new activity reference object for ADEPT2-activities.

Parameters:

type - The EBP type of the activity reference.

instanceId - The (logical) ID of the ADEPT2 process instance.

instanceLogId - The (unchangeable) log ID of the ADEPT2 process instance.

baseTemplateId -

nodeId - The ID of the corresponding node.

iteration - The current iteration of the node.

executableComponentName -

guiContextId - The ID of the GUI context the referenced activity needs.

executionManagerUris - The URI of the execution manager responsible for the corresponding process instance.

runtimeManagerUris - The URI of the RuntimeManager used for executing the referenced EBP-Instance or null in case it is yet unknown.

executionControlProperties - The execution control properties as defined for the corresponding ExecutableBusinessProcessInstance.

userAttributes - The user attributes of this reference.

supportsViewOnly - Whether the activity supports the view-only-mode.

ADEPT2ActivityReference

public ADEPT2ActivityReference(java.util.UUID instanceId,
                               java.util.UUID instanceLogId,
                               java.util.UUID baseTemplateId,
                               int nodeId,
                               int iteration,
                               java.lang.String executableComponentName,
                               java.lang.String guiContextId,
                               java.net.URI[] executionManagerUris,
                               ExecutionControlProperties executionControlProperties,
                               java.util.Map<java.lang.String,java.lang.String> userAttributes,
                               boolean supportsViewOnly)

Creates a new activity reference object for ADEPT2-activities with no runtime manager set.

Parameters:

instanceId - The (logical) ID of the ADEPT2 process instance.

instanceLogId - The (unchangeable) log ID of the ADEPT2 process instance.

baseTemplateId -

nodeId - The ID of the corresponding node.

iteration - The current iteration of the node.

executableComponentName -

guiContextId - The ID of the GUI context the referenced activity needs.

executionManagerUris - The URI of the execution manager responsible for the corresponding process instance.

executionControlProperties - The execution control properties as defined for the corresponding ExecutableBusinessProcessInstance.

userAttributes - The user attributes of this reference.

supportsViewOnly - Whether the activity supports the view-only-mode.

ADEPT2ActivityReference

public ADEPT2ActivityReference(EBPInstanceReference ebpInstanceReference,
                               ActivityInstance activityInstance,
                               java.util.Map<java.lang.String,java.lang.String> userAttributes)

Creates a new activity reference object for ADEPT2-activities based on the designated EBP-Instance-Reference.

Parameters:

ebpInstanceReference - The reference to the corresponding EBP containing all information on identifying the EBP in the process context, for instance, instance ID, node ID and node iteration.

activityInstance - The corresponding activity-instance containing the (resolved) node and activity names, descriptions and further meta-information of the activity, for instance, ExecutionControlProperties.

userAttributes - The user attributes of this reference.

Method Detail

getExecutableComponentName

public java.lang.String getExecutableComponentName()

Description copied from class: ADEPT2EBPReference

Gets the name of the executable component of the underlying activity in case this is an activity. Otherwise null will be returned.

Specified by:

getExecutableComponentName in class ADEPT2EBPReference

Returns:

The name of the executable component of the underlying activity if this is an activity, otherwise null.

getGUIContextID

public java.lang.String getGUIContextID()

Description copied from class: ADEPT2EBPReference

Gets the ID of the GUIContext the referenced activity/EBP needs. This allows the user to differentiate whether the worklist item can be executed on the current client. In case of a lightweight process, GUIConstants.NULL_CONTEXT will be returned.

Specified by:

getGUIContextID in class ADEPT2EBPReference

Returns:

The ID of the GUIContext the referenced activity/EBP needs.

See Also:

AbstractActivity.getGUIContextID()

supportsViewOnly

public boolean supportsViewOnly()

Whether the activity supports the view-only-mode.

Returns:

true, if the activity supports the view only mode.