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

Version:

$Revision: 1.64 $ $Date: 2005/09/30 07:09:48 $

Author:

$Author: abranson $

Nested Class Summary

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

WfVertex.Types

Field Summary

Fields

Modifier and Type	Field and Description
History	history

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

active, mErrors, state

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

mIsComposite, NAME

Constructor Summary

Constructors

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

Method Summary

Methods

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	getClusterType()
TypeNameAndConstructionInfo[]	getEdgeTypeNameAndConstructionInfo() getVertexTypeNameAndConstructionInfo() added by Steve
History	getHistory()
History	getHistory(Object locker) Caches a History object for this Item, using the workflow as a locker.
ItemPath	getItemPath()
String	getItemUUID()
String	getName()
String	getPath()
String	getType() Returns the type.
TypeNameAndConstructionInfo[]	getVertexTypeNameAndConstructionInfo() getVertexTypeNameAndConstructionInfo() added by Steve
Workflow	getWf()
boolean	hasGoodNumberOfActivity() Method hasGoodNumberOfActivity.
void	initialise(ItemPath itemPath, AgentPath agent, Object locker) Method initialise.
String	requestAction(AgentPath agent, AgentPath delegator, String stepPath, ItemPath itemPath, int transitionID, String requestData) Method requestAction.
void	setItemPath(ItemPath itemPath)
void	setItemUUID(String uuid)
void	setName(String name)
boolean	verify() launch the verification of the subprocess()

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

abort, addNext, addNext, calculateAllJobs, calculateJobs, getDefaultSMName, 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, getNext, getState, getStateDate, getStateMachine, getStateName, getTypeName, isFinished, loop, pushJobsToAgents, runActivityLogic, runFirst, setActive, setActiveDate, setStartDate, setState, setStateDate, setType

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

evaluateProperty, evaluatePropertyValue, evaluateScript, getDataHelper

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

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

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

addInEdgeId, addOutEdgeId, clearTag, containsPoint, getGraphModel, getHeight, getID, getWidth, hasTag, isJoin, isLoop, moveAbsolute, removeInEdgeId, removeOutEdgeId, setCentrePoint, setGraphModel, setHeight, setID, setInEdgeIds, setOutEdgeIds, setOutlinePoints, setTag, setWidth

Methods inherited from class java.lang.Object

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

Field Detail

history

public History history

Constructor Detail

Workflow

public Workflow()

See Also:

Object.Object()

Workflow

public Workflow(CompositeActivity domain,
        PredefinedStepContainer predef)

Method Detail

getHistory

public History getHistory(Object locker)
                   throws InvalidDataException

Caches a History object for this Item, using the workflow as a locker. 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:

locker -

Returns:

Throws:

InvalidDataException

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)
                     throws ObjectNotFoundException,
                            AccessRightsException,
                            InvalidTransitionException,
                            InvalidDataException,
                            ObjectAlreadyExistsException,
                            PersistencyException,
                            ObjectCannotBeUpdated,
                            CannotManageException,
                            InvalidCollectionModification

Method requestAction.

Parameters:

agentInfo -

stepPath -

transitionID -

reguestData -

Throws:

ObjectNotFoundException

AccessRightsException

InvalidTransitionException

InvalidDataException

PersistencyException

ObjectCannotBeUpdated

CannotManageException

InvalidCollectionModification

ObjectAlreadyExistsException

getPath

public String getPath()

Overrides:

getPath in class GraphableVertex

See Also:

GraphableVertex.getPath()

getName

public String getName()

Specified by:

getName in interface C2KLocalObject

Overrides:

getName in class Vertex

See Also:

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)

Specified by:

setName in interface C2KLocalObject

Overrides:

setName in class Vertex

See Also:

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

See Also:

WfVertex.getWf()

initialise

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

Method initialise.

Parameters:

systemKey -

Throws:

InvalidDataException

ObjectNotFoundException

AccessRightsException

InvalidTransitionException

ObjectAlreadyExistsException

ObjectCannotBeUpdated

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

Parameters:

agent -

itemSysKey -

type -

Returns:

Throws:

ObjectNotFoundException

InvalidDataException

InvalidAgentPathException

hasGoodNumberOfActivity

public boolean hasGoodNumberOfActivity()

Description copied from class: CompositeActivity

Method hasGoodNumberOfActivity.

Overrides:

hasGoodNumberOfActivity in class CompositeActivity

Returns:

boolean

See Also:

CompositeActivity.hasGoodNumberOfActivity()

getClusterType

public String getClusterType()

Specified by:

getClusterType in interface C2KLocalObject

See Also:

C2KLocalObject.getClusterType()