org.eclipse.stardust.engine.api.runtime
Interface ActivityInstance

All Superinterfaces:

RuntimeObject, java.io.Serializable

public interface ActivityInstance
extends RuntimeObject

The ActivityInstance represents a snapshot of the execution state of an activity instance.

The corresponding runtime object is stored in the activity_instance table of the audit trail database.

Version:

$Revision$

Author:

ubirkemeyer

Method Summary

Activity	getActivity() Gets the workflow activity corresponding to this activity instance.
ActivityInstanceAttributes	getAttributes() Get the ActivityInstanceAttributes
double	getCriticality() Returns the current criticality of an activity instance
ParticipantInfo	getCurrentPerformer() Gets the current Performer of this Activity Instance (or null).
java.util.List<DataPath>	getDescriptorDefinitions() Retrieves definitions for available descriptors.
java.lang.Object	getDescriptorValue(java.lang.String id) Gets the current value of a descriptor with the specified ID.
java.util.List<HistoricalEvent>	getHistoricalEvents() Gets a list of requested additional data like notes, delegations, state changes and exceptions.
java.util.List<HistoricalState>	getHistoricalStates() Gets a list of historical states for the activity instance.
java.util.Date	getLastModificationTime() Gets the time of the most recent modification of this activity instance.
java.lang.String	getParticipantPerformerID() Gets the ID of the current participant performer of this activity instance.
java.lang.String	getParticipantPerformerName() Gets the name of the current participant performer of this activity instance.
UserInfo	getPerformedBy() Returns the user who completed this activity instance.
java.lang.String	getPerformedByName() Gets the name of the user who completed this activity instance.
long	getPerformedByOID() Gets the OID of the user who completed this activity instance.
PermissionState	getPermission(java.lang.String permissionId) Returns the permission state of the given permission id for the current user.
java.lang.String	getProcessDefinitionId() Gets the id of the process definition containing the workflow activity associated with this activity instance.
ProcessInstance	getProcessInstance() Gets the process instance containing this activity instance.
long	getProcessInstanceOID() Gets the OID of the process instance containing this activity instance.
QualityAssuranceInfo	getQualityAssuranceInfo() Gets information about the performed quality assurance workflow
org.eclipse.stardust.engine.api.runtime.QualityAssuranceUtils.QualityAssuranceState	getQualityAssuranceState() Gets the state of this activity instance regarding quality assurance
java.util.Date	getStartTime() Gets the time of the creation of this activity instance.
ActivityInstanceState	getState() Gets the current state of this activity instance.
User	getUserPerformer() Gets the current User Object of this activity instance.
java.lang.String	getUserPerformerName() Gets the name of the current user performer of this activity instance.
long	getUserPerformerOID() Gets the OID of the current user performer of this activity instance.
boolean	isAssignedToModelParticipant() Gets whether the current performer of this activity instance is a model participant.
boolean	isAssignedToUser() Gets whether the current performer of this activity instance is a user.
boolean	isAssignedToUserGroup() Gets whether the current performer of this activity instance is a user group.
boolean	isScopeProcessInstanceNoteAvailable() Gets whether a note for the scope process instance of this activity instance is available.

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

getModelElementID, getModelElementOID, getModelOID, getOID

Method Detail

getQualityAssuranceInfo

QualityAssuranceInfo getQualityAssuranceInfo()

Gets information about the performed quality assurance workflow

Returns:

information about the performed quality assurance workflow or null if this is a not quality assurance enabled instance

getQualityAssuranceState

org.eclipse.stardust.engine.api.runtime.QualityAssuranceUtils.QualityAssuranceState getQualityAssuranceState()

Gets the state of this activity instance regarding quality assurance

Returns:

the QualityAssuranceUtils.QualityAssuranceState this instance is in

getAttributes

ActivityInstanceAttributes getAttributes()

Get the ActivityInstanceAttributes

Returns:

the ActivityInstanceAttributes for this activity instance

getState

ActivityInstanceState getState()

Gets the current state of this activity instance.

Returns:

the state of this activity instance.

getStartTime

java.util.Date getStartTime()

Gets the time of the creation of this activity instance.

Returns:

the time when the activity instance has been instantiated.

getLastModificationTime

java.util.Date getLastModificationTime()

Gets the time of the most recent modification of this activity instance.

An activity instance is considered modified if it's state has changed.

Returns:

The last modification time of this activity instance.

See Also:

getState()

