de.aristaflow.adept2.model.processmodel

Interface EBPInstanceReference

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ADEPT2ActivityReference, ADEPT2EBPReference, LWPActivityReference

public interface EBPInstanceReference
extends java.io.Serializable

This interface provides a reference to an instance of an executable business process (EBP) or rather to the corresponding container. The container is identified by

• the process instance
• the node ID
• the node iteration
• the URI of the corresponding execution manager.

Additionally an EBPInstanceReference contains the ID of the corresponding (base) template.
An EBPInstanceReference can therefore be used to uniquely identify an activity (-instance), a super-process instance or a top-level process instance.

Author:

Ulrich Kreher

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID Generated ID for serialisation.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object otherObject) EBPInstanceReferences are equal in case they reference the same executable business process, therefore Object.equals(Object) and Object.hashCode() have to be overridden.
java.util.UUID	getBaseTemplateID() Gets the ID of the unmodified template of the corresponding process instance.
java.net.URI[]	getExecutionManagerURIs() Returns the communication protocol depended URIs of the execution manager which executes the referenced EBP-instance.
java.util.UUID	getInstanceID() Returns the ID of the process instance the activity belongs to, the corresponding super-process instance or the instance itself in case of a reference to a top-level instance.
java.util.UUID	getInstanceLogId() Gets the stable ID of the instance referred to by getInstanceID().
int	getNodeID() Returns the ID of the node of the process graph which contains the activity or which houses the sub-process.
int	getNodeIteration() Returns the iteration count of the node this EBPInstanceReference references.
java.net.URI[]	getRuntimeManagerURIs() Returns the communication protocol depended URIs of the runtime manager instance which is used for executing the referenced EBP-instance.
EBPType	getType() Gets the type of the executable business process, for instance an activity or a subprocess.
int	hashCode() EBPInstanceReferences are equal in case they reference the same executable business process, therefore Object.equals(Object) and Object.hashCode() have to be overridden.
void	setRuntimeManagerURIs(java.net.URI[] runtimeManagerURIs) Sets the communication protocol depended URIs of the RuntimeManager which is used for executing the referenced EBP-instance.

Field Detail

serialVersionUID

static final long serialVersionUID

Generated ID for serialisation.

See Also:

Constant Field Values

Method Detail

getType

EBPType getType()

Gets the type of the executable business process, for instance an activity or a subprocess.

Returns:

The type of the executable business process, for instance an activity or a subprocess.

getInstanceID

java.util.UUID getInstanceID()

Returns the ID of the process instance the activity belongs to, the corresponding super-process instance or the instance itself in case of a reference to a top-level instance.

Returns:

The ID of the corresponding process instance.

getInstanceLogId

java.util.UUID getInstanceLogId()

Gets the stable ID of the instance referred to by getInstanceID().

Returns:

The stable ID of the corresponding process instance.

getBaseTemplateID

java.util.UUID getBaseTemplateID()

Gets the ID of the unmodified template of the corresponding process instance.

Returns:

The ID of the unmodified template of the corresponding process instance.

getNodeID

int getNodeID()

Returns the ID of the node of the process graph which contains the activity or which houses the sub-process. In case of a reference for a top-level instance, this will be Integer.MIN_VALUE.

Returns:

The ID of the process node containing the activity or sub-process.

getNodeIteration

int getNodeIteration()

Returns the iteration count of the node this EBPInstanceReference references.

Returns:

The iteration count of the node.

getExecutionManagerURIs

java.net.URI[] getExecutionManagerURIs()

Returns the communication protocol depended URIs of the execution manager which executes the referenced EBP-instance.

Returns:

The URIs of the execution manager responsible for the referenced EBP-instance.

getRuntimeManagerURIs

java.net.URI[] getRuntimeManagerURIs()

Returns the communication protocol depended URIs of the runtime manager instance which is used for executing the referenced EBP-instance. This reference is only valid after the EBP-instance has been started. Before this method will return null.
These URIs have to be set by the worklist when starting the corresponding entry.

Returns:

The communication protocol depended URIs of the runtime manager responsible for starting the referenced EBP-Instance or null if the EBP-Instance has not been started yet.

setRuntimeManagerURIs

void setRuntimeManagerURIs(java.net.URI[] runtimeManagerURIs)

Sets the communication protocol depended URIs of the RuntimeManager which is used for executing the referenced EBP-instance.

Note: This method should only be called from the worklist (e.g. on the client side).

Parameters:

runtimeManagerURIs - the URIs assigned to the appropriate RuntimeManager instance.

equals

boolean equals(java.lang.Object otherObject)

EBPInstanceReferences are equal in case they reference the same executable business process, therefore Object.equals(Object) and Object.hashCode() have to be overridden.

Overrides:

equals in class java.lang.Object

Parameters:

otherObject - An instance of another object to compare this EBPInstanceReference with.

Returns:

True, if this instance references the same instance of an executable business process as the designated object.

See Also:

Object.equals(Object), Object.hashCode()

hashCode

int hashCode()

EBPInstanceReferences are equal in case they reference the same executable business process, therefore Object.equals(Object) and Object.hashCode() have to be overridden.

Overrides:

hashCode in class java.lang.Object

See Also:

Object.equals(Object), Object.hashCode()