org.eclipse.stardust.engine.api.dto
Class ProcessInstanceDetails

java.lang.Object
  org.eclipse.stardust.engine.api.dto.RuntimeObjectDetails
      org.eclipse.stardust.engine.api.dto.ProcessInstanceDetails

All Implemented Interfaces:

java.io.Serializable, org.eclipse.stardust.engine.api.runtime.IDescriptorProvider, ProcessInstance, RuntimeObject

public class ProcessInstanceDetails
extends org.eclipse.stardust.engine.api.dto.RuntimeObjectDetails
implements ProcessInstance, org.eclipse.stardust.engine.api.runtime.IDescriptorProvider

Many methods of the CARNOT EJBs return detail objects. Detail objects are serializable helper objects passed by value to the client. They can, for instance, pass the necessary information from the audit trail to the embedding application in a dynamic way to guarantee an optimum of performance.

Instances of the class ProcessInstanceDetails are always referring to runtime objects - process instances - and contain data of these runtime objects (e.g. their OID, ID or start timestamp).

Version:

$Revision$

See Also:

Serialized Form

Field Summary

static java.lang.String

PRP_PI_DETAILS_OPTIONS

Fields inherited from interface org.eclipse.stardust.engine.api.runtime.ProcessInstance

UNKNOWN_OID

Fields inherited from interface org.eclipse.stardust.engine.api.runtime.IDescriptorProvider

PRP_DESCRIPTOR_IDS, PRP_PROPVIDE_DESCRIPTORS

Method Summary

ProcessInstanceAttributes	getAttributes() Retrieves extended attributes.
java.util.List<DataPath>	getDescriptorDefinitions()
java.util.Map<java.lang.String,java.lang.Object>	getDescriptors()
java.lang.Object	getDescriptorValue(java.lang.String id)
ProcessInstanceDetailsLevel	getDetailsLevel() Retrieves the level of details for process instance.
java.util.EnumSet<ProcessInstanceDetailsOptions>	getDetailsOptions() Retrieves the options used for details creation for process instance.
java.util.List<HistoricalEvent>	getHistoricalEvents() Gets a list of requested additional data like notes, delegations, state changes and exceptions.
java.util.List<org.eclipse.stardust.engine.api.runtime.ProcessInstanceLink>	getLinkedProcessInstances() Returns process instance links which have this process instance as source or target.
long	getParentProcessInstanceOid() Gets the oid of the parent process instance.
PermissionState	getPermission(java.lang.String permissionId) Returns the permission state of the given permission id for the current user.
int	getPriority() Gets the priority of the process instance.
java.lang.String	getProcessID() Gets ID of this process instance's definition.
java.lang.String	getProcessName() Gets name of this process instance's definition.
long	getRootProcessInstanceOID() Gets the OID of the ultimate root process instance.
java.util.Map<java.lang.String,java.lang.Object>	getRuntimeAttributes()
ProcessInstance	getScopeProcessInstance() Gets the the scope process instance the data values of this process instance are bound to.
long	getScopeProcessInstanceOID() Gets the OID of the scope process instance the data values of this process instance are bound to.
long	getStartingActivityInstanceOID()
User	getStartingUser() Gets the User object of the user that have started the process instance.
java.util.Date	getStartTime() Gets the time when this process instance was created.
ProcessInstanceState	getState() Gets the current state of the process instance.
java.util.Date	getTerminationTime() Gets the time when this process instance was terminated.
boolean	isCaseProcessInstance() Allows to check if the process instance is a case process instance which is used to group other process instances.
void	loadDescriptors(org.eclipse.stardust.engine.core.runtime.beans.IProcessInstance processInstance)
java.lang.String	toString() A human readable representation of basic aspects of this activity instance.

Methods inherited from class org.eclipse.stardust.engine.api.dto.RuntimeObjectDetails

equals, getModelElementID, getModelElementOID, getModelOID, getOID

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.stardust.engine.api.runtime.RuntimeObject

getModelElementID, getModelElementOID, getModelOID, getOID

Field Detail

PRP_PI_DETAILS_OPTIONS

public static final java.lang.String PRP_PI_DETAILS_OPTIONS

See Also:

Constant Field Values

Method Detail

getProcessID

public java.lang.String getProcessID()

Description copied from interface: ProcessInstance

Gets ID of this process instance's definition. Same as RuntimeObject.getModelElementID().

Specified by:

getProcessID in interface ProcessInstance

Returns:

The process ID.

See Also:

ProcessInstance.getProcessName()

getProcessName

public java.lang.String getProcessName()

Description copied from interface: ProcessInstance

Gets name of this process instance's definition.

Specified by:

getProcessName in interface ProcessInstance

Returns:

The process name.

See Also:

ProcessInstance.getProcessID()

getRootProcessInstanceOID

public long getRootProcessInstanceOID()

Description copied from interface: ProcessInstance

Gets the OID of the ultimate root process instance. Same as RuntimeObject.getOID() for top-level processes.

Specified by:

getRootProcessInstanceOID in interface ProcessInstance

Returns:

The OID of the ultimate root process instance of this process instance.

getScopeProcessInstanceOID

public long getScopeProcessInstanceOID()

Description copied from interface: ProcessInstance

Gets the OID of the scope process instance the data values of this process instance are bound to.

Specified by:

getScopeProcessInstanceOID in interface ProcessInstance

Returns:

The OID of the data scope process instance of this process instance. Might be ProcessInstance.UNKNOWN_OID.

getScopeProcessInstance

public ProcessInstance getScopeProcessInstance()

Description copied from interface: ProcessInstance

Gets the the scope process instance the data values of this process instance are bound to.

Specified by:

getScopeProcessInstance in interface ProcessInstance

Returns:

The scope process instance of this process instance. Might be NULL.

