org.eclipse.stardust.engine.api.runtime

Interface RuntimeObject

All Superinterfaces:

Serializable

All Known Subinterfaces:

ActivityInstance, ProcessInstance, UserRealm

All Known Implementing Classes:

ProcessInstanceDetails, org.eclipse.stardust.engine.api.dto.RuntimeObjectDetails

public interface RuntimeObject
extends Serializable

The RuntimeObject class is the base class for all snapshots of runtime objects.

Runtime Objects are workflow relevant objects that are created during workflow execution or administration. Runtime objects have a persistent representation in the audit trail database backed up by a dedicated database table. e.g. An ActivityInstance object represents a row in the activity_instance table of the audit trail database.

Snapshots of CARNOT runtime objects are exposed to a client as readonly detail objects which contain a copy of the state of the corresponding server object and maybe additional useful information known to the runtime.

Version:

$Revision$

Author:

ubirkemeyer

See Also:

ActivityInstance, User, ProcessInstance, LogEntry

Method Summary

Methods

Modifier and Type	Method and Description
String	getModelElementID() Returns the ID of the runtime object's definition.
int	getModelElementOID() Returns the OID of the runtime object's definition.
int	getModelOID() Returns the OID of the model the runtime object's definition belongs to.
long	getOID() Gets the OID of this runtime object.

Method Detail

getOID

long getOID()

Gets the OID of this runtime object.

Runtime objects such as process instances, activity instances or users are identified by their object ID (OID). The OIDs of runtime objects are 64-bit integers being unique inside the scope of the runtime object. OID can be used in many places in the API to select an object of a specific type.

Example:

 ActivityInstance activityInstance = ...
 User user = ...
 WorkflowService wfService = ...
 wfService.delegateToUser(activityInstance.getOID(), user.getOID());
 

Returns:

The OID of this runtime object

getModelOID

int getModelOID()

Returns the OID of the model the runtime object's definition belongs to.

Returns:

The OID of this runtime object's definition's model.

See Also:

getModelElementID()

getModelElementOID

int getModelElementOID()

Returns the OID of the runtime object's definition.

Returns:

The OID of this runtime object's definition.

See Also:

getModelOID(), getModelElementID()

getModelElementID

String getModelElementID()

Returns the ID of the runtime object's definition.

Returns:

The ID of this runtime object's definition.

See Also:

getModelOID(), getModelElementOID()