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

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

Modifier and Type	Field	Description
static final String	FACTORY_GENERATED_NAME	Use this constant to enforce the factory to generate the name

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, PREDEF_STEPS_ELEMENT, state, XPATH_TOKEN

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

mIsComposite

Constructor Summary

Constructors

Constructor	Description
CreateItemFromDescription()
CreateItemFromDescription(String desc)

Method Summary

Modifier and Type	Method	Description
String	getItemName(ItemPath descItemPath, String newName, TransactionKey transactionKey)
protected void	initialiseItem(ItemPath newItem, AgentProxy agent, ItemProxy descItem, PropertyArrayList initProps, String outcome, String newName, String descVer, DomainPath context, ItemPath newItemPath, TransactionKey transactionKey)
static Collection<?>	instantiateCollection(String collName, ItemProxy descItem, String descVer, PropertyArrayList newProps, TransactionKey transactionKey)
protected CollectionArrayList	instantiateCollections(ItemProxy descItem, String descVer, PropertyArrayList newProps, TransactionKey transactionKey)	Copies the CollectionDescriptions of the Item requesting this predefined step.
protected PropertyArrayList	instantiateProperties(ItemProxy descItem, String descVer, PropertyArrayList initProps, String newName, TransactionKey transactionKey)
protected Viewpoint	instantiateViewpoint(ItemProxy descItem, String descVer, TransactionKey transactionKey)
protected CompositeActivity	instantiateWorkflow(ItemProxy descItem, String descVer, TransactionKey transactionKey)	Retrieve the Workflow dependency for the given description version, instantiate the loaded CompositeActivityDef
protected String	runActivityLogic(AgentPath agentPath, 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

bundleData, bundleData, computeUpdates, getActive, getDataList, getErrors, getName, getPredefStepOutcomeNode, getPredefStepSchemaName, getStepInstance, getType, mergeProperties, request, 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, 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

FACTORY_GENERATED_NAME

public static final String FACTORY_GENERATED_NAME

Use this constant to enforce the factory to generate the name

See Also:

• Constant Field Values

Constructor Details

CreateItemFromDescription

public CreateItemFromDescription(String desc)

CreateItemFromDescription

public CreateItemFromDescription()

Method Details

runActivityLogic

protected String runActivityLogic(AgentPath agentPath,
 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

Parameters:

agentPath -

descItemPath -

transitionID -

requestData -

transactionKey -

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

getItemName

public String getItemName(ItemPath descItemPath,
 String newName,
 TransactionKey transactionKey)
                   throws InvalidDataException,
PersistencyException,
ObjectCannotBeUpdated,
ObjectNotFoundException

Parameters:

descItemPath -

newName -

transactionKey -

Returns:

Throws:

InvalidDataException

ObjectNotFoundException

ObjectCannotBeUpdated

PersistencyException

initialiseItem

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

Parameters:

newItem -

agent -

descItem -

initProps -

outcome -

newName -

descVer -

context -

newItemPath -

transactionKey -

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(ItemProxy descItem,
 String descVer,
 PropertyArrayList initProps,
 String newName,
 TransactionKey transactionKey)
                                           throws ObjectNotFoundException,
InvalidDataException

Parameters:

descVer -

initProps -

newName -

transactionKey -

descItemPath -

agent -

Returns:

props

Throws:

ObjectNotFoundException

InvalidDataException

instantiateWorkflow

protected CompositeActivity instantiateWorkflow(ItemProxy descItem,
 String descVer,
 TransactionKey transactionKey)
                                         throws ObjectNotFoundException,
InvalidDataException,
PersistencyException

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

Parameters:

descVer -

transactionKey -

descItemPath -

Returns:

the Workflow instance

Throws:

ObjectNotFoundException

InvalidDataException

PersistencyException

instantiateCollections

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

Copies the CollectionDescriptions of the Item requesting this predefined step.

Parameters:

descVer -

transactionKey -

descItemPath -

Returns:

the new collection

Throws:

ObjectNotFoundException

PersistencyException

InvalidDataException

instantiateCollection

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

Parameters:

collName -

descVer -

newProps -

transactionKey -

descItemPath -

Returns:

Throws:

PersistencyException

ObjectNotFoundException

InvalidDataException

instantiateViewpoint

protected Viewpoint instantiateViewpoint(ItemProxy descItem,
 String descVer,
 TransactionKey transactionKey)
                                  throws ObjectNotFoundException,
InvalidDataException,
PersistencyException

Parameters:

descVer -

transactionKey -

descItemPath -

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

Parameters:

agent -

item -

props -

colls -

ca -

initViewpoint -

initOutcomeString -

transactionKey -

Throws:

PersistencyException

ObjectNotFoundException

InvalidDataException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

org.exolab.castor.mapping.MappingException