Package org.cristalise.kernel.lifecycle.instance.predefined

Class PredefinedStep

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.predefined.PredefinedStep

Direct Known Subclasses:

AddC2KObject, AddDomainContext, AddDomainPath, AddNewCollectionDescription, AddNewSlot, AssignItemToSlot, Authenticate, BulkImport, ChangeName, ClearSlot, ConfigureLogback, CreateItemFromDescription, CreateNewCollectionVersion, Erase, ForcedLogout, Import, ImportImportAgent, ImportImportItem, ImportImportRole, LoginTimeout, Logout, ManageMembersOfCollectionBase, PredefinedStepCollectionBase, RemoveC2KObject, RemoveDomainContext, RemoveDomainPath, RemoveRole, RemoveViewpoint, ReplaceDomainWorkflow, SetAgentPassword, SetAgentRoles, UpdateCollectionsFromDescription, UpdateImportReport, UpdateItemFromDescription, UpdateProperitesFromDescription, UpdateRole, WriteProperty, WriteViewpoint

public abstract class PredefinedStep
extends Activity

PredefinedStep are always Active, and have only one transition. Subclasses could override this method (if necessary)

Nested Class Summary

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

WfVertex.Types

Field Summary

Fields

Modifier and Type	Field	Description
static final int	AVAILABLE
static final int	DONE

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
PredefinedStep(String description)
PredefinedStep(String schemaName, String description)

Method Summary

Modifier and Type	Method	Description
static String	bundleData(String data)	Generic bundling of a single parameter.
static String	bundleData(String... data)	Generic bundling of parameters.
void	computeUpdates(ItemPath currentItem, Activity currentActivity, Node outcomeNode, TransactionKey transactionKey)
boolean	getActive()
static String[]	getDataList(String xmlData)
String	getErrors()	return the String that identifies the errors found in th activity
String	getName()
Node	getPredefStepOutcomeNode(Node predefStepNode)
static String	getPredefStepSchemaName(String stepName)
static PredefinedStep	getStepInstance(String stepName)
String	getType()	Returns the type.
void	mergeProperties(CastorHashMap newProps)
String	request(AgentPath agent, ItemPath itemPath, String requestData, TransactionKey transactionKey)	Use this method to run a Predefined steps during Bootstrap or during Activity.request()
protected abstract String	runActivityLogic(AgentPath agent, ItemPath itemPath, int transitionID, String requestData, TransactionKey transactionKey)	All predefined steps must override this to implement their action
static void	storeOutcomeEventAndViews(ItemPath itemPath, Outcome newOutcome, Integer version, TransactionKey transactionKey)	TODO Implement Bootstrap predefined step
static void	storeOutcomeEventAndViews(ItemPath itemPath, Outcome newOutcome, TransactionKey transactionKey)	TODO Implement Bootstrap predefined step
boolean	verify()	Method verify.

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

abort, addNext, calculateAllJobs, calculateJobs, getCurrentAgentName, getCurrentAgentRole, getDescription, getErrorTransitionId, getNext, getState, getStateDate, getStateMachine, getStateMachine, getStateName, getTypeName, isFinished, loop, reinit, request, request, run, runFirst, runNext, 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, setChildrenGraphModel, 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

Field Details

DONE

public static final int DONE

See Also:

• Constant Field Values

AVAILABLE

public static final int AVAILABLE

See Also:

• Constant Field Values

Constructor Details

PredefinedStep

public PredefinedStep(String schemaName,
 String description)

PredefinedStep

public PredefinedStep(String description)

Method Details

getActive

public boolean getActive()

Overrides:

getActive in class Activity

Returns:

the current ability to be executed

getErrors

public String getErrors()

Description copied from class: Activity

return the String that identifies the errors found in th activity

Overrides:

getErrors in class Activity

Returns:

String

verify

public boolean verify()

Description copied from class: WfVertex

Method verify.

Overrides:

verify in class Activity

Returns:

boolean

getType

public String getType()

Description copied from class: Activity

Returns the type.

Overrides:

getType in class Activity

