com.ibm.itim.workflow.model
Class ExecutionObject

java.lang.Object
  com.ibm.itim.workflow.model.ExecutionObject

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

Direct Known Subclasses:

Activity, WorkflowProcess

public class ExecutionObject
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable

This class provides general information about an object that is executed by the workflow engine.

See Also:

Serialized Form

Field Summary

static java.lang.String	ABORTED Constant identifying an aborted state.
static java.lang.String	BYPASSED Constant identifying a bypassed state.
static java.lang.String	COMPLETED Constant identifying a completed state.
static short	DEFAULT_PRIORITY
static java.lang.String	NOTSTARTED Constant identifying a not-started state.
static java.lang.String	RUNNING Constant identifying a running state.
static java.lang.String	SUSPENDED Constant identifying a suspended state.
static java.lang.String	TERMINATED Constant identifying a terminated state.

Constructor Summary

ExecutionObject()

Method Summary

int	compareTo(java.lang.Object obj) Compares this object with the specified object for order.
java.lang.String	getDescription() Returns a description of the object.
long	getId() Returns the engine unique ID of the object.
java.util.Date	getLastModified() Returns the last modified time stamp of the object.
java.lang.String	getName() Returns the name of the object.
short	getPriority() Returns the priority of the object.
java.lang.String	getResult() Returns the final result of the object.
java.lang.String	getResultDetail() Returns a more detailed description of the object's final result.
java.lang.String	getState() Returns the state of the object.
java.util.Date	getTimeCompleted() Returns the date/time the object completed.
java.util.Date	getTimeStarted() Returns the date/time the object started.
boolean	isFinished() Returns whether the object's execution has permanently stopped.
void	setDescription(java.lang.String description) Changes the object's description.
void	setId(long id) Changes the object's ID.
void	setLastModified(java.util.Date lastModified) Changes the object's last modified time stamp.
void	setName(java.lang.String name) Changes the object's name.
void	setPriority(short priority) Changes the object's priority.
void	setResult(java.lang.String result) Changes the object's result.
void	setResultDetail(java.lang.String detail) Changes the details of the object's result.
void	setState(java.lang.String state) Changes the object's state.
void	setTimeCompleted(java.util.Date timeCompleted) Changes the object's completion time.
void	setTimeStarted(java.util.Date timeStarted) Changes the object's start time.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RUNNING

public static final java.lang.String RUNNING

Constant identifying a running state.

See Also:

Constant Field Values

NOTSTARTED

public static final java.lang.String NOTSTARTED

Constant identifying a not-started state.

See Also:

Constant Field Values

TERMINATED

public static final java.lang.String TERMINATED

Constant identifying a terminated state.

See Also:

Constant Field Values

ABORTED

public static final java.lang.String ABORTED

Constant identifying an aborted state.

See Also:

Constant Field Values

SUSPENDED

public static final java.lang.String SUSPENDED

Constant identifying a suspended state.

See Also:

Constant Field Values

COMPLETED

public static final java.lang.String COMPLETED

Constant identifying a completed state.

See Also:

Constant Field Values

BYPASSED

public static final java.lang.String BYPASSED

Constant identifying a bypassed state.

See Also:

Constant Field Values

DEFAULT_PRIORITY

public static final short DEFAULT_PRIORITY

See Also:

Constant Field Values

Constructor Detail

ExecutionObject

public ExecutionObject()

Method Detail

getId

public long getId()

Returns the engine unique ID of the object.

Returns:

ID of the object.

getName

public java.lang.String getName()

Returns the name of the object.

Returns:

Name of the object.

getDescription

public java.lang.String getDescription()

Returns a description of the object.

Returns:

Description of the object.

getState

public java.lang.String getState()

Returns the state of the object.

Returns:

State of the object.

getTimeStarted

public java.util.Date getTimeStarted()

Returns the date/time the object started.

Returns:

Date the object started.

getTimeCompleted

public java.util.Date getTimeCompleted()

Returns the date/time the object completed.

Returns:

Date the object completed, null if still executing.

getLastModified

public java.util.Date getLastModified()

Returns the last modified time stamp of the object.

Returns:

Date holding the last modified time stamp.

getResult

public java.lang.String getResult()

Returns the final result of the object.

Returns:

Result of the object.

getResultDetail

public java.lang.String getResultDetail()

Returns a more detailed description of the object's final result.

Returns:

Detailed description of the object's result.

getPriority

public short getPriority()

Returns the priority of the object.

Returns:

priority of the object.

setId

public void setId(long id)

Changes the object's ID.

Parameters:

id - ID of the object.

setPriority

public void setPriority(short priority)

Changes the object's priority.

Parameters:

priority - Priority of the object.

setName

public void setName(java.lang.String name)

Changes the object's name.

Parameters:

name - String name of the object.

setDescription

public void setDescription(java.lang.String description)

Changes the object's description.

Parameters:

description - String description of the object.

setState

public void setState(java.lang.String state)

Changes the object's state.

Parameters:

state - String representing the state of the object.

isFinished

public boolean isFinished()

Returns whether the object's execution has permanently stopped. This is indicated by the object being in one of the following states: TERMINATED, ABORTED, COMPLETED, BYPASSED.

Returns:

True if finished (stopped), false if not.

setTimeStarted

public void setTimeStarted(java.util.Date timeStarted)

Changes the object's start time.

Parameters:

timeStarted - Date representing the object's start time.

setTimeCompleted

public void setTimeCompleted(java.util.Date timeCompleted)

Changes the object's completion time.

Parameters:

timeCompleted - Date representing the object's completion time.

setResult

public void setResult(java.lang.String result)

Changes the object's result.

Parameters:

result - String representing the result of the object.

setResultDetail

public void setResultDetail(java.lang.String detail)

Changes the details of the object's result.

Parameters:

detail - String representing the details of the object's result.

setLastModified

public void setLastModified(java.util.Date lastModified)

Changes the object's last modified time stamp.

Parameters:

lastModified - Date representing the last modified time stamp.

compareTo

public int compareTo(java.lang.Object obj)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object, respectively. NOTE: this method throws a class cast exception if the target object is not the same type as this object.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

obj - the Object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object