com.ibm.itim.workflow.model
Class ExecutionEntity

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

Direct Known Subclasses:

ActivityEntity, WorkflowProcessEntity

public abstract class ExecutionEntity
extends java.lang.Object

Class that provides management capabilities for an executable object within the workflow engine, such as processes and activities.

Constructor Summary

ExecutionEntity()

Method Summary

void	auditEvent(EventAudit event) Places the given event in the audit trail (history) of the execution object.
abstract java.util.List	getHistory() Returns the history, or the audit trail for this execution object.
long	getId() Returns the ID of the object.
ExecutionObject	getValueObject() Returns the value object holding details about this entity.
void	setValueObject(ExecutionObject valueObject) Changes the value object holding details about this entity.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionEntity

public ExecutionEntity()

Method Detail

getId

public long getId()

Returns the ID of the object.

Returns:

ID of the object.

getHistory

public abstract java.util.List getHistory()
                                   throws WorkflowException

Returns the history, or the audit trail for this execution object. The history is made up of a sequential list of audit records (EventAudit objects).

Returns:

List of EventAudit objects that represent the object's history.

Throws:

WorkflowException - Thrown if an error was encountered trying to retrieve the history.

auditEvent

public void auditEvent(EventAudit event)
                throws WorkflowException

Places the given event in the audit trail (history) of the execution object.

Parameters:

event - EventAudit representing the audited event.

Throws:

WorkflowException - Thrown if an error was encountered trying to audit the event.

getValueObject

public ExecutionObject getValueObject()

Returns the value object holding details about this entity.

Returns:

ExecutionObject value object.

setValueObject

public void setValueObject(ExecutionObject valueObject)

Changes the value object holding details about this entity.

Parameters:

valueObject - ExecutionObject value object.