de.hybris.platform.processengine.definition

Class ProcessDefinition

java.lang.Object

de.hybris.platform.processengine.definition.ProcessDefinition

public class ProcessDefinition
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProcessDefinition(ProcessDefinitionId id, Node startNode, Node onError, Map<String,Node> nodesById, Map<String,ContextParameterDeclaration> contextParameterDecl, String processClass, String defaultClusterGroup)
protected	ProcessDefinition(String name, Node startNode, Node onError, Map<String,Node> nodesById, Map<String,ContextParameterDeclaration> contextParameterDecl, String processClass, String defaultClusterGroup)

Method Summary

Modifier and Type	Method and Description
Set<String>	allContextParameterNames()
ContextParameterDeclaration	getContextParameterDeclaration(String name) Access to the context parameter declarations of this ProcessDefinition
String	getDefaultNodeGroup() Optional: the default cluster node group which all actions of this task shall be executed within.
ProcessDefinitionId	getId()
String	getName()
Collection<String>	getNodeIds()
Node	getOnErrorNode()
String	getProcessClass()
Node	getStartNode()
String	getVersion()
Node	retrieve(String id)
void	start(BusinessProcessModel process)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProcessDefinition

protected ProcessDefinition(String name,
                            Node startNode,
                            Node onError,
                            Map<String,Node> nodesById,
                            Map<String,ContextParameterDeclaration> contextParameterDecl,
                            String processClass,
                            String defaultClusterGroup)

ProcessDefinition

protected ProcessDefinition(ProcessDefinitionId id,
                            Node startNode,
                            Node onError,
                            Map<String,Node> nodesById,
                            Map<String,ContextParameterDeclaration> contextParameterDecl,
                            String processClass,
                            String defaultClusterGroup)

Method Detail

getId

public ProcessDefinitionId getId()

getName

public String getName()

getVersion

public String getVersion()

getNodeIds

public Collection<String> getNodeIds()

retrieve

public Node retrieve(String id)

start

public void start(BusinessProcessModel process)

getStartNode

public Node getStartNode()

Returns:

the start node of this ProcessDefinition

getOnErrorNode

public Node getOnErrorNode()

allContextParameterNames

public Set<String> allContextParameterNames()

getContextParameterDeclaration

public ContextParameterDeclaration getContextParameterDeclaration(String name)

Access to the context parameter declarations of this ProcessDefinition

Parameters:

name - name of the parameter

Returns:

the ContextParameterDeclaration for the given name or null if no such parameter was declared

getProcessClass

public String getProcessClass()

Returns:

the processClass

getDefaultNodeGroup

public String getDefaultNodeGroup()

Optional: the default cluster node group which all actions of this task shall be executed within. If empty all cluster nodes may execute actions. This setting can be overridden for each action node using its xml attributes 'nodeGroup' or 'node'!