org.cristalise.kernel.lifecycle.instance

Class Activity

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

Direct Known Subclasses:

CompositeActivity, PredefinedStep

public class Activity
extends WfVertex

Version:

$Revision: 1.222 $ $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

Modifier and Type	Field and Description
boolean	active true is available to be executed
protected Vector<String>	mErrors vector of errors (Strings) that is constructed each time verify() is launched
protected int	state

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

mIsComposite, NAME

Constructor Summary

Constructors

Constructor and Description
Activity()

Method Summary

Methods

Modifier and Type	Method and Description
void	abort()
Next	addNext(WfVertex vertex) adds a New link between the current Activity and the WfVertex passed in param
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)
boolean	getActive()
String	getCurrentAgentName()
String	getCurrentAgentRole()
protected String	getDefaultSMName()
String	getDescription()
String	getErrors() return the String that identifies the errors found in th activity
Next	getNext()
int	getState() return the current State of the State machine (Used in Serialisation)
GTimeStamp	getStateDate() Returns the startDate.
StateMachine	getStateMachine()
String	getStateName()
String	getType() Returns the type.
String	getTypeName()
boolean	isFinished()
boolean	loop() Used in verify()
protected void	pushJobsToAgents(ItemPath itemPath)
void	reinit(int idLoop) reinitialises the Activity and propagate (for Loop)
String	request(AgentPath agent, AgentPath delegate, 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
protected String	runActivityLogic(AgentPath agent, ItemPath itemPath, int transitionID, String requestData, Object locker)
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
void	runNext(AgentPath agent, ItemPath itemPath, Object locker) sets the next activity available if possible
void	setActive(boolean acti) sets the ability to be executed
void	setActiveDate(GTimeStamp date) Deprecated.
void	setStartDate(GTimeStamp date) Deprecated.
void	setState(int state) Sets a new State
void	setStateDate(GTimeStamp startDate)
void	setType(String type) Sets the type.
boolean	verify() Method verify.

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, setChildrenGraphModel, 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

Field Detail

mErrors

protected Vector<String> mErrors

vector of errors (Strings) that is constructed each time verify() is launched

state

protected int state

active

public boolean active

true is available to be executed

Constructor Detail

Activity

public Activity()

Method Detail

getDefaultSMName

protected String getDefaultSMName()

addNext

public Next addNext(WfVertex vertex)

adds a New link between the current Activity and the WfVertex passed in param

Specified by:

addNext in class WfVertex

getStateMachine

public StateMachine getStateMachine()
                             throws InvalidDataException

Throws:

InvalidDataException

getState

public int getState()
             throws InvalidDataException

return the current State of the State machine (Used in Serialisation)

Throws:

InvalidDataException

getStateName

public String getStateName()
                    throws InvalidDataException

Throws:

InvalidDataException

setState

public void setState(int state)

Sets a new State

isFinished

public boolean isFinished()
                   throws InvalidDataException

Throws:

InvalidDataException

request

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

cf Item request

Throws:

ObjectNotFoundException

PersistencyException

ObjectAlreadyExistsException

ObjectCannotBeUpdated

CannotManageException

InvalidCollectionModification

AccessRightsException

InvalidTransitionException

InvalidDataException

runActivityLogic

protected String runActivityLogic(AgentPath agent,
                      ItemPath itemPath,
                      int transitionID,
                      String requestData,
                      Object locker)
                           throws InvalidDataException,
                                  InvalidCollectionModification,
                                  ObjectAlreadyExistsException,
                                  ObjectCannotBeUpdated,
                                  ObjectNotFoundException,
                                  PersistencyException,
                                  CannotManageException

Throws:

InvalidDataException

InvalidCollectionModification

ObjectAlreadyExistsException

ObjectCannotBeUpdated

ObjectNotFoundException

PersistencyException

CannotManageException

verify

public boolean verify()

Description copied from class: WfVertex

Method verify.

Specified by:

verify in class WfVertex

Returns:

boolean

loop

public boolean loop()

Used in verify()

Specified by:

loop in class WfVertex

Returns:

boolean

runNext

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

sets the next activity available if possible

Specified by:

runNext in class WfVertex

Throws:

ObjectNotFoundException

AccessRightsException

InvalidTransitionException

PersistencyException

ObjectAlreadyExistsException

ObjectCannotBeUpdated

InvalidDataException

getNext

public Next getNext()

Returns:

the only Next of the Activity

reinit

public void reinit(int idLoop)
            throws InvalidDataException

reinitialises the Activity and propagate (for Loop)

Specified by:

reinit in class WfVertex

Throws:

InvalidDataException

ObjectNotFoundException

getErrors

public String getErrors()

return the String that identifies the errors found in th activity

Specified by:

getErrors in class WfVertex

Returns:

String

run

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

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

Specified by:

run in class WfVertex

Throws:

InvalidDataException

ObjectAlreadyExistsException

AccessRightsException

InvalidTransitionException

ObjectNotFoundException

PersistencyException

ObjectCannotBeUpdated

runFirst

public 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

Specified by:

runFirst in class WfVertex

Throws:

InvalidDataException

ObjectAlreadyExistsException

ObjectNotFoundException

AccessRightsException

InvalidTransitionException

PersistencyException

ObjectCannotBeUpdated

getActive

public boolean getActive()

Returns:

the current ability to be executed

setActive

public void setActive(boolean acti)

sets the ability to be executed

getDescription

public String getDescription()

Returns:

the Description field of properties

getCurrentAgentName

public String getCurrentAgentName()

getCurrentAgentRole

public String getCurrentAgentRole()

calculateJobs

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

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

Throws:

InvalidDataException

ObjectNotFoundException

InvalidAgentPathException

calculateAllJobs

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

Throws:

InvalidAgentPathException

ObjectNotFoundException

InvalidDataException

pushJobsToAgents

protected void pushJobsToAgents(ItemPath itemPath)

getStateDate

public GTimeStamp getStateDate()

Returns the startDate.

Returns:

GTimeStamp

setStateDate

public void setStateDate(GTimeStamp startDate)

setActiveDate

@Deprecated
public void setActiveDate(GTimeStamp date)

Deprecated.

setStartDate

@Deprecated
public void setStartDate(GTimeStamp date)

Deprecated.

getType

public String getType()

Returns the type.

Returns:

String

getTypeName

public String getTypeName()

setType

public void setType(String type)

Sets the type.

Parameters:

type - The type to set

abort

public void abort()

Overrides:

abort in class WfVertex