Returns:

String

getName

public String getName()

getPredefStepSchemaName

public static String getPredefStepSchemaName(String stepName)

getStepInstance

public static PredefinedStep getStepInstance(String stepName)

getPredefStepOutcomeNode

public Node getPredefStepOutcomeNode(Node predefStepNode)
                              throws InvalidDataException

Throws:

InvalidDataException

runActivityLogic

protected abstract String runActivityLogic(AgentPath agent,
 ItemPath itemPath,
 int transitionID,
 String requestData,
 TransactionKey transactionKey)
                                    throws InvalidDataException,
InvalidCollectionModification,
ObjectAlreadyExistsException,
ObjectCannotBeUpdated,
ObjectNotFoundException,
PersistencyException,
CannotManageException,
AccessRightsException

All predefined steps must override this to implement their action

Overrides:

runActivityLogic in class Activity

Parameters:

agent -

itemPath -

transitionID -

requestData -

transactionKey -

Returns:

Throws:

InvalidDataException

InvalidCollectionModification

ObjectAlreadyExistsException

ObjectCannotBeUpdated

ObjectNotFoundException

PersistencyException

CannotManageException

AccessRightsException

bundleData

public static String bundleData(String... data)

Generic bundling of parameters. Converts the array of strings to PredefinedStepOutcome XML. Uses CDATA so any of the string could also be an XML.

Parameters:

data - array of input string for a PredefinedStep

Returns:

the result of the PredefienedStep execution

bundleData

public static String bundleData(String data)

Generic bundling of a single parameter. Converts the array of strings to PredefinedStepOutcome XML. Uses CDATA so the string could also be an XML.

Parameters:

input - string for a PredefinedStep

Returns:

the result of the PredefienedStep execution

getDataList

public static String[] getDataList(String xmlData)

storeOutcomeEventAndViews

public static void storeOutcomeEventAndViews(ItemPath itemPath,
 Outcome newOutcome,
 TransactionKey transactionKey)
                                      throws PersistencyException,
ObjectNotFoundException,
InvalidDataException

TODO Implement Bootstrap predefined step

Parameters:

itemPath -

newOutcome -

Throws:

PersistencyException

ObjectNotFoundException

InvalidDataException

storeOutcomeEventAndViews

public static void storeOutcomeEventAndViews(ItemPath itemPath,
 Outcome newOutcome,
 Integer version,
 TransactionKey transactionKey)
                                      throws PersistencyException,
ObjectNotFoundException,
InvalidDataException

TODO Implement Bootstrap predefined step

Parameters:

itemPath -

newOutcome -

version -

Throws:

PersistencyException

ObjectNotFoundException

InvalidDataException

request

public String request(AgentPath agent,
 ItemPath itemPath,
 String requestData,
 TransactionKey transactionKey)
               throws AccessRightsException,
InvalidTransitionException,
InvalidDataException,
ObjectNotFoundException,
PersistencyException,
ObjectAlreadyExistsException,
ObjectCannotBeUpdated,
CannotManageException,
InvalidCollectionModification

Use this method to run a Predefined steps during Bootstrap or during Activity.request()

Parameters:

agent -

itemPath -

requestData -

transactioKey -

Returns:

Throws:

AccessRightsException

InvalidTransitionException

InvalidDataException

ObjectNotFoundException

PersistencyException

ObjectAlreadyExistsException

ObjectCannotBeUpdated

CannotManageException

InvalidCollectionModification

computeUpdates

public void computeUpdates(ItemPath currentItem,
 Activity currentActivity,
 Node outcomeNode,
 TransactionKey transactionKey)
                    throws InvalidDataException,
PersistencyException,
ObjectNotFoundException,
ObjectAlreadyExistsException,
InvalidCollectionModification

Parameters:

currentItem -

currentActivity -

transactionKey -

inputOutcome -

Throws:

InvalidDataException

PersistencyException

ObjectNotFoundException

ObjectAlreadyExistsException

InvalidCollectionModification

mergeProperties

public void mergeProperties(CastorHashMap newProps)