Package org.cristalise.kernel.lifecycle.instance

Class CompositeActivity

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

Direct Known Subclasses:

PredefinedStepContainer, Workflow

public class CompositeActivity
extends Activity

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, PREDEF_STEPS_ELEMENT, state, XPATH_TOKEN

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

mIsComposite

Constructor Summary

Constructors

Constructor	Description
CompositeActivity()

Method Summary

Modifier and Type	Method	Description
void	abort(AgentPath agentPath, ItemPath itemPath, TransactionKey transactionKey)
Next	addNext(int originID, int terminusID)
Next	addNext(WfVertex origin, WfVertex terminus)
ArrayList<Job>	calculateAllJobs(AgentPath agent, ItemPath itemPath, boolean recurse)
ArrayList<Job>	calculateJobs(AgentPath agent, ItemPath itemPath, boolean recurse)	Calculates the lists of jobs for the activity and its children (cf org.cristalise.kernel.entity.Job)
List<Activity>	getPossibleActs(WfVertex fromVertex, int direction)
String	getType()	Returns the type.
boolean	hasActive()
boolean	hasGoodNumberOfActivity()
void	initChild(WfVertex vertex, boolean first, GraphPoint point)	Initialise Vertex and attach to the current activity
protected boolean	isFinishable()	Checks if the CompositeActivity can be finished by checking if there is no further Activities to be executed at its current state.
protected boolean	isFinishable(WfVertex lastVertex)	Checks if the CompositeActivity can be finished by checking if there is no further Activities to be executed at its current state.
protected boolean	isStartable()
Activity	newAtomChild(String id, boolean first, GraphPoint point)
WfVertex	newChild(String Name, String Type, GraphPoint point)
WfVertex	newChild(String vertexTypeId, GraphPoint point)
WfVertex	newChild(WfVertex.Types type, String name, boolean first, GraphPoint point)
CompositeActivity	newCompChild(String id, boolean first, GraphPoint point)
WfVertex	newExistingChild(Activity child, String Name, GraphPoint point)
Join	newJoinChild(String name, String type, boolean first, GraphPoint point)
Split	newSplitChild(String name, String Type, boolean first, GraphPoint point)
void	reinit(int idLoop)	reinitialises the Activity and propagate (for Loop)
String	request(AgentPath agent, ItemPath itemPath, int transitionID, String requestData, String attachmentType, byte[] attachment, TransactionKey transactionKey)
void	run(TransactionKey transactionKey)	called by precedent Activity runNext() for setting the activity able to be executed
void	runNext(TransactionKey transactionKey)	sets the next activity available if possible
void	setChildrenGraphModel(GraphModel childrenGraph)	Sets the childrenGraph.
void	setFirstVertex(int vertexID)
boolean	verify()	launch the verification of the subprocess()

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, request, runActivityLogic, runFirst, setActive, setActiveDate, setStartDate, setState, setStateDate, setType, toString

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

evaluateProperty, evaluatePropertyValue, evaluateScript, findLastVertex, findPair, getActContext, getWf

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

addChild, deriveVersionNumber, getBuiltInProperty, getBuiltInProperty, getCentrePoint, getChildren, getChildrenEdges, getChildrenGraphModel, getCreationContext, getInEdgeIds, getInEdges, getInGraphables, getIsComposite, getIsLayoutable, getKeyValuePairs, getLayoutableChildren, getOtherPairingID, getOutEdgeIds, getOutEdges, getOutGraphables, getOutlinePoints, getPairingId, getParent, getPath, getProperties, isMyPair, 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, wait, wait, wait

Constructor Details

CompositeActivity

public CompositeActivity()

Method Details

setChildrenGraphModel

public void setChildrenGraphModel(GraphModel childrenGraph)
                           throws InvalidDataException

Description copied from class: GraphableVertex

Sets the childrenGraph.

Overrides:

setChildrenGraphModel in class GraphableVertex

Parameters:

childrenGraph - The childrenGraph to set

Throws:

InvalidDataException - - if the graph model wasn't valid in this context

verify

public boolean verify()

launch the verification of the subprocess()

Overrides:

verify in class Activity

Returns:

boolean

initChild

public void initChild(WfVertex vertex,
 boolean first,
 GraphPoint point)

Initialise Vertex and attach to the current activity

Parameters:

vertex - the vertex to be initialised

first - if true, the Waiting state will be one of the first launched by the parent activity

point - the location of the vertex in the graph

setFirstVertex

public void setFirstVertex(int vertexID)

newExistingChild

