org.cristalise.kernel.lifecycle.instance.predefined.item

Class CreateItemFromDescription

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

org.cristalise.kernel.lifecycle.instance.predefined.item.CreateItemFromDescription

Direct Known Subclasses:

CreateAgentFromDescription

public class CreateItemFromDescription
extends PredefinedStep

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

AVAILABLE, 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
CreateItemFromDescription()

Method Summary

Modifier and Type	Method and Description
protected void	initialiseItem(ItemPath newItem, AgentPath agent, ItemPath descItemPath, PropertyArrayList initProps, String outcome, String newName, String descVer, DomainPath context, ItemPath newItemPath, TransactionKey transactionKey)
static Collection<?>	instantiateCollection(String collName, ItemPath descItemPath, String descVer, PropertyArrayList newProps, TransactionKey transactionKey)
protected CollectionArrayList	instantiateCollections(ItemPath descItemPath, String descVer, PropertyArrayList newProps, TransactionKey transactionKey) Copies the CollectionDescriptions of the Item requesting this predefined step.
protected PropertyArrayList	instantiateProperties(ItemPath descItemPath, String descVer, PropertyArrayList initProps, String newName, AgentPath agent, TransactionKey transactionKey)
protected Viewpoint	instantiateViewpoint(ItemPath descItemPath, String descVer, TransactionKey transactionKey)
protected CompositeActivity	instantiateWorkflow(ItemPath descItemPath, String descVer, TransactionKey transactionKey) Retrieve the Workflow dependency for the given description version, instantiate the loaded CompositeActivityDef
protected String	runActivityLogic(AgentPath agent, ItemPath descItemPath, int transitionID, String requestData, TransactionKey transactionKey) Params: Item name Domain context Description version to use(optional) Initial properties to set in the new Agent (optional)
static void	storeItem(AgentPath agent, ItemPath item, PropertyArrayList props, CollectionArrayList colls, CompositeActivity ca, Viewpoint initViewpoint, String initOutcomeString, TransactionKey transactionKey)
protected PropertyArrayList	unmarshallInitProperties(String initPropString) Unmarshalls initial Properties

Methods inherited from class org.cristalise.kernel.lifecycle.instance.predefined.PredefinedStep

addAdminAgentRole, bundleData, bundleData, getActive, getDataList, getErrors, getIsPredefined, getName, getPredefStepSchemaName, getStepInstance, getType, request, setIsPredefined, storeOutcomeEventAndViews, storeOutcomeEventAndViews, 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, 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

Constructor Detail

CreateItemFromDescription

public CreateItemFromDescription()

Method Detail

runActivityLogic

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

Params:

1. Item name
2. Domain context
3. Description version to use(optional)
4. Initial properties to set in the new Agent (optional)

Specified by:

runActivityLogic in class PredefinedStep

Returns:

Throws:

ObjectNotFoundException

InvalidDataException - The input parameters were incorrect

ObjectAlreadyExistsException - The Agent already exists

CannotManageException - The Agent could not be created

ObjectCannotBeUpdated - The addition of the new entries into the LookupManager failed

PersistencyException

initialiseItem

protected void initialiseItem(ItemPath newItem,
                              AgentPath agent,
                              ItemPath descItemPath,
                              PropertyArrayList initProps,
                              String outcome,
                              String newName,
                              String descVer,
                              DomainPath context,
                              ItemPath newItemPath,
                              TransactionKey transactionKey)
                       throws ObjectCannotBeUpdated,
                              CannotManageException,
                              InvalidDataException,
                              ObjectAlreadyExistsException,
                              PersistencyException,
                              ObjectNotFoundException

Parameters:

agent -

descItemPath -

transactionKey -

input -

newName -

descVer -

context -

newItemPath -

newItem -

Throws:

ObjectCannotBeUpdated

CannotManageException

InvalidDataException

ObjectAlreadyExistsException

PersistencyException

ObjectNotFoundException

unmarshallInitProperties

protected PropertyArrayList unmarshallInitProperties(String initPropString)
                                              throws InvalidDataException

Unmarshalls initial Properties

Parameters:

initPropString -

Returns:

unmarshalled initial PropertyArrayList

Throws:

InvalidDataException

instantiateProperties

protected PropertyArrayList instantiateProperties(ItemPath descItemPath,
                                                  String descVer,
                                                  PropertyArrayList initProps,
                                                  String newName,
                                                  AgentPath agent,
                                                  TransactionKey transactionKey)
                                           throws ObjectNotFoundException,
                                                  InvalidDataException

Parameters:

descItemPath -

descVer -

initProps -

newName -

agent -

transactionKey -

Returns:

props

Throws:

ObjectNotFoundException

InvalidDataException

instantiateWorkflow

protected CompositeActivity instantiateWorkflow(ItemPath descItemPath,
                                                String descVer,
                                                TransactionKey transactionKey)
                                         throws ObjectNotFoundException,
                                                InvalidDataException,
                                                PersistencyException

Retrieve the Workflow dependency for the given description version, instantiate the loaded CompositeActivityDef

Parameters:

descItemPath -

descVer -

transactionKey -

Returns:

the Workflow instance

Throws:

ObjectNotFoundException

InvalidDataException

PersistencyException

instantiateCollections

protected CollectionArrayList instantiateCollections(ItemPath descItemPath,
                                                     String descVer,
                                                     PropertyArrayList newProps,
                                                     TransactionKey transactionKey)
                                              throws ObjectNotFoundException,
                                                     PersistencyException,
                                                     InvalidDataException

Copies the CollectionDescriptions of the Item requesting this predefined step.

Parameters:

descItemPath -

descVer -

transactionKey -

Returns:

the new collection

Throws:

ObjectNotFoundException

PersistencyException

InvalidDataException

instantiateCollection

public static Collection<?> instantiateCollection(String collName,
                                                  ItemPath descItemPath,
                                                  String descVer,
                                                  PropertyArrayList newProps,
                                                  TransactionKey transactionKey)
                                           throws PersistencyException,
                                                  ObjectNotFoundException,
                                                  InvalidDataException

Parameters:

collName -

descItemPath -

descVer -

newProps -

transactionKey -

Returns:

Throws:

PersistencyException

ObjectNotFoundException

InvalidDataException

instantiateViewpoint

protected Viewpoint instantiateViewpoint(ItemPath descItemPath,
                                         String descVer,
                                         TransactionKey transactionKey)
                                  throws ObjectNotFoundException,
                                         InvalidDataException,
                                         PersistencyException

Parameters:

descItemPath -

descVer -

transactionKey -

Returns:

Throws:

ObjectNotFoundException

InvalidDataException

PersistencyException

storeItem

public static void storeItem(AgentPath agent,
                             ItemPath item,
                             PropertyArrayList props,
                             CollectionArrayList colls,
                             CompositeActivity ca,
                             Viewpoint initViewpoint,
                             String initOutcomeString,
                             TransactionKey transactionKey)
                      throws PersistencyException,
                             ObjectNotFoundException,
                             InvalidDataException,
                             org.exolab.castor.xml.MarshalException,
                             org.exolab.castor.xml.ValidationException,
                             IOException,
                             org.exolab.castor.mapping.MappingException

Parameters:

agent -

item -

props -

initViewpoint -

initOutcomeString -

colls -

ca -

transactionKey -

Throws:

PersistencyException

ObjectNotFoundException

InvalidDataException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

org.exolab.castor.mapping.MappingException