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 incrementaly numbered objects maintained by the History.

Version:

$Revision: 1.13 $ $Date: 2004/11/22 09:12:28 $

Author:

$Author: abranson $

Constructor Summary

Constructors

Constructor and Description
Event()
Event(ItemPath itemPath, AgentPath agentPath, AgentPath delegatePath, String agentRole, String stepName, String stepPath, String stepType, StateMachine stateMachine, int transitionId)

Method Summary

Methods

Modifier and Type	Method and Description
void	addOutcomeDetails(Schema schema, String viewName)
AgentPath	getAgentPath() Return the AgentInfo of the Event.
String	getAgentRole()
String	getAgentUUID()
String	getClusterType()
AgentPath	getDelegatePath()
static GTimeStamp	getGMT()
Integer	getID() Return the Event's ID
ItemPath	getItemPath()
String	getItemUUID()
String	getName() Return the Event Name
int	getOriginState()
String	getSchemaName()
Integer	getSchemaVersion()
String	getStateMachineName()
Integer	getStateMachineVersion()
String	getStepName() Return the StepPath of the Event.
String	getStepPath() Return the StepPath of the Event.
String	getStepType() Return the StepPath of the Event.
int	getTargetState()
GTimeStamp	getTimeStamp() Return the Event's TimeStamp.
String	getTimeString() Return the TimeStamp in a form that will convert nicely to a String YYYY-MM-DD HH:MI:SS
int	getTransition()
String	getViewName()
void	setAgentPath(AgentPath agentPath) Set the AgentInfo in the Event, in parameter is an AgentInfo
void	setAgentRole(String agentRole)
void	setAgentUUID(String uuid)
void	setDelegatePath(AgentPath delegatorPath)
void	setID(Integer id)
void	setItemPath(ItemPath itemPath)
void	setItemUUID(String uuid)
void	setName(String name) Set the Event Name, in parameter is a String
void	setOriginState(int originState)
void	setSchemaName(String schemaName)
void	setSchemaVersion(Integer schemaVersion)
void	setStateMachineName(String stateMachineName)
void	setStateMachineVersion(Integer stateMachineVersion)
void	setStepName(String name) Set the StepPath of the Event, in parameter is a String
void	setStepPath(String path) Set the StepPath of the Event, in parameter is a String
void	setStepType(String type) Set the StepType of the Event, in parameter is a String
void	setTargetState(int targetState)
void	setTimeStamp(GTimeStamp inTimeStamp) Set the TimeStamp in the Event, in parameter is an GTimeStamp
void	setTimeString(String time)
void	setTransition(int i)
void	setViewName(String viewName)
static String	timeToString(GTimeStamp timeStamp)

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

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

Event

public Event()

Method Detail

getOriginState

public int getOriginState()

setOriginState

public void setOriginState(int originState)

getTargetState

public int getTargetState()

setTargetState

public void setTargetState(int targetState)

getStateMachineVersion

public Integer getStateMachineVersion()

setStateMachineVersion

public void setStateMachineVersion(Integer stateMachineVersion)

getStateMachineName

public String getStateMachineName()

setStateMachineName

public void setStateMachineName(String stateMachineName)

setID

public void setID(Integer id)

setItemPath

public void setItemPath(ItemPath itemPath)

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)

Set the Event Name, in parameter is a String

Specified by:

setName in interface C2KLocalObject

setStepName

public void setStepName(String name)

Set the StepPath of the Event, in parameter is a String

setStepPath

public void setStepPath(String path)

Set the StepPath of the Event, in parameter is a String

setStepType

public void setStepType(String type)

Set the StepType of the Event, in parameter is a String

setViewName

public void setViewName(String viewName)

Parameters:

viewName - the viewName to set

setAgentPath

public void setAgentPath(AgentPath agentPath)

Set the AgentInfo in the Event, in parameter is an AgentInfo

setDelegatePath

public void setDelegatePath(AgentPath delegatorPath)

setAgentRole

public void setAgentRole(String agentRole)

setTimeStamp

public void setTimeStamp(GTimeStamp inTimeStamp)

Set the TimeStamp in the Event, in parameter is an GTimeStamp

getID

public Integer getID()

Return the Event's ID

getItemPath

public ItemPath getItemPath()

getName

public String getName()

Return the Event Name

Specified by:

getName in interface C2KLocalObject

getStepName

public String getStepName()

Return the StepPath of the Event.

getStepPath

public String getStepPath()

Return the StepPath of the Event.

getStepType

public String getStepType()

Return the StepPath of the Event.

getViewName

public String getViewName()

Returns:

the mViewName

getAgentPath

public AgentPath getAgentPath()

Return the AgentInfo of the Event.

getDelegatePath

public AgentPath getDelegatePath()

getAgentRole

public String getAgentRole()

getTimeStamp

public GTimeStamp getTimeStamp()

Return the Event's TimeStamp.

getTimeString

public String getTimeString()

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

timeToString

public static String timeToString(GTimeStamp timeStamp)

setTimeString

public void setTimeString(String time)
                   throws InvalidDataException

Throws:

InvalidDataException

getGMT

public static GTimeStamp getGMT()

getClusterType

public String getClusterType()

Specified by:

getClusterType in interface C2KLocalObject

See Also:

C2KLocalObject.getClusterType()

getTransition

public int getTransition()

Returns:

setTransition

public void setTransition(int i)

Parameters:

i -

getSchemaVersion

public Integer getSchemaVersion()

setSchemaVersion

public void setSchemaVersion(Integer schemaVersion)

getSchemaName

public String getSchemaName()

setSchemaName

public void setSchemaName(String schemaName)

addOutcomeDetails

public void addOutcomeDetails(Schema schema,
                     String viewName)