org.cristalise.kernel.lifecycle

Class ActivityDef

java.lang.Object

org.cristalise.kernel.graph.model.Vertex

org.cristalise.kernel.graph.model.GraphableVertex

org.cristalise.kernel.lifecycle.WfVertexDef

org.cristalise.kernel.lifecycle.ActivityDef

All Implemented Interfaces:

C2KLocalObject, DescriptionObject

Direct Known Subclasses:

CompositeActivityDef

public class ActivityDef
extends WfVertexDef
implements C2KLocalObject, DescriptionObject

Field Summary

Fields

Modifier and Type	Field and Description
boolean	changed

Fields inherited from class org.cristalise.kernel.lifecycle.WfVertexDef

loopTested, mErrors

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

mIsComposite

Constructor Summary

Constructors

Constructor and Description
ActivityDef()

Method Summary

Modifier and Type	Method and Description
void	configureInstance(WfVertex act, TransactionKey transactionKey) Copies Properties from vertex definition to vertex instance, and also set the Edges
void	export(Writer imports, File dir, boolean shallow)
protected void	exportCollections(Writer imports, File dir)
String	getActName()
protected DescriptionObject[]	getBuiltInCollectionResource(BuiltInCollections collection, TransactionKey transactionKey)
String	getClusterPath() Each C2KLocalObject is stored with a path identifier starting with the ClusterType: Properties: /Property/Name Workflow: /LifeCycle/workflow Collections: /Collection/Name/Version (default Name='last') Outcomes: /Outcome/SchemaName/SchemaVersion/EventID Viewpoints: /ViewPoint/SchemaName/Name (default Name='last') Events: /AuditTrail/EventID Jobs: /Job/JobID
ClusterType	getClusterType() Each object belongs to a specific type defined in ClusterType
String	getDescName()
String	getErrors() Method getErrors.
protected String	getExportAttributes(String type)
protected String	getExportCollections()
String	getItemID()
ItemPath	getItemPath()
Query	getQuery()
Query	getQuery(TransactionKey transactionKey)
Schema	getSchema()
Schema	getSchema(TransactionKey transactionKey)
Script	getScript()
Script	getScript(TransactionKey transactionKey)
StateMachine	getStateMachine()
StateMachine	getStateMachine(TransactionKey transactionKey)
Integer	getVersion()
WfVertex	instantiate(String name, TransactionKey transactionKey)
WfVertex	instantiate(TransactionKey transactionKey)
Dependency	makeDescCollection(BuiltInCollections collection, TransactionKey transactionKey, DescriptionObject... descs)
CollectionArrayList	makeDescCollections(TransactionKey transactionKey)
void	setID(int id)
void	setItemPath(ItemPath path)
void	setQuery(Query actQuery)
void	setSchema(Schema actSchema)
void	setScript(Script actScript)
void	setStateMachine(StateMachine actStateMachine)
void	setVersion(Integer v)
String	toString()
boolean	verify() Method verify.

Methods inherited from class org.cristalise.kernel.lifecycle.WfVertexDef

loop

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

Methods inherited from interface org.cristalise.kernel.entity.C2KLocalObject

enforceValidName, getName, setName

Methods inherited from interface org.cristalise.kernel.utils.DescriptionObject

getName, setName

Field Detail

changed

public boolean changed

Constructor Detail

ActivityDef

public ActivityDef()

Method Detail

setID

public void setID(int id)

getItemID

public String getItemID()

Specified by:

getItemID in interface DescriptionObject

setVersion

public void setVersion(Integer v)

Specified by:

setVersion in interface DescriptionObject

getVersion

public Integer getVersion()

Specified by:

getVersion in interface DescriptionObject

getErrors

public String getErrors()

Description copied from class: WfVertexDef

Method getErrors.

Overrides:

getErrors in class WfVertexDef

Returns:

String

verify

public boolean verify()

Description copied from class: WfVertexDef

Method verify.

Specified by:

verify in class WfVertexDef

Returns:

boolean

getClusterType

public ClusterType getClusterType()

Description copied from interface: C2KLocalObject

Each object belongs to a specific type defined in ClusterType

Specified by:

getClusterType in interface C2KLocalObject

Returns:

string id of the type

getClusterPath

public String getClusterPath()

Description copied from interface: C2KLocalObject

Each C2KLocalObject is stored with a path identifier starting with the ClusterType:

• Properties: /Property/Name
• Workflow: /LifeCycle/workflow
• Collections: /Collection/Name/Version (default Name='last')
• Outcomes: /Outcome/SchemaName/SchemaVersion/EventID
• Viewpoints: /ViewPoint/SchemaName/Name (default Name='last')
• Events: /AuditTrail/EventID
• Jobs: /Job/JobID

Specified by:

