org.cristalise.kernel.lifecycle.instance

Class WfVertex

java.lang.Object

org.cristalise.kernel.graph.model.Vertex

org.cristalise.kernel.graph.model.GraphableVertex

org.cristalise.kernel.lifecycle.instance.WfVertex

Direct Known Subclasses:

Activity, Join, Split

public abstract class WfVertex
extends GraphableVertex

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WfVertex.Types

Field Summary

Fields inherited from class org.cristalise.kernel.graph.model.GraphableVertex

mIsComposite

Constructor Summary

Constructors

Constructor and Description
WfVertex()

Method Summary

Modifier and Type	Method and Description
void	abort()
abstract Next	addNext(WfVertex vertex)
Object	evaluateProperty(ItemPath itemPath, String propName, Object locker)
Object	evaluatePropertyValue(ItemPath itemPath, Object propValue, Object locker)
protected Object	evaluateScript(String scriptName, Integer scriptVersion, ItemPath itemPath, Object locker)
protected GraphableVertex	findPair(String pairingID) Find the vertex with the same PairingID property
String	getActContext() Derive the path of the parent CompositeAct in which the script is running
abstract String	getErrors() Method getErrors.
protected String	getOtherPairingID(WfVertex otherVertex) Retrieve the PairingID of the other vertex
Workflow	getWf()
protected Boolean	isMyPair(WfVertex otherVertex) Checks if the vertex has a pairing id or not and if it has one compares it with the other vertex pairing id
abstract boolean	loop()
abstract void	reinit(int idLoop)
abstract void	run(AgentPath agent, ItemPath itemPath, Object locker)
abstract void	runFirst(AgentPath agent, ItemPath itemPath, Object locker) Sets the activity available to be executed on start of Workflow or composite activity (when it is the first one of the (sub)process)
abstract void	runNext(AgentPath agent, ItemPath itemPath, Object locker)
abstract boolean	verify() Method verify.

Methods inherited from class org.cristalise.kernel.graph.model.GraphableVertex

addChild, deriveVersionNumber, getBuiltInProperty, getBuiltInProperty, getCentrePoint, getChildren, getChildrenEdges, getChildrenGraphModel, getCreationContext, getInEdgeIds, getInEdges, getIsComposite, getIsLayoutable, getKeyValuePairs, getLayoutableChildren, getOutEdgeIds, getOutEdges, getOutGraphables, getOutlinePoints, getParent, getPath, getProperties, search, setBuiltInProperty, setChildrenGraphModel, setIsComposite, setIsLayoutable, setKeyValuePairs, setParent, setProperties, updatePropertiesFromCollection, updatePropertiesFromCollection

Methods inherited from class org.cristalise.kernel.graph.model.Vertex

addInEdgeId, addOutEdgeId, clearTag, containsPoint, hasTag, isJoin, isLoop, moveAbsolute, removeInEdgeId, removeOutEdgeId, setInEdgeIds, setOutEdgeIds, setOutlinePoints, setTag

Methods inherited from class java.lang.Object

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

Constructor Detail

WfVertex

public WfVertex()

Method Detail

runFirst

public abstract void runFirst(AgentPath agent,
                              ItemPath itemPath,
                              Object locker)
                       throws InvalidDataException

Sets the activity available to be executed on start of Workflow or composite activity (when it is the first one of the (sub)process)

Throws:

InvalidDataException

runNext

public abstract void runNext(AgentPath agent,
                             ItemPath itemPath,
                             Object locker)
                      throws InvalidDataException

Throws:

InvalidDataException

reinit

public abstract void reinit(int idLoop)
                     throws InvalidDataException

Throws:

InvalidDataException

abort

public void abort()

verify

public abstract boolean verify()

Method verify.

Returns:

boolean

getErrors

public abstract String getErrors()

Method getErrors.

Returns:

String

run

public abstract void run(AgentPath agent,
                         ItemPath itemPath,
                         Object locker)
                  throws InvalidDataException

Throws:

InvalidDataException

loop

public abstract boolean loop()

Returns:

boolean

getActContext

public String getActContext()

Derive the path of the parent CompositeAct in which the script is running

Returns:

the path of the parent CompositeAct

addNext

public abstract Next addNext(WfVertex vertex)

evaluateProperty

public Object evaluateProperty(ItemPath itemPath,
                               String propName,
                               Object locker)
                        throws InvalidDataException,
                               PersistencyException,
                               ObjectNotFoundException

Throws:

InvalidDataException

PersistencyException

ObjectNotFoundException

evaluatePropertyValue

public Object evaluatePropertyValue(ItemPath itemPath,
                                    Object propValue,
                                    Object locker)
                             throws InvalidDataException,
                                    PersistencyException,
                                    ObjectNotFoundException

Throws:

InvalidDataException

PersistencyException

ObjectNotFoundException

evaluateScript

protected Object evaluateScript(String scriptName,
                                Integer scriptVersion,
                                ItemPath itemPath,
                                Object locker)
                         throws ScriptingEngineException

Parameters:

scriptName -

scriptVersion -

itemPath -

locker -

Returns:

the value returned by the Script

Throws:

ScriptingEngineException

getWf

public Workflow getWf()

Returns:

the top level CompositeActivity, aka Workflow

findPair

protected GraphableVertex findPair(String pairingID)

Find the vertex with the same PairingID property

Parameters:

pairingID - the value of the PairingID property

Returns:

the vertex or null if nothing was found

isMyPair

protected Boolean isMyPair(WfVertex otherVertex)

Checks if the vertex has a pairing id or not and if it has one compares it with the other vertex pairing id

Parameters:

otherVertex - the other vertex to check for pairing

Returns:

null if vertex has no PAIRING_ID otherwise compare the pairing ids

getOtherPairingID

protected String getOtherPairingID(WfVertex otherVertex)

Retrieve the PairingID of the other vertex

Parameters:

otherVertex - the other vertex

Returns:

empty string or the value of the PairingID property