ProcessDefinition (jBPM3 - Core 3.2.13 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jbpm.graph.def
Class ProcessDefinition

java.lang.Object
  org.jbpm.graph.def.GraphElement
      org.jbpm.graph.def.ProcessDefinition

All Implemented Interfaces:: Serializable, Identifiable, NodeCollection

public class ProcessDefinition
extends GraphElement
implements NodeCollection
extends GraphElement
implements NodeCollection

See Also:: Serialized Form

Field Summary
`protected Map`	`actions`
`protected Map`	`definitions`
`protected boolean`	`isTerminationImplicit`
`protected List`	`nodes`
`protected Node`	`startState`
`static String[]`	`supportedEventTypes` Deprecated. arrays are mutable and thus vulnerable to external manipulation. use `getSupportedEventTypes()` instead
`protected int`	`version`

Fields inherited from class org.jbpm.graph.def.GraphElement
`description, events, exceptionHandlers, name, processDefinition`

Constructor Summary
`ProcessDefinition()`
`ProcessDefinition(String name)`
`ProcessDefinition(String[] nodes, String[] transitions)`

Method Summary
`Action`	`addAction(Action action)` creates a bidirectional relation between this process definition and the given action.
`ModuleDefinition`	`addDefinition(ModuleDefinition moduleDefinition)`
`Node`	`addNode(Node node)` adds the given node to this node-collection.
`Object`	`createInstance()`
`static ProcessDefinition`	`createNewProcessDefinition()`
`ProcessInstance`	`createProcessInstance()`
`ProcessInstance`	`createProcessInstance(Map variables)`
`ProcessInstance`	`createProcessInstance(Map variables, String businessKey)`
`boolean`	`equals(Object o)` Tells whether this process definition is equal to the given object.
`static Node`	`findNode(NodeCollection nodeCollection, String hierarchicalName)`
`Node`	`findNode(String hierarchicalName)` finds the node by the given hierarchical name.
`String`	`generateNodeName()` generates a new name for a node to be added to this collection.
`static String`	`generateNodeName(List nodes)`
`Action`	`getAction(String name)`
`Map`	`getActions()`
`ContextDefinition`	`getContextDefinition()`
`ModuleDefinition`	`getDefinition(Class clazz)`
`Map`	`getDefinitions()`
`FileDefinition`	`getFileDefinition()`
`Node`	`getNode(String name)` retrieves a node by name.
`List`	`getNodes()` is the ordered list of nodes.
`Map`	`getNodesMap()` maps node-names to nodes.
`GraphElement`	`getParent()`
`Node`	`getStartState()`
`String[]`	`getSupportedEventTypes()` indicative set of event types supported by this graph element.
`TaskMgmtDefinition`	`getTaskMgmtDefinition()`
`int`	`getVersion()`
`boolean`	`hasActions()`
`int`	`hashCode()` Computes the hash code for this process definition.
`boolean`	`hasNode(String name)` is true if this node-collection contains a node with the given name, false otherwise.
`boolean`	`isTerminationImplicit()`
`static ProcessDefinition`	`parseParResource(String parResource)` parse a process definition from a process archive resource.
`static ProcessDefinition`	`parseParZipInputStream(ZipInputStream zipInputStream)` parse a process definition from a process archive zip-stream.
`static ProcessDefinition`	`parseXmlInputStream(InputStream inputStream)` parse a process definition from an xml input stream.
`static ProcessDefinition`	`parseXmlReader(Reader reader)` parse a process definition from an xml reader.
`static ProcessDefinition`	`parseXmlResource(String xmlResource)` parse a process definition from an xml resource file.
`static ProcessDefinition`	`parseXmlString(String xml)` parse a process definition from an xml string.
`void`	`removeAction(Action action)` removes the bidirectional relation between this process definition and the given action.
`ModuleDefinition`	`removeDefinition(ModuleDefinition moduleDefinition)`
`Node`	`removeNode(Node node)` removes the given node from this node-collection.
`void`	`reorderNode(int oldIndex, int newIndex)` changes the order of the nodes : the node on oldIndex is removed and inserted in the newIndex.
`void`	`setDefinitions(Map definitions)`
`void`	`setProcessDefinition(ProcessDefinition processDefinition)`
`void`	`setStartState(Node startState)`
`void`	`setStartState(StartState startState)`
`void`	`setTerminationImplicit(boolean isTerminationImplicit)`
`void`	`setVersion(int version)` Sets the version of this process.

Methods inherited from class org.jbpm.graph.def.GraphElement
`addEvent, addExceptionHandler, createAsyncActionExecutionJob, executeAction, findExceptionHandler, fireAndPropagateEvent, fireEvent, getDescription, getEvent, getEvents, getExceptionHandlers, getId, getName, getParentChain, getParents, getProcessDefinition, hasEvent, hasEvents, raiseException, removeEvent, removeExceptionHandler, reorderExceptionHandler, setDescription, setName, toString`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Field Detail

version

protected int version

isTerminationImplicit

protected boolean isTerminationImplicit

startState

protected Node startState

nodes

protected List nodes

actions

protected Map actions

definitions

protected Map definitions

supportedEventTypes

public static final String[] supportedEventTypes

Deprecated. arrays are mutable and thus vulnerable to external manipulation. use getSupportedEventTypes() instead

Constructor Detail

ProcessDefinition

public ProcessDefinition()

ProcessDefinition

public ProcessDefinition(String name)

ProcessDefinition

public ProcessDefinition(String[] nodes,
                         String[] transitions)

Method Detail

getSupportedEventTypes

public String[] getSupportedEventTypes()

Description copied from class: GraphElement

indicative set of event types supported by this graph element. this is currently only used by the process designer to know which event types to show on a given graph element. in process definitions and at runtime, there are no constraints on the event-types.

Specified by:: getSupportedEventTypes in class GraphElement

createNewProcessDefinition

public static ProcessDefinition createNewProcessDefinition()

createProcessInstance

public ProcessInstance createProcessInstance()

createProcessInstance

public ProcessInstance createProcessInstance(Map variables)

createProcessInstance

public ProcessInstance createProcessInstance(Map variables,
                                             String businessKey)

setProcessDefinition

public void setProcessDefinition(ProcessDefinition processDefinition)

Overrides:: setProcessDefinition in class GraphElement

equals

public boolean equals(Object o)

Tells whether this process definition is equal to the given object. This method considers two process definitions equal if they are equal in name and version, the name is not null and the version is not negative.

Overrides:: equals in class GraphElement

hashCode

public int hashCode()

Computes the hash code for this process definition. Process definitions with a null name or a negative version will return their identity hash code.

Overrides:: hashCode in class GraphElement

parseXmlString

public static ProcessDefinition parseXmlString(String xml)

parse a process definition from an xml string.

Throws:: JpdlException - if parsing reported an error.

parseXmlResource

public static ProcessDefinition parseXmlResource(String xmlResource)

parse a process definition from an xml resource file.

Throws:: JpdlException - if parsing reported an error.

parseXmlInputStream

public static ProcessDefinition parseXmlInputStream(InputStream inputStream)

parse a process definition from an xml input stream.

Throws:: JpdlException - if parsing reported an error.

parseXmlReader

public static ProcessDefinition parseXmlReader(Reader reader)

parse a process definition from an xml reader.

Throws:: JpdlException - if parsing reported an error.

parseParZipInputStream

public static ProcessDefinition parseParZipInputStream(ZipInputStream zipInputStream)
                                                throws IOException

parse a process definition from a process archive zip-stream.

Throws:: JpdlException - if parsing reported an error.; IOException

parseParResource

public static ProcessDefinition parseParResource(String parResource)
                                          throws IOException

parse a process definition from a process archive resource.

Throws:: JpdlException - if parsing reported an error.; IOException