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, CreateNewAgent, CreateNewCollectionVersion, CreateNewItem, CreateNewRole, Erase, ForcedLogout, Import, LoginTimeout, Logout, 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 and Description
static int	AVAILABLE
static int	DONE

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

active, mErrors, state, XPATH_TOKEN

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

mIsComposite

Constructor Summary

Constructors

Constructor and Description
PredefinedStep()

Method Summary

Modifier and Type	Method and Description
protected void	addAdminAgentRole()
static String	bundleData(String... data) Generic bundling of parameters.
static String	bundleData(String data) Generic bundling of a single parameter.
boolean	getActive()
static String[]	getDataList(String xmlData)
String	getErrors() return the String that identifies the errors found in th activity
boolean	getIsPredefined() Returns the isPredefined.
String	getName()
static String	getPredefStepSchemaName(String stepName)
static Activity	getStepInstance(String stepName)
String	getType() Returns the type.
String	request(AgentPath agent, ItemPath itemPath, String requestData, Object transactionKey) Use this method to run a Predefined step during bootstrap
protected abstract String	runActivityLogic(AgentPath agent, ItemPath itemPath, int transitionID, String requestData, Object locker) All predefined steps must override this to implement their action
void	setIsPredefined(boolean isPredefined) Sets the isPredefined.
static void	storeOutcomeEventAndViews(ItemPath itemPath, Outcome newOutcome, Integer version, Object transactionKey) TODO Implement Bootstrap predefined step
static void	storeOutcomeEventAndViews(ItemPath itemPath, Outcome newOutcome, Object 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, getStateName, getTypeName, isFinished, loop, pushJobsToAgents, pushJobsToAgents, reinit, request, request, run, runFirst, runNext, setActive, setActiveDate, setStartDate, setState, setStateDate, setType

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

evaluateProperty, evaluatePropertyValue, evaluateScript, findPair, getActContext, getOtherPairingID, getWf, isMyPair

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

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

Field Detail

DONE

public static final int DONE

See Also:

Constant Field Values

AVAILABLE

public static final int AVAILABLE

See Also:

Constant Field Values

Constructor Detail

PredefinedStep

public PredefinedStep()

Method Detail

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

getIsPredefined

public boolean getIsPredefined()

Returns the isPredefined.

Returns:

boolean

setIsPredefined

public void setIsPredefined(boolean isPredefined)

Sets the isPredefined.

Parameters:

isPredefined - The isPredefined to set

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 Activity getStepInstance(String stepName)

runActivityLogic

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

All predefined steps must override this to implement their action

Overrides:

runActivityLogic in class Activity

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)

addAdminAgentRole

protected void addAdminAgentRole()

storeOutcomeEventAndViews

public static void storeOutcomeEventAndViews(ItemPath itemPath,
                                             Outcome newOutcome,
                                             Object 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,
                                             Object 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,
                      Object transactionKey)
               throws AccessRightsException,
                      InvalidTransitionException,
                      InvalidDataException,
                      ObjectNotFoundException,
                      PersistencyException,
                      ObjectAlreadyExistsException,
                      ObjectCannotBeUpdated,
                      CannotManageException,
                      InvalidCollectionModification

Use this method to run a Predefined step during bootstrap

Parameters:

agent -

itemPath -

requestData -

transactioKey -

Returns:

Throws:

AccessRightsException

InvalidTransitionException

InvalidDataException

ObjectNotFoundException

PersistencyException

ObjectAlreadyExistsException

ObjectCannotBeUpdated

CannotManageException

InvalidCollectionModification