getPriority

public int getPriority()

Description copied from interface: ProcessInstance

Gets the priority of the process instance.

Specified by:

getPriority in interface ProcessInstance

Returns:

The priority of the process instance or -1 if no priority set.

getStartTime

public java.util.Date getStartTime()

Description copied from interface: ProcessInstance

Gets the time when this process instance was created.

Specified by:

getStartTime in interface ProcessInstance

Returns:

the creation time.

getTerminationTime

public java.util.Date getTerminationTime()

Description copied from interface: ProcessInstance

Gets the time when this process instance was terminated.

Specified by:

getTerminationTime in interface ProcessInstance

Returns:

the time when the process was completed or aborted, or null if the process is still active.

getStartingUser

public User getStartingUser()

Description copied from interface: ProcessInstance

Gets the User object of the user that have started the process instance.

Specified by:

getStartingUser in interface ProcessInstance

Returns:

the User object of the user.

getState

public ProcessInstanceState getState()

Description copied from interface: ProcessInstance

Gets the current state of the process instance.

Specified by:

getState in interface ProcessInstance

Returns:

the state of the process instance.

getStartingActivityInstanceOID

public long getStartingActivityInstanceOID()

getParentProcessInstanceOid

public long getParentProcessInstanceOid()

Description copied from interface: ProcessInstance

Gets the oid of the parent process instance. This will only be fetched if option ProcessInstanceDetailsOptions.WITH_HIERARCHY_INFO has been set at ProcessInstanceDetailsPolicy.

Specified by:

getParentProcessInstanceOid in interface ProcessInstance

Returns:

oid of parent process instance, might be 0 if this process instance has not been started as synchronous subprocess.
ProcessInstance.UNKNOWN_OID will be returned if an error occurred or details option has not been set.

getDescriptors

public java.util.Map<java.lang.String,java.lang.Object> getDescriptors()

getDescriptorValue

public java.lang.Object getDescriptorValue(java.lang.String id)

Specified by:

getDescriptorValue in interface org.eclipse.stardust.engine.api.runtime.IDescriptorProvider

getDescriptorDefinitions

public java.util.List<DataPath> getDescriptorDefinitions()

Specified by:

getDescriptorDefinitions in interface org.eclipse.stardust.engine.api.runtime.IDescriptorProvider

loadDescriptors

public void loadDescriptors(org.eclipse.stardust.engine.core.runtime.beans.IProcessInstance processInstance)

toString

public java.lang.String toString()

A human readable representation of basic aspects of this activity instance.

It contains:

• The process definition name
• The activity name
• The start time.

e.g. Support Case Management: Create Case (02/09/20 10:10:10)

Overrides:

toString in class java.lang.Object

Returns:

The stringified representation of this activity instance

getDetailsLevel

public ProcessInstanceDetailsLevel getDetailsLevel()

Description copied from interface: ProcessInstance

Retrieves the level of details for process instance.

Specified by:

getDetailsLevel in interface ProcessInstance

Returns:

the process instance details level.

getDetailsOptions

public java.util.EnumSet<ProcessInstanceDetailsOptions> getDetailsOptions()

Description copied from interface: ProcessInstance

Retrieves the options used for details creation for process instance.

Specified by:

getDetailsOptions in interface ProcessInstance

Returns:

the process instance details level.

getAttributes

public ProcessInstanceAttributes getAttributes()

Description copied from interface: ProcessInstance

Retrieves extended attributes. Can return null when details level is not appropriate.

Specified by:

getAttributes in interface ProcessInstance

Returns:

getRuntimeAttributes

public java.util.Map<java.lang.String,java.lang.Object> getRuntimeAttributes()

Specified by:

getRuntimeAttributes in interface ProcessInstance

Returns:

custom runtime attributes not necessarily reflected in the database

getHistoricalEvents

public java.util.List<HistoricalEvent> getHistoricalEvents()

Description copied from interface: ProcessInstance

Gets a list of requested additional data like notes, delegations, state changes and exceptions. This list is sorted in ascending order (oldest first).
The list will be populated depending on HistoricalEventPolicy applied to ProcessInstanceQuery. By default this list will be empty as retrieval might degrade query performance.

Specified by:

getHistoricalEvents in interface ProcessInstance

Returns:

list of all historical events

See Also:

HistoricalEvent, HistoricalEventPolicy

getLinkedProcessInstances

public java.util.List<org.eclipse.stardust.engine.api.runtime.ProcessInstanceLink> getLinkedProcessInstances()

Description copied from interface: ProcessInstance

Returns process instance links which have this process instance as source or target. This will only be fetched if option ProcessInstanceDetailsOptions.WITH_LINK_INFO has been set at ProcessInstanceDetailsPolicy.

Specified by:

getLinkedProcessInstances in interface ProcessInstance

Returns:

the process instances links. Returns an empty list if the details policy was not set on the query or no links exist.

isCaseProcessInstance

public boolean isCaseProcessInstance()

Description copied from interface: ProcessInstance

Allows to check if the process instance is a case process instance which is used to group other process instances.

Specified by:

isCaseProcessInstance in interface ProcessInstance

Returns:

true - if the process instance is a case process instance.
false - if the process instance is not a case process instance.

See Also:

WorkflowService.createCase(String, String, long[]), WorkflowService.joinCase(long, long[]), WorkflowService.leaveCase(long, long[]), WorkflowService.mergeCases(long, long[], String)

getPermission

public PermissionState getPermission(java.lang.String permissionId)

Description copied from interface: ProcessInstance

Returns the permission state of the given permission id for the current user.

Specified by:

getPermission in interface ProcessInstance

Returns:

Granted if the the permission was granted to the user, Denied if the permission was denied to the user or Unknown if the permission is invalid for this process instance.