de.aristaflow.adept2.model.processmodel

Interface Node

All Superinterfaces:

LocalisedString, PluginDataContainer, UserAttributeContainer

public interface Node
extends PluginDataContainer, UserAttributeContainer, LocalisedString

The Node interface is used to represent the nodes of the control flow. I.e. normal nodes, and split/join, or split/join, start/end flow, start/end loop. TODO describe node / connector / parameter / ebp, include image from twiki connector IDs are unique with respect to a node parameter names are unique with respect to an AccessType

Method Summary

Modifier and Type	Method and Description
int	getConnector(java.lang.String parameterName, ActivityConstants.AccessType accessType) Returns the connector which is mapped to the given parameter name with the given access type.
java.util.Map<java.lang.String,java.lang.Integer>	getConnectorMapping(ActivityConstants.AccessType accessType) Returns the mapping from parameter names to connectors for the given access type.
java.lang.String	getDescription() Returns the description of this node.
ExecutableBusinessProcess	getExecutableBusinessProcess() Returns the activity or the subprocess attached to the node.
java.lang.String	getGroupExecutionContext() Gets the execution context of the group this node can be part of.
java.lang.String	getGroupName() Gets the name of the group this node can be part of.
java.util.UUID	getIconID() Gets the ID of the icon to use for displaying this node in a template view.
int	getID() Returns the id of the element.
java.lang.String	getName() Returns the name of this node.
java.lang.String	getParameterName(int connectorID) Returns the name of the parameter which is connected to the given connector ID.
java.lang.String	getStaffAssignmentRule() Returns the rule the organisational model component can interpret, and offer possible staff assignments to the workflow management system.
ProcessModelParameter	getSystemParameter(java.lang.String name, ActivityConstants.AccessType accessType) Returns the system parameter object linked to the passed parameter name.
java.util.Set<ProcessModelParameter>	getSystemParameters(ActivityConstants.AccessType accessType) Returns set of system parameter objects by which this node 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 system information of this node, for instance the executing agent.
boolean	isAutoStartEnabled() Returns the auto-start status of this node.

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

Methods inherited from interface de.aristaflow.adept2.model.common.i18n.LocalisedString

toLocalisedString

Method Detail

getID

int getID()

Returns the id of the element.

Returns:

The id of the element.

getName

java.lang.String getName()

Returns the name of this node. It is used to give an additional (template specific) description for a plugged activity. Variables may be used in the string. These will become node parameters at modelling time. At runtime the variables will be replaced by the corresponding parameter values.

Returns:

The name of the node which may contain variables.

getIconID

java.util.UUID getIconID()

Gets the ID of the icon to use for displaying this node in a template view. 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 displaying this node in a template view; the corresponding icon may be retrieved in various sizes and formats. This may be null if no icon is specified.

getExecutableBusinessProcess

ExecutableBusinessProcess getExecutableBusinessProcess()

Returns the activity or the subprocess attached to the node. This method will return null, if there is no EBP attached.

Returns:

An activity, a sub-process or null.

getConnector

int getConnector(java.lang.String parameterName,
                 ActivityConstants.AccessType accessType)

Returns the connector which is mapped to the given parameter name with the given access type.

Parameters:

parameterName - The name of the Parameter the Connector is mapped to.

accessType - The access type for the connector.

Returns:

The connector connected to the parameter described by its name and its access type or CommonConstants.ID_NOT_EXISTING

getParameterName

java.lang.String getParameterName(int connectorID)

Returns the name of the parameter which is connected to the given connector ID.

Parameters:

connectorID - The ID of the connector.

Returns:

The parameter name which is connected to the given connector ID, or null if no parameter / EBP is attached.

Throws:

java.lang.IllegalArgumentException - When the connector ID does not exist.

getConnectorMapping

java.util.Map<java.lang.String,java.lang.Integer> getConnectorMapping(ActivityConstants.AccessType accessType)

Returns the mapping from parameter names to connectors for the given access type.

Parameters:

accessType - The access type of the requested connectors.

Returns:

The map from a parameter name to its connector.

getDescription

java.lang.String getDescription()

Returns the description of this node. This value is only shown to the user and has no other functionality. Variables may be used in the string. These will become node parameters at modelling time. At runtime the variables will be replaced by the corresponding parameter values.

Returns:

The description string of the node which may contain variables.

getStaffAssignmentRule

java.lang.String getStaffAssignmentRule()

Returns the rule the organisational model component can interpret, and offer possible staff assignments to the workflow management system. This rule may contain variables which will become node parameters at modelling time. At runtime the variables will be replaced by the corresponding parameter values, for instance, the agent ID of the performer of a previous node.

Returns:

A staff assignment rule which may contain variables..

getSystemParameter

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

Returns the system parameter object linked to the passed parameter name. The parameter name is the symbolic name by which the node can retrieve a data value from the data context of the process management system. This can e.g. be used for retrieving the agent ID of the executor of a previous node which allows for dependent staff assignment rules (performed by the same agent as the previous process step).

Parameters:

name - The name of the parameter of this node.

accessType - The access type of the parameter; only ActivityConstants.AccessType.SYSTEM_READ and ActivityConstants.AccessType.SYSTEM_WRITE are allowed.

Returns:

the corresponding parameter object

See Also:

ProcessModelParameter

getSystemParameters

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

Returns set of system parameter objects by which this node 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 system information of this node, for instance the executing agent. The actual content of the set depends on the parameter accessType which determines, if the parameters for SYSTEM_READ or SYSTEM_WRITE access are required.

Parameters:

accessType - the type of the parameter, i.e. SYSTEM_READ or SYSTEM_WRITE access.

Returns:

The set of the parameters of this node, either SYSTEM_READ or SYSTEM_WRITE parameters, according to the parameter accessType.

See Also:

ProcessModelParameter

isAutoStartEnabled

boolean isAutoStartEnabled()

Returns the auto-start status of this node. Such a node is automatically started without being activated for the agent that has performed the previous node. This has to be used carefully since the user may be surprised by an automatically started process step.
If something goes wrong with automatically starting (for instance, the corresponding runtime manager does not respond, automatically starting is stopped and the process step is activated normally.

Returns:

Whether the auto start of the node is enabled.

getGroupName

java.lang.String getGroupName()

Gets the name of the group this node can be part of. Nodes 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 node cannot be part of a group, this will be the empty string.

Returns:

The name of the group this node can be part of, the empty string for a node that cannot be part of a group.

getGroupExecutionContext

java.lang.String getGroupExecutionContext()

Gets the execution context of the group this node can be part of. Nodes 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 node 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 nodes of the group.