Package org.cristalise.kernel.events

Class Event

java.lang.Object

org.cristalise.kernel.events.Event

All Implemented Interfaces:

C2KLocalObject

public class Event
extends Object
implements C2KLocalObject

The data structure of events, which are passed over the event service. Events are incrementally numbered objects maintained by the History.
Events are generated and stored whenever a step in an Item's lifecycle changes state, and provide a full record of what was done, when, and by whom.

Constructor Summary

Constructors

Constructor	Description
Event()
Event(Integer id, ItemPath itemPath, AgentPath agentPath, String agentRole, String stepName, String stepPath, String stepType, String smName, Integer smVersion, int transitionId, int originState, int targetState, String schemaName, Integer schemaVersion, String viewName, boolean hasAttachment, GTimeStamp ts)	Constructor for recreating object from backend
Event(Integer id, ItemPath itemPath, AgentPath agentPath, String agentRole, String stepName, String stepPath, String stepType, String smName, Integer smVersion, int transitionId, int originState, int targetState, String schemaName, Integer schemaVersion, String viewName, GTimeStamp ts)	Constructor for recreating object from backend
Event(ItemPath itemPath, AgentPath agentPath, String agentRole, String stepName, String stepPath, String stepType, StateMachine stateMachine, int transitionId)
Event(ItemPath itemPath, AgentPath agentPath, String agentRole, String stepName, String stepPath, String stepType, StateMachine stateMachine, int transitionId, boolean hasAttachment)

Method Summary

Modifier and Type	Method	Description
void	addOutcomeDetails(Schema schema, String viewName)
String	getAgentUUID()
String	getClusterPath()	Each C2KLocalObject is stored with a path identifier starting with the ClusterType: DomainPath: /Path/Domain/Name ItemPath: /Path/Item AgentPath: /Path/Agent RolePath: /Path/Role/Name 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
boolean	getHasAttachment()
String	getItemUUID()
String	getTimeString()	Return the TimeStamp in a form that will convert nicely to a String: YYYY-MM-DD HH:MI:SS
void	setAgentUUID(String uuid)
void	setHasAttachment(boolean flag)
void	setID(Integer id)
void	setItemUUID(String uuid)
void	setName(String name)	Sets the name of the C2KLocalObject
void	setTimeString(String time)
void	setViewName(String viewName)	Set the ViewName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getName

Constructor Details

Event

public Event(ItemPath itemPath,
 AgentPath agentPath,
 String agentRole,
 String stepName,
 String stepPath,
 String stepType,
 StateMachine stateMachine,
 int transitionId)

Event

public Event(ItemPath itemPath,
 AgentPath agentPath,
 String agentRole,
 String stepName,
 String stepPath,
 String stepType,
 StateMachine stateMachine,
 int transitionId,
 boolean hasAttachment)

Event

public Event(Integer id,
 ItemPath itemPath,
 AgentPath agentPath,
 String agentRole,
 String stepName,
 String stepPath,
 String stepType,
 String smName,
 Integer smVersion,
 int transitionId,
 int originState,
 int targetState,
 String schemaName,
 Integer schemaVersion,
 String viewName,
 GTimeStamp ts)

Constructor for recreating object from backend

Event

public Event(Integer id,
 ItemPath itemPath,
 AgentPath agentPath,
 String agentRole,
 String stepName,
 String stepPath,
 String stepType,
 String smName,
 Integer smVersion,
 int transitionId,
 int originState,
 int targetState,
 String schemaName,
 Integer schemaVersion,
 String viewName,
 boolean hasAttachment,
 GTimeStamp ts)

Constructor for recreating object from backend

Event

public Event()

Method Details

setID

public void setID(Integer id)

setItemUUID

public void setItemUUID(String uuid)
                 throws InvalidItemPathException

Throws:

InvalidItemPathException

getItemUUID

public String getItemUUID()

setAgentUUID

public void setAgentUUID(String uuid)
                  throws InvalidItemPathException

Throws:

InvalidItemPathException

getAgentUUID

public String getAgentUUID()

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

getTimeString

public String getTimeString()

Return the TimeStamp in a form that will convert nicely to a String: YYYY-MM-DD HH:MI:SS

Returns:

Return the formatted TimeStamp

setTimeString

public void setTimeString(String time)
                   throws InvalidDataException

Throws:

InvalidDataException

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:

• DomainPath: /Path/Domain/Name
• ItemPath: /Path/Item
• AgentPath: /Path/Agent
• RolePath: /Path/Role/Name
• 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

addOutcomeDetails

public void addOutcomeDetails(Schema schema,
 String viewName)

setViewName

public void setViewName(String viewName)

Set the ViewName

Parameters:

viewName - name of the view or 'last if viewName is blank

setHasAttachment

public void setHasAttachment(boolean flag)

getHasAttachment

public boolean getHasAttachment()