org.cristalise.kernel.lifecycle.instance

Class Workflow

java.lang.Object

org.cristalise.kernel.graph.model.Vertex

org.cristalise.kernel.graph.model.GraphableVertex

org.cristalise.kernel.lifecycle.instance.WfVertex

org.cristalise.kernel.lifecycle.instance.Activity

org.cristalise.kernel.lifecycle.instance.CompositeActivity

org.cristalise.kernel.lifecycle.instance.Workflow

All Implemented Interfaces:

C2KLocalObject

public class Workflow
extends CompositeActivity
implements C2KLocalObject

Nested Class Summary

Nested classes/interfaces inherited from class org.cristalise.kernel.lifecycle.instance.WfVertex

WfVertex.Types

Field Summary

Fields inherited from class org.cristalise.kernel.lifecycle.instance.Activity

active, mErrors, state, XPATH_TOKEN

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

mIsComposite

Constructor Summary

Constructors

Constructor and Description
Workflow()
Workflow(CompositeActivity domain, PredefinedStepContainer predef)

Method Summary

Modifier and Type	Method and Description
ArrayList<Job>	calculateJobs(AgentPath agent, ItemPath itemPath, int type) if type = 0 only domain steps will be queried if type = 1 only predefined steps will be queried else both will be queried
String	getClusterPath() Each C2KLocalObject is stored with a path identifier starting with the ClusterType: Properties: /Property/Name Workflow: /LifeCycle/workflow Collections: /Collection/Name/Version (default Name='last') Outcomes: /Outcome/SchemaName/SchemaVersion/EventID Viewpoints: /ViewPoint/SchemaName/Name (default Name='last') Events: /AuditTrail/EventID Jobs: /Job/JobID
ClusterType	getClusterType() Each object belongs to a specific type defined in ClusterType
TypeNameAndConstructionInfo[]	getEdgeTypeNameAndConstructionInfo() getVertexTypeNameAndConstructionInfo() added by Steve
History	getHistory()
History	getHistory(TransactionKey transactionKey) Caches a History object for this Item, using the workflow as a transactionKey.
ItemPath	getItemPath()
String	getItemUUID()
String	getName() Gets the name of the C2KLocalObject
String	getPath()
String	getType() Returns the type.
TypeNameAndConstructionInfo[]	getVertexTypeNameAndConstructionInfo() getVertexTypeNameAndConstructionInfo() added by Steve
Workflow	getWf()
boolean	hasGoodNumberOfActivity()
void	initialise(ItemPath itemPath, AgentPath agent, TransactionKey transactionKey)
String	requestAction(AgentPath agent, AgentPath delegator, String stepPath, ItemPath itemPath, int transitionID, String requestData, String attachmentType, byte[] attachment, TransactionKey transactionKey)
void	setItemPath(ItemPath itemPath)
void	setItemUUID(String uuid)
void	setName(String name) Sets the name of the C2KLocalObject
boolean	verify() launch the verification of the subprocess()

Methods inherited from class org.cristalise.kernel.lifecycle.instance.CompositeActivity

abort, addNext, addNext, calculateAllJobs, calculateJobs, getPossibleActs, hasActive, initChild, newAtomChild, newChild, newChild, newChild, newCompChild, newExistingChild, newJoinChild, newSplitChild, refreshJobs, reinit, request, run, runNext, setChildrenGraphModel, setFirstVertex

Methods inherited from class org.cristalise.kernel.lifecycle.instance.Activity

addNext, getActive, getCurrentAgentName, getCurrentAgentRole, getDescription, getErrors, getErrorTransitionId, getNext, getState, getStateDate, getStateMachine, getStateMachine, getStateName, getTypeName, isFinished, loop, pushJobsToAgents, pushJobsToAgents, request, runActivityLogic, runFirst, setActive, setActiveDate, setStartDate, setState, setStateDate, setType

Methods inherited from class org.cristalise.kernel.lifecycle.instance.WfVertex

evaluateProperty, evaluatePropertyValue, evaluateScript, findPair, getActContext, getOtherPairingID, isMyPair

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, getProperties, search, setBuiltInProperty, 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

Methods inherited from interface org.cristalise.kernel.entity.C2KLocalObject

enforceValidName

Constructor Detail

Workflow

public Workflow()

See Also:

Object.Object()

Workflow

public Workflow(CompositeActivity domain,
                PredefinedStepContainer predef)

Method Detail

getHistory

public History getHistory(TransactionKey transactionKey)
                   throws InvalidDataException

Caches a History object for this Item, using the workflow as a transactionKey. This object will be used for all Event storage during execution, to reduce the cost of creating a new one for each one. For other storage, such as during initialization, a non-cached History is created

Parameters:

