org.cristalise.kernel.entity.agent

Class Job

java.lang.Object

org.cristalise.kernel.entity.agent.Job

All Implemented Interfaces:

C2KLocalObject

public class Job
extends Object
implements C2KLocalObject

Constructor Summary

Constructors

Constructor and Description
Job() Empty constructor required for Castor
Job(Activity act, ItemPath itemPath, Transition transition, AgentPath agent, AgentPath delegate, String role) Main constructor to create Job during workflow enactment
Job(int id, ItemPath itemPath, String stepName, String stepPath, String stepType, Transition transition, String originStateName, String targetStateName, String agentRole, AgentPath agentPath, AgentPath delegatePath, CastorHashMap actProps, GTimeStamp creationDate) Constructor for recreating Job from backend

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
Object	getActProp(BuiltInVertexProperties name)
Object	getActProp(BuiltInVertexProperties name, Object defaultValue)
Object	getActProp(String name)
Object	getActProp(String name, Object defaultValue)
String	getActPropString(BuiltInVertexProperties name)
String	getActPropString(String name)
String	getAgentName()
String	getAgentUUID() Used by castor to marshall to XML
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 ClusterStorage
String	getDelegateName()
String	getDescription()
ItemProxy	getItem()
ItemProxy	getItemProxy()
String	getItemUUID()
KeyValuePair[]	getKeyValuePairs()
Outcome	getLastOutcome() Returns the Outcome instance associated with the 'last' Viewpoint
String	getLastView() Returns the Outcome string associated with the 'last' Viewpoint
String	getName() Gets the name of the C2KLocalObject
Outcome	getOutcome() Returns the Outcome if exists otherwise tries to read and duplicate the Outcome of 'last' ViewPoint.
OutcomeInitiator	getOutcomeInitiator() Retrieve the OutcomeInitiator associated with this Job.
String	getOutcomeString() Returns the Outcome string.
Query	getQuery()
Schema	getSchema()
String	getSchemaName() Deprecated.
int	getSchemaVersion() Deprecated.
Script	getScript()
String	getScriptName() Deprecated.
int	getScriptVersion() Deprecated.
Transition	getTransition()
String	getValidViewpointName() Checks the value of the 'Viewpoint' ActivityProperty and return 'last' if value is blank or starts with 'xpath:'.
int	hashCode()
boolean	hasOutcome()
boolean	hasQuery()
boolean	hasScript()
boolean	isOutcomeRequired()
boolean	isOutcomeSet()
Map<String,Object>	matchActPropNames(String pattern) Searches Activity property names using String.startsWith(String) method
void	setActProp(BuiltInVertexProperties prop, Object value)
void	setActProp(String name, Object value)
void	setAgentUUID(String uuid) Used by castor to unmarshall from XML
void	setError(ErrorInfo errors)
void	setItemPath(ItemPath path)
void	setItemUUID(String uuid)
void	setKeyValuePairs(KeyValuePair[] pairs)
void	setName(String name) Sets the name of the C2KLocalObject
void	setOutcome(Outcome o)
void	setOutcome(String outcomeData)
void	setTransition(Transition transition)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

enforceValidName

Constructor Detail

Job

public Job()

Empty constructor required for Castor

Job

public Job(Activity act,
           ItemPath itemPath,
           Transition transition,
           AgentPath agent,
           AgentPath delegate,
           String role)
    throws InvalidDataException,
           ObjectNotFoundException,
           InvalidAgentPathException

Main constructor to create Job during workflow enactment

Throws:

InvalidDataException

ObjectNotFoundException

InvalidAgentPathException

Job

public Job(int id,
           ItemPath itemPath,
           String stepName,
           String stepPath,
           String stepType,
           Transition transition,
           String originStateName,
           String targetStateName,
           String agentRole,
           AgentPath agentPath,
           AgentPath delegatePath,
           CastorHashMap actProps,
           GTimeStamp creationDate)

Constructor for recreating Job from backend

Method Detail

setItemPath

public void setItemPath(ItemPath path)

setItemUUID

public void setItemUUID(String uuid)
                 throws InvalidItemPathException

Throws:

InvalidItemPathException

getItemUUID

public String getItemUUID()

getItem

public ItemProxy getItem()
                  throws InvalidDataException

Throws:

InvalidDataException

getTransition

public Transition getTransition()

setTransition

public void setTransition(Transition transition)

setAgentUUID

public void setAgentUUID(String uuid)
                  throws InvalidItemPathException

Used by castor to unmarshall from XML

Parameters:

uuid - the string representation of UUID

Throws:

InvalidItemPathException - Cannot set UUID of agent and delegate from parameter

getAgentUUID

public String getAgentUUID()

Used by castor to marshall to XML

Returns:

The stringified UUID of Agent concatenated with ':' and UUID of Delegate if exists

getAgentName

public String getAgentName()

getDelegateName

public String getDelegateName()

getSchema

public Schema getSchema()
                 throws InvalidDataException,
                        ObjectNotFoundException

Throws:

InvalidDataException

ObjectNotFoundException

getSchemaName

@Deprecated
public String getSchemaName()
                                 throws InvalidDataException,
                                        ObjectNotFoundException

