org.eclipse.stardust.engine.api.dto

Interface HistoricalState

All Superinterfaces:

Serializable

public interface HistoricalState
extends Serializable

The HistoricalState represents a snapshot of the historic states of an activity instance.

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

Version:

$Revision$

Author:

born

Method Summary

Methods

Modifier and Type	Method and Description
String	getActivityId() Gets the ID workflow activity corresponding to this activity instance historic state.
long	getActivityInstanceOID() Gets the OID of the workflow activity corresponding to this activity instance historic state.
Date	getFrom() Gets the start time for the period the state was set.
Participant	getOnBehalfOf() Deprecated. Superseded by getOnBehalfOfParticipant()
ParticipantInfo	getOnBehalfOfParticipant() Gets the participant on whose worklist the activity instance has been when it was activated.
UserInfo	getOnBehalfOfUser() Gets the user on behalf of which the activity state changed.
ParticipantInfo	getParticipant() Gets the participant on whose worklist the activity instance was in the period.
Participant	getPerfomer() Deprecated. Superseded by getParticipant()
String	getProcessDefinitionId() Gets the id of the process definition containing the workflow activity associated with this activity instance historic state.
long	getProcessInstanceOID() Gets the OID of the process instance containing this activity instance historic state.
ActivityInstanceState	getState() Gets the historic state for the corresponding activity instance.
Date	getUntil() Gets the end time for the period the state was set.
User	getUser() Gets the workflow user who changed the state or worklist of the activity instance.

Method Detail

getProcessDefinitionId

String getProcessDefinitionId()

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

See Also:

ProcessDefinition

getProcessInstanceOID

long getProcessInstanceOID()

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

Returns:

the OID of the parent process instance

getActivityId

String getActivityId()

Gets the ID workflow activity corresponding to this activity instance historic state.

Returns:

the ID of the workflow activity.

getActivityInstanceOID

long getActivityInstanceOID()

Gets the OID of the workflow activity corresponding to this activity instance historic state.

Returns:

the OID of the parent process instance

getState

ActivityInstanceState getState()

Gets the historic state for the corresponding activity instance.

Returns:

the state of the corresponding activity instance.

getFrom

Date getFrom()

Gets the start time for the period the state was set.

Returns:

the start time of the period

See Also:

getState()

getUntil

Date getUntil()

Gets the end time for the period the state was set.

Returns:

the end time of the period

See Also:

getState()

getPerfomer

@Deprecated
Participant getPerfomer()

Deprecated. Superseded by getParticipant()

Gets the participant on whose worklist the activity instance was in the period.

Returns:

the participant of the worklist.

getParticipant

ParticipantInfo getParticipant()

Gets the participant on whose worklist the activity instance was in the period.

Returns:

the participant of the worklist.

getOnBehalfOf

@Deprecated
Participant getOnBehalfOf()

Deprecated. Superseded by getOnBehalfOfParticipant()

Gets the participant on whose worklist the activity instance has been when it was activated.

Returns:

the participant of the worklist before the activity instance was activated.

getOnBehalfOfParticipant

ParticipantInfo getOnBehalfOfParticipant()

Gets the participant on whose worklist the activity instance has been when it was activated.

Returns:

the participant of the worklist before the activity instance was activated.

getOnBehalfOfUser

UserInfo getOnBehalfOfUser()

Gets the user on behalf of which the activity state changed.

Returns:

the user on behalf of which the activity state changed.

getUser

User getUser()

Gets the workflow user who changed the state or worklist of the activity instance.

Returns:

the workflow user who changed the state.