transactionKey - the transaction transactionKey

Returns:

History object

Throws:

InvalidDataException - inconsistent data

getHistory

public History getHistory()
                   throws InvalidDataException

Throws:

InvalidDataException

getVertexTypeNameAndConstructionInfo

public TypeNameAndConstructionInfo[] getVertexTypeNameAndConstructionInfo()

getVertexTypeNameAndConstructionInfo() added by Steve

getEdgeTypeNameAndConstructionInfo

public TypeNameAndConstructionInfo[] getEdgeTypeNameAndConstructionInfo()

getVertexTypeNameAndConstructionInfo() added by Steve

requestAction

public String requestAction(AgentPath agent,
                            AgentPath delegator,
                            String stepPath,
                            ItemPath itemPath,
                            int transitionID,
                            String requestData,
                            String attachmentType,
                            byte[] attachment,
                            TransactionKey transactionKey)
                     throws ObjectNotFoundException,
                            AccessRightsException,
                            InvalidTransitionException,
                            InvalidDataException,
                            ObjectAlreadyExistsException,
                            PersistencyException,
                            ObjectCannotBeUpdated,
                            CannotManageException,
                            InvalidCollectionModification

Throws:

ObjectNotFoundException

AccessRightsException

InvalidTransitionException

InvalidDataException

ObjectAlreadyExistsException

PersistencyException

ObjectCannotBeUpdated

CannotManageException

InvalidCollectionModification

getPath

public String getPath()

Overrides:

getPath in class GraphableVertex

See Also:

GraphableVertex.getPath()

getName

public String getName()

Description copied from interface: C2KLocalObject

Gets the name of the C2KLocalObject

Specified by:

getName in interface C2KLocalObject

Returns:

name of the C2KLocalObject

See Also:

org.cristalise.kernel.graph.model.Vertex#getName()

getType

public String getType()

Description copied from class: Activity

Returns the type.

Overrides:

getType in class CompositeActivity

Returns:

String

See Also:

Activity.getType()

setName

public void setName(String name)

Description copied from interface: C2KLocalObject

Sets the name of the C2KLocalObject

Specified by:

setName in interface C2KLocalObject

Parameters:

name - Name of the C2KLocalObject

See Also:

org.cristalise.kernel.graph.model.Vertex#setName(java.lang.String)

verify

public boolean verify()

Description copied from class: CompositeActivity

launch the verification of the subprocess()

Overrides:

verify in class CompositeActivity

Returns:

boolean

See Also:

WfVertex.verify()

getWf

public Workflow getWf()

Overrides:

getWf in class WfVertex

Returns:

the top level CompositeActivity, aka Workflow

See Also:

WfVertex.getWf()

initialise

public void initialise(ItemPath itemPath,
                       AgentPath agent,
                       TransactionKey transactionKey)
                throws InvalidDataException

Throws:

InvalidDataException

getItemPath

public ItemPath getItemPath()

setItemPath

public void setItemPath(ItemPath itemPath)

setItemUUID

public void setItemUUID(String uuid)
                 throws InvalidItemPathException

Throws:

InvalidItemPathException

getItemUUID

public String getItemUUID()

calculateJobs

public ArrayList<Job> calculateJobs(AgentPath agent,
                                    ItemPath itemPath,
                                    int type)
                             throws InvalidAgentPathException,
                                    ObjectNotFoundException,
                                    InvalidDataException

if type = 0 only domain steps will be queried if type = 1 only predefined steps will be queried else both will be queried

Throws:

InvalidAgentPathException

ObjectNotFoundException

InvalidDataException

hasGoodNumberOfActivity

public boolean hasGoodNumberOfActivity()

Overrides:

hasGoodNumberOfActivity in class CompositeActivity

See Also:

CompositeActivity.hasGoodNumberOfActivity()

getClusterType

public ClusterType getClusterType()

Description copied from interface: C2KLocalObject

Each object belongs to a specific type defined in ClusterType

Specified by:

getClusterType in interface C2KLocalObject

Returns:

string id of the type

See Also:

C2KLocalObject.getClusterType()

getClusterPath

public String getClusterPath()

Description copied from interface: C2KLocalObject

Each C2KLocalObject is stored with a path identifier starting with the ClusterType:

• Properties: /Property/Name
• Workflow: /LifeCycle/workflow
• Collections: /Collection/Name/Version (default Name='last')
• Outcomes: /Outcome/SchemaName/SchemaVersion/EventID
• Viewpoints: /ViewPoint/SchemaName/Name (default Name='last')
• Events: /AuditTrail/EventID
• Jobs: /Job/JobID

Specified by:

getClusterPath in interface C2KLocalObject

Returns:

The path identifier (i.e. primary key) of the object