Flow

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> jbpm >> workflow >> [ execution overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.jbpm.workflow.execution.Flow

SOURCE |

Download org.jbpm.workflow.execution.Flow

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jbpm.workflow.execution
Interface Flow

All Superinterfaces:: java.io.Serializable

public interface Flow
extends java.io.Serializable

represents one 'thread-of-execution' for a sequence of Activitys.

Flows hierarchically ordered. When starting a process instance, a root-flow will be created. At a fork, the parent-flow will spawn a set of child-flows and then wait until they join again.

The 3 methods getActivity(), getFork() and getJoin() combined represent the state of a flow. A flow is always in one of 4 states :

activity : the flow is waiting until an actor performs the activity. All state-getters will return null except getActivity()
fork : a flow is assigned to a fork when it is waiting on its subflows to join again. All state-getters will return null except getFork()
join : a flow is assigned to a join when it is waiting on its brothers- and sister-flows to join before the parent-flow is reactivated All state-getters will return null except getJoin()
ended : meaning is obvious. All state-getters will return null.

Method Summary

org.jbpm.workflow.organisation.Actor getActor()
          specifies which User or Group is supposed to act upon the Flow.

java.util.Collection getAttributeInstances()
          are the flow-local attributes.

java.util.Collection getChildren()
          is the collection of child-Flows for this Flow.

java.util.Date getEnd()
          is the time at which this flow ended, null if it didn't end yet.

java.lang.Long getId()
          the meaningless primary-key for this object.

java.util.Collection getLogs()
          are the logged events related to this flow.

java.lang.String getName()
          is the name of the flow.

org.jbpm.workflow.definition.Node getNode()
          is a pointer to the org.jbpm.workflow.definition.Node in the activity diagram that represents the state of this flow.

Flow getParent()
          is the parent-Flow of this flow.

ProcessInstance getProcessInstance()
          is the ProcessInstance of this flow.

java.util.Date getStart()
          is the time at which this flow started.

ProcessInstance getSubProcessInstance()
          is the sub-process-instance on which this flow is waiting in a sub-process-activity.

boolean isRootFlow()
          tells if this flow is the root-flow of a processInstance.

Method Detail

getId

public java.lang.Long getId()

the meaningless primary-key for this object.

getName

public java.lang.String getName()

is the name of the flow.

getNode

public org.jbpm.workflow.definition.Node getNode()

is a pointer to the org.jbpm.workflow.definition.Node in the activity diagram that represents the state of this flow.

getActor

public org.jbpm.workflow.organisation.Actor getActor()

specifies which User or Group is supposed to act upon the Flow.

getLogs

public java.util.Collection getLogs()

are the logged events related to this flow.

getStart

public java.util.Date getStart()

is the time at which this flow started.

getEnd

public java.util.Date getEnd()

is the time at which this flow ended, null if it didn't end yet.

isRootFlow

public boolean isRootFlow()

tells if this flow is the root-flow of a processInstance.

getAttributeInstances

public java.util.Collection getAttributeInstances()

are the flow-local attributes.

getParent

public Flow getParent()

is the parent-Flow of this flow. Flows are hierarchically ordered as described in the general-class-description part above.

getProcessInstance

public ProcessInstance getProcessInstance()

is the ProcessInstance of this flow. The ProcessInstance is associated with the upper-most parent of this flow. Flows are hierarchically ordered as described in the general-class-description part above.

getChildren

public java.util.Collection getChildren()

is the collection of child-Flows for this Flow. Flows are hierarchically ordered as described in the general-class-description part above. * @return a Collection of Flow's

getSubProcessInstance

public ProcessInstance getSubProcessInstance()

is the sub-process-instance on which this flow is waiting in a sub-process-activity.