Deprecated.

Throws:

InvalidDataException

ObjectNotFoundException

getSchemaVersion

@Deprecated
public int getSchemaVersion()
                                 throws InvalidDataException,
                                        ObjectNotFoundException

Deprecated.

Throws:

InvalidDataException

ObjectNotFoundException

isOutcomeRequired

public boolean isOutcomeRequired()

getScript

public Script getScript()
                 throws ObjectNotFoundException,
                        InvalidDataException

Throws:

ObjectNotFoundException

InvalidDataException

getQuery

public Query getQuery()
               throws ObjectNotFoundException,
                      InvalidDataException

Throws:

ObjectNotFoundException

InvalidDataException

getScriptName

@Deprecated
public String getScriptName()

Deprecated.

getScriptVersion

@Deprecated
public int getScriptVersion()
                                 throws InvalidDataException

Deprecated.

Throws:

InvalidDataException

getKeyValuePairs

public KeyValuePair[] getKeyValuePairs()

setKeyValuePairs

public void setKeyValuePairs(KeyValuePair[] pairs)

getName

public String getName()

Description copied from interface: C2KLocalObject

Gets the name of the C2KLocalObject

Specified by:

getName in interface C2KLocalObject

Returns:

name of the C2KLocalObject

setName

public void setName(String name)

Description copied from interface: C2KLocalObject

Sets the name of the C2KLocalObject

Specified by:

setName in interface C2KLocalObject

Parameters:

name - Name of the C2KLocalObject

getItemProxy

public ItemProxy getItemProxy()
                       throws ObjectNotFoundException,
                              InvalidItemPathException

Throws:

ObjectNotFoundException

InvalidItemPathException

getDescription

public String getDescription()

setOutcome

public void setOutcome(String outcomeData)
                throws InvalidDataException,
                       ObjectNotFoundException

Throws:

InvalidDataException

ObjectNotFoundException

setOutcome

public void setOutcome(Outcome o)

setError

public void setError(ErrorInfo errors)

getValidViewpointName

public String getValidViewpointName()

Checks the value of the 'Viewpoint' ActivityProperty and return 'last' if value is blank or starts with 'xpath:'. In all other cases it returns its value.

Returns:

the 'calculated' Viewpoint name

getLastOutcome

public Outcome getLastOutcome()
                       throws InvalidDataException,
                              ObjectNotFoundException

Returns the Outcome instance associated with the 'last' Viewpoint

Returns:

Outcome instance

Throws:

InvalidDataException - inconsistent data or persistency issue

ObjectNotFoundException - Schema or Outcome was not found

getLastView

public String getLastView()
                   throws InvalidDataException,
                          ObjectNotFoundException

Returns the Outcome string associated with the 'last' Viewpoint

Returns:

XML data of the last version of Outcome

Throws:

InvalidDataException - inconsistent data or persistency issue

ObjectNotFoundException - Schema or Outcome was not found

getOutcomeInitiator

public OutcomeInitiator getOutcomeInitiator()
                                     throws InvalidDataException

Retrieve the OutcomeInitiator associated with this Job.

Returns:

the configured OutcomeInitiator

Throws:

InvalidDataException - OutcomeInitiator could not be created

See Also:

BuiltInVertexProperties.OUTCOME_INIT

getOutcomeString

public String getOutcomeString()
                        throws InvalidDataException,
                               ObjectNotFoundException

Returns the Outcome string. It is based on getOutcome()

Returns:

the Outcome xml or null

Throws:

InvalidDataException - inconsistent data

ObjectNotFoundException

getOutcome

public Outcome getOutcome()
                   throws InvalidDataException,
                          ObjectNotFoundException

Returns the Outcome if exists otherwise tries to read and duplicate the Outcome of 'last' ViewPoint. If that does not exists it tries to use an OutcomeInitiator.

Returns:

the Outcome object or null

Throws:

InvalidDataException - inconsistent data

ObjectNotFoundException - Schema was not found

hasOutcome

public boolean hasOutcome()

hasScript

public boolean hasScript()

hasQuery

public boolean hasQuery()

isOutcomeSet

public boolean isOutcomeSet()

getClusterType

public ClusterType getClusterType()

Description copied from interface: C2KLocalObject

Each object belongs to a specific type defined in ClusterStorage

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

getActProp

public Object getActProp(String name)

getActProp

public Object getActProp(String name,
                         Object defaultValue)

getActProp

public Object getActProp(BuiltInVertexProperties name)

getActProp

public Object getActProp(BuiltInVertexProperties name,
                         Object defaultValue)

getActPropString

public String getActPropString(String name)

setActProp

public void setActProp(BuiltInVertexProperties prop,
                       Object value)

setActProp

public void setActProp(String name,
                       Object value)

getActPropString

public String getActPropString(BuiltInVertexProperties name)

matchActPropNames

public Map<String,Object> matchActPropNames(String pattern)

Searches Activity property names using String.startsWith(String) method

Parameters:

pattern - the pattern to be matched

Returns:

Map of property name and value

toString

public String toString()

Overrides:

toString in class Object