public WfVertex newExistingChild(Activity child,
 String Name,
 GraphPoint point)

newChild

public WfVertex newChild(String Name,
 String Type,
 GraphPoint point)

newChild

public WfVertex newChild(String vertexTypeId,
 GraphPoint point)

newChild

public WfVertex newChild(WfVertex.Types type,
 String name,
 boolean first,
 GraphPoint point)

newCompChild

public CompositeActivity newCompChild(String id,
 boolean first,
 GraphPoint point)

newAtomChild

public Activity newAtomChild(String id,
 boolean first,
 GraphPoint point)

newSplitChild

public Split newSplitChild(String name,
 String Type,
 boolean first,
 GraphPoint point)

newJoinChild

public Join newJoinChild(String name,
 String type,
 boolean first,
 GraphPoint point)

run

public void run(TransactionKey transactionKey)
         throws InvalidDataException

Description copied from class: Activity

called by precedent Activity runNext() for setting the activity able to be executed

Overrides:

run in class Activity

Throws:

InvalidDataException

isStartable

protected boolean isStartable()
                       throws InvalidDataException

Returns:

Throws:

InvalidDataException

isFinishable

protected boolean isFinishable()
                        throws InvalidDataException

Checks if the CompositeActivity can be finished by checking if there is no further Activities to be executed at its current state.

Returns:

whether the CompositeActivity can be finished or not

Throws:

InvalidDataException - current data of CompositeActivity was inconsistent

isFinishable

protected boolean isFinishable(WfVertex lastVertex)
                        throws InvalidDataException

Checks if the CompositeActivity can be finished by checking if there is no further Activities to be executed at its current state.

Parameters:

lastVertex - of the current CompositeActivity is used as a starting point for the checking

Returns:

whether the CompositeActivity can be finished or not

Throws:

InvalidDataException - current data of CompositeActivity was inconsistent

runNext

public void runNext(TransactionKey transactionKey)
             throws InvalidDataException

Description copied from class: Activity

sets the next activity available if possible

Overrides:

runNext in class Activity

Throws:

InvalidDataException

calculateJobs

public ArrayList<Job> calculateJobs(AgentPath agent,
 ItemPath itemPath,
 boolean recurse)
                             throws ObjectNotFoundException,
InvalidDataException

Description copied from class: Activity

Calculates the lists of jobs for the activity and its children (cf org.cristalise.kernel.entity.Job)

Overrides:

calculateJobs in class Activity

Throws:

ObjectNotFoundException

InvalidDataException

calculateAllJobs

public ArrayList<Job> calculateAllJobs(AgentPath agent,
 ItemPath itemPath,
 boolean recurse)
                                throws ObjectNotFoundException,
InvalidDataException

Overrides:

calculateAllJobs in class Activity

Throws:

ObjectNotFoundException

InvalidDataException

addNext

public Next addNext(WfVertex origin,
 WfVertex terminus)

addNext

public Next addNext(int originID,
 int terminusID)

hasGoodNumberOfActivity

public boolean hasGoodNumberOfActivity()

getType

public String getType()

Description copied from class: Activity

Returns the type.

Overrides:

getType in class Activity

Returns:

String

reinit

public void reinit(int idLoop)
            throws InvalidDataException

Description copied from class: Activity

reinitialises the Activity and propagate (for Loop)

Overrides:

reinit in class Activity

Throws:

InvalidDataException

abort

public void abort(AgentPath agentPath,
 ItemPath itemPath,
 TransactionKey transactionKey)
           throws AccessRightsException,
InvalidTransitionException,
InvalidDataException,
ObjectNotFoundException,
PersistencyException,
ObjectAlreadyExistsException,
ObjectCannotBeUpdated,
CannotManageException,
InvalidCollectionModification

Overrides:

abort in class Activity

Throws:

AccessRightsException

InvalidTransitionException

InvalidDataException

ObjectNotFoundException

PersistencyException

ObjectAlreadyExistsException

ObjectCannotBeUpdated

CannotManageException

InvalidCollectionModification

hasActive

public boolean hasActive()

request

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

Overrides:

request in class Activity

Throws:

AccessRightsException

InvalidTransitionException

InvalidDataException

ObjectNotFoundException

PersistencyException

ObjectAlreadyExistsException

ObjectCannotBeUpdated

CannotManageException

InvalidCollectionModification

getPossibleActs

public List<Activity> getPossibleActs(WfVertex fromVertex,
 int direction)
                               throws InvalidDataException

Throws:

InvalidDataException