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

Version:

$Revision: 1.86 $ $Date: 2005/10/05 07:39:37 $

Author:

$Author: abranson $

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

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

mIsComposite, NAME

Constructor Summary

Constructors

Constructor and Description
CompositeActivity()

Method Summary

Methods

Modifier and Type	Method and Description
void	abort()
Next	addNext(int originID, int terminusID) Method addNext.
Next	addNext(WfVertex origin, WfVertex terminus) Method addNext.
ArrayList<Job>	calculateAllJobs(AgentPath agent, ItemPath itemPath, boolean recurse)
ArrayList<Job>	calculateJobs(AgentPath agent, ItemPath itemPath, boolean recurse) returns the lists of jobs for the activity and children (cf org.cristalise.kernel.entity.Job)
protected String	getDefaultSMName()
String	getType() Returns the type.
boolean	hasActive()
boolean	hasGoodNumberOfActivity() Method hasGoodNumberOfActivity.
void	initChild(WfVertex vertex, boolean first, GraphPoint point) Initialize Vertex and attach to the current activity
Activity	newAtomChild(String id, boolean first, GraphPoint point) Method newAtomChild.
WfVertex	newChild(String vertexTypeId, GraphPoint point) Method newChild.
WfVertex	newChild(String Name, String Type, GraphPoint point) Method newChild.
WfVertex	newChild(WfVertex.Types type, String name, boolean first, GraphPoint point)
CompositeActivity	newCompChild(String id, boolean first, GraphPoint point) Method newCompChild.
WfVertex	newExistingChild(Activity child, String Name, GraphPoint point) Method newChild.
Join	newJoinChild(String name, String type, boolean first, GraphPoint point) Method newJoinChild.
Split	newSplitChild(String name, String Type, boolean first, GraphPoint point) Method newSplitChild.
void	refreshJobs(ItemPath itemPath)
void	reinit(int idLoop) reinitialises the Activity and propagate (for Loop)
String	request(AgentPath agent, AgentPath delegator, ItemPath itemPath, int transitionID, String requestData, Object locker) cf Item request
void	run(AgentPath agent, ItemPath itemPath, Object locker) called by precedent Activity runNext() for setting the activity able to be executed
void	runNext(AgentPath agent, ItemPath itemPath, Object locker) 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, 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, getWf

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, getPath, getProperties, search, setIsComposite, setIsLayoutable, setKeyValuePairs, setParent, setProperties

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeActivity

public CompositeActivity()

Method Detail

getDefaultSMName

protected String getDefaultSMName()

Overrides:

getDefaultSMName in class Activity

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)

Initialize Vertex and attach to the current activity

Parameters:

vertex -

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

point -

setFirstVertex

public void setFirstVertex(int vertexID)

Parameters:

vertex -

newExistingChild

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

Method newChild.

Parameters:

Name -

Type -

point -

Returns:

WfVertex

newChild

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

Method newChild.

Parameters:

Name -

Type -

point -

Returns:

WfVertex

newChild

public WfVertex newChild(String vertexTypeId,
                GraphPoint point)

Method newChild.

Parameters:

vertexTypeId -

point -

Returns:

WfVertex

Throws:

InvalidDataException

newChild

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

Parameters:

type -

name -

first -

point -

Returns:

newCompChild

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

Method newCompChild.

Parameters:

id -

first -

point -

Returns:

CompositeActivity Create an initialize a composite Activity attached to the current activity

newAtomChild

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

Method newAtomChild.

Parameters:

id -

first -

point -

Returns:

Activity Create an initialize an Atomic Activity attached to the current activity

newSplitChild

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

Method newSplitChild.

Parameters:

Type -

point -

Returns:

Split

newJoinChild

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

Method newJoinChild.

Parameters:

point -

Returns:

Join

run

public void run(AgentPath agent,
       ItemPath itemPath,
       Object locker)
         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

ObjectNotFoundException

AccessRightsException

InvalidTransitionException

PersistencyException

ObjectAlreadyExistsException

ObjectCannotBeUpdated

See Also:

org.cristalise.kernel.lifecycle.instance.WfVertex#run()

runNext

public void runNext(AgentPath agent,
           ItemPath itemPath,
           Object locker)
             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 InvalidAgentPathException,
                                    ObjectNotFoundException,
                                    InvalidDataException

Description copied from class: Activity

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

Overrides:

calculateJobs in class Activity

Throws:

InvalidDataException

ObjectNotFoundException

InvalidAgentPathException

See Also:

org.cristalise.kernel.lifecycle.instance.Activity#calculateJobs()

calculateAllJobs

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

Overrides:

calculateAllJobs in class Activity

Throws:

InvalidAgentPathException

ObjectNotFoundException

InvalidDataException

addNext

public Next addNext(WfVertex origin,
           WfVertex terminus)

Method addNext.

Parameters:

origin -

terminus -

Returns:

Next

addNext

public Next addNext(int originID,
           int terminusID)

Method addNext.

Parameters:

originID -

terminusID -

Returns:

Next

hasGoodNumberOfActivity

public boolean hasGoodNumberOfActivity()

Method hasGoodNumberOfActivity.

Returns:

boolean

getType

public String getType()

Description copied from class: Activity

Returns the type.

Overrides:

getType in class Activity

Returns:

String

See Also:

Activity.getType()

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()

Overrides:

abort in class Activity

hasActive

public boolean hasActive()

request

public String request(AgentPath agent,
             AgentPath delegator,
             ItemPath itemPath,
             int transitionID,
             String requestData,
             Object locker)
               throws AccessRightsException,
                      InvalidTransitionException,
                      InvalidDataException,
                      ObjectNotFoundException,
                      PersistencyException,
                      ObjectAlreadyExistsException,
                      ObjectCannotBeUpdated,
                      CannotManageException,
                      InvalidCollectionModification

Description copied from class: Activity

cf Item request

Overrides:

request in class Activity

Throws:

ObjectNotFoundException

PersistencyException

ObjectAlreadyExistsException

ObjectCannotBeUpdated

CannotManageException

InvalidCollectionModification

AccessRightsException

InvalidTransitionException

InvalidDataException

refreshJobs

public void refreshJobs(ItemPath itemPath)