getClusterPath in interface C2KLocalObject

Returns:

The path identifier (i.e. primary key) of the object

getActName

public String getActName()

getDescName

public String getDescName()

instantiate

public WfVertex instantiate(TransactionKey transactionKey)
                     throws ObjectNotFoundException,
                            InvalidDataException

Specified by:

instantiate in class WfVertexDef

Throws:

ObjectNotFoundException

InvalidDataException

instantiate

public WfVertex instantiate(String name,
                            TransactionKey transactionKey)
                     throws ObjectNotFoundException,
                            InvalidDataException

Throws:

ObjectNotFoundException

InvalidDataException

configureInstance

public void configureInstance(WfVertex act,
                              TransactionKey transactionKey)
                       throws InvalidDataException,
                              ObjectNotFoundException

Description copied from class: WfVertexDef

Copies Properties from vertex definition to vertex instance, and also set the Edges

Overrides:

configureInstance in class WfVertexDef

Parameters:

act - the vertex instance to be configured

Throws:

InvalidDataException - inconsistent data

ObjectNotFoundException - data was not found

getItemPath

public ItemPath getItemPath()

Specified by:

getItemPath in interface DescriptionObject

setItemPath

public void setItemPath(ItemPath path)

Specified by:

setItemPath in interface DescriptionObject

getSchema

public Schema getSchema()
                 throws InvalidDataException,
                        ObjectNotFoundException

Throws:

InvalidDataException

ObjectNotFoundException

getSchema

public Schema getSchema(TransactionKey transactionKey)
                 throws InvalidDataException,
                        ObjectNotFoundException

Throws:

InvalidDataException

ObjectNotFoundException

getScript

public Script getScript()
                 throws InvalidDataException,
                        ObjectNotFoundException

Throws:

InvalidDataException

ObjectNotFoundException

getScript

public Script getScript(TransactionKey transactionKey)
                 throws InvalidDataException,
                        ObjectNotFoundException

Throws:

InvalidDataException

ObjectNotFoundException

getQuery

public Query getQuery()
               throws InvalidDataException,
                      ObjectNotFoundException

Throws:

InvalidDataException

ObjectNotFoundException

getQuery

public Query getQuery(TransactionKey transactionKey)
               throws InvalidDataException,
                      ObjectNotFoundException

Throws:

InvalidDataException

ObjectNotFoundException

getStateMachine

public StateMachine getStateMachine()
                             throws InvalidDataException,
                                    ObjectNotFoundException

Throws:

InvalidDataException

ObjectNotFoundException

getStateMachine

public StateMachine getStateMachine(TransactionKey transactionKey)
                             throws InvalidDataException,
                                    ObjectNotFoundException

Throws:

InvalidDataException

ObjectNotFoundException

getBuiltInCollectionResource

protected DescriptionObject[] getBuiltInCollectionResource(BuiltInCollections collection,
                                                           TransactionKey transactionKey)
                                                    throws ObjectNotFoundException,
                                                           InvalidDataException

Throws:

ObjectNotFoundException

InvalidDataException

setSchema

public void setSchema(Schema actSchema)

setScript

public void setScript(Script actScript)

setQuery

public void setQuery(Query actQuery)

setStateMachine

public void setStateMachine(StateMachine actStateMachine)

makeDescCollection

public Dependency makeDescCollection(BuiltInCollections collection,
                                     TransactionKey transactionKey,
                                     DescriptionObject... descs)
                              throws InvalidDataException

Throws:

InvalidDataException

makeDescCollections

public CollectionArrayList makeDescCollections(TransactionKey transactionKey)
                                        throws InvalidDataException,
                                               ObjectNotFoundException

Specified by:

makeDescCollections in interface DescriptionObject

Throws:

InvalidDataException

ObjectNotFoundException

export

public void export(Writer imports,
                   File dir,
                   boolean shallow)
            throws InvalidDataException,
                   ObjectNotFoundException,
                   IOException

Specified by:

export in interface DescriptionObject

Throws:

InvalidDataException

ObjectNotFoundException

IOException

exportCollections

protected void exportCollections(Writer imports,
                                 File dir)
                          throws InvalidDataException,
                                 ObjectNotFoundException,
                                 IOException

Throws:

InvalidDataException

ObjectNotFoundException

IOException

getExportAttributes

protected String getExportAttributes(String type)
                              throws InvalidDataException,
                                     ObjectNotFoundException,
                                     IOException

Throws:

InvalidDataException

ObjectNotFoundException

IOException

getExportCollections

protected String getExportCollections()
                               throws InvalidDataException,
                                      ObjectNotFoundException,
                                      IOException

Throws:

InvalidDataException

ObjectNotFoundException

IOException

toString

public String toString()

Overrides:

toString in class Object