getActivity

Activity getActivity()

Gets the workflow activity corresponding to this activity instance.

Returns:

the workflow activity.

getProcessDefinitionId

java.lang.String getProcessDefinitionId()

Gets the id of the process definition containing the workflow activity associated with this activity instance.

See Also:

ProcessDefinition

getProcessInstanceOID

long getProcessInstanceOID()

Gets the OID of the process instance containing this activity instance.

Returns:

the OID of the parent process instance

getProcessInstance

ProcessInstance getProcessInstance()

Gets the process instance containing this activity instance. If the user does not have the permission to read the process instance (declarative security) then this method returns null.

Returns:

the process instance initialized with ProcessInstanceDetailsLevel.Core of the activity instance

getUserPerformerOID

long getUserPerformerOID()

Gets the OID of the current user performer of this activity instance.

Returns:

the OID of the user or 0 if not assigned to a user.

See Also:

isAssignedToUser()

getUserPerformerName

java.lang.String getUserPerformerName()

Gets the name of the current user performer of this activity instance.

Returns:

the name of the user or null if not assigned to a user.

See Also:

isAssignedToUser()

getUserPerformer

User getUserPerformer()

Gets the current User Object of this activity instance.

Returns:

the User object or null if not assigned to a user.

See Also:

isAssignedToUser()

getParticipantPerformerID

java.lang.String getParticipantPerformerID()

Gets the ID of the current participant performer of this activity instance.

Returns:

the ID of the performer or null if assigned to a user.

See Also:

isAssignedToUser()

getParticipantPerformerName

java.lang.String getParticipantPerformerName()

Gets the name of the current participant performer of this activity instance.

Returns:

the name of the performer or null if assigned to a user.

See Also:

isAssignedToUser()

isAssignedToUser

boolean isAssignedToUser()

Gets whether the current performer of this activity instance is a user.

Returns:

true, if the current performer is a user.

See Also:

isAssignedToModelParticipant(), isAssignedToUserGroup()

isAssignedToModelParticipant

boolean isAssignedToModelParticipant()

Gets whether the current performer of this activity instance is a model participant.

Returns:

true, if the current performer is a model participant.

See Also:

isAssignedToUser(), isAssignedToUserGroup()

isAssignedToUserGroup

boolean isAssignedToUserGroup()

Gets whether the current performer of this activity instance is a user group.

Returns:

true, if the current performer is a user group.

See Also:

isAssignedToUser(), isAssignedToModelParticipant()

getCurrentPerformer

ParticipantInfo getCurrentPerformer()

Gets the current Performer of this Activity Instance (or null). Can be a user group, a user or model participant.

Returns:

The current performer.

getPerformedByOID

long getPerformedByOID()

Gets the OID of the user who completed this activity instance.

Returns:

the OID of the user, or 0 if this activity instance is not yet completed.

getPerformedByName

java.lang.String getPerformedByName()

Gets the name of the user who completed this activity instance.

Returns:

the name of the user, or null if this activity instance is not yet completed.

getPerformedBy

UserInfo getPerformedBy()

Returns the user who completed this activity instance.

Returns:

The user who completed this activity instance.

getDescriptorValue

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

Gets the current value of a descriptor with the specified ID.

Parameters:

id - the id of the descriptor.

Returns:

the value of the descriptor.

getDescriptorDefinitions

java.util.List<DataPath> getDescriptorDefinitions()

Retrieves definitions for available descriptors.

Returns:

the descriptor definitions that are available.

isScopeProcessInstanceNoteAvailable

boolean isScopeProcessInstanceNoteAvailable()

Gets whether a note for the scope process instance of this activity instance is available.

Returns:

true, if note is available for scope process instance.

getHistoricalStates

java.util.List<HistoricalState> getHistoricalStates()

Gets a list of historical states for the activity instance. This list is sorted in descending order (latest state first).

Returns:

the list of historical states.

getHistoricalEvents

java.util.List<HistoricalEvent> getHistoricalEvents()

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 ActivityInstanceQuery and WorklistQuery. By default this list will be empty as retrieval might degrade query performance.

Returns:

list of all historical events

See Also:

HistoricalEvent, HistoricalEventPolicy

getPermission

PermissionState getPermission(java.lang.String permissionId)

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

Parameters:

permissionId -

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 activity instance.

getCriticality

double getCriticality()

Returns the current criticality of an activity instance

Returns:

the value if the criticality