com.adobe.idp.taskmanager.dsc.client.query
Interface ProcessInstanceRow

All Superinterfaces:

java.io.Serializable

public interface ProcessInstanceRow
extends java.io.Serializable

A ProcessInstanceRow object contains a row of data pertaining to a particular process instance.

Field Summary

static short	STATUS_COMPLETED The process instance has completed.
static short	STATUS_COMPLETING Indicates that the process instance is about to complete
static short	STATUS_INITIATED The process instance has been initiated.
static short	STATUS_RUNNING The process instance is currently running.
static short	STATUS_SUSPENDED The process instance has been suspended.
static short	STATUS_SUSPENDING The process instance is about to be suspended.
static short	STATUS_TERMINATED The process instance was terminated before all operations in the process were completed.
static short	STATUS_TERMINATING The process instance is about to be terminated.
static short	STATUS_UNSUSPENDING The process instance is about to be unsuspended.

Method Summary

java.lang.String	getDescription() Retrieves the process description.
java.lang.String	getInitiator() Retrieves the name of the person that initiated the process.
java.lang.String	getInitiatorId() Retrieves the identifier of the person that initiated the process.
java.lang.String	getInvocationId() Retrieves the long lived invocation id for this process instance, if applicable.
java.util.Date	getProcessCompleteTime() Retrieves the time at which the process instance was completed.
long	getProcessInstanceId() Retrieves a unique identifier for the process instance.
short	getProcessInstanceStatus() Retrieves the current status for the process instance.
java.lang.String	getProcessName() Retrieves the name of a process.
java.util.Date	getProcessStartTime() Retrieves the time at which the process instance was started.
java.util.List	getProcessVariables() Retrieves a list of visible process variables.

Field Detail

STATUS_INITIATED

static final short STATUS_INITIATED

The process instance has been initiated.

See Also:

Constant Field Values

STATUS_RUNNING

static final short STATUS_RUNNING

The process instance is currently running.

See Also:

Constant Field Values

STATUS_COMPLETED

static final short STATUS_COMPLETED

The process instance has completed.

See Also:

Constant Field Values

STATUS_COMPLETING

static final short STATUS_COMPLETING

Indicates that the process instance is about to complete

See Also:

Constant Field Values

STATUS_TERMINATED

static final short STATUS_TERMINATED

The process instance was terminated before all operations in the process were completed.

See Also:

Constant Field Values

STATUS_TERMINATING

static final short STATUS_TERMINATING

The process instance is about to be terminated.

See Also:

Constant Field Values

STATUS_SUSPENDED

static final short STATUS_SUSPENDED

The process instance has been suspended.

See Also:

Constant Field Values

STATUS_SUSPENDING

static final short STATUS_SUSPENDING

The process instance is about to be suspended.

See Also:

Constant Field Values

STATUS_UNSUSPENDING

static final short STATUS_UNSUSPENDING

The process instance is about to be unsuspended.

See Also:

Constant Field Values

Method Detail

getProcessName

java.lang.String getProcessName()

Retrieves the name of a process.

Returns:

The process name.

getProcessStartTime

java.util.Date getProcessStartTime()

Retrieves the time at which the process instance was started.

Returns:

A Date object containing the process instance start time.

getProcessCompleteTime

java.util.Date getProcessCompleteTime()

Retrieves the time at which the process instance was completed.

Returns:

A Date object containing the process instance complete time.

getProcessInstanceStatus

short getProcessInstanceStatus()

Retrieves the current status for the process instance. The following status values are associated with the returned numeric values:

• ProcessInstanceRow.STATUS_INITIATED
• ProcessInstanceRow.STATUS_RUNNING
• ProcessInstanceRow.STATUS_COMPLETED
• ProcessInstanceRow.STATUS_COMPLETING
• ProcessInstanceRow.STATUS_TERMINATED
• ProcessInstanceRow.STATUS_TERMINATING
• ProcessInstanceRow.STATUS_SUSPENDED
• ProcessInstanceRow.STATUS_SUSPENDING
• ProcessInstanceRow.STATUS_UNSUSPENDING

Returns:

The process instance status.

getProcessInstanceId

long getProcessInstanceId()

Retrieves a unique identifier for the process instance.

Returns:

The process instance identifier.

getInvocationId

java.lang.String getInvocationId()

Retrieves the long lived invocation id for this process instance, if applicable.

Returns:

The long lived invocation id for this process instance.

getProcessVariables

java.util.List getProcessVariables()

Retrieves a list of visible process variables.

Returns:

A list of visible process variables.

getInitiator

java.lang.String getInitiator()

Retrieves the name of the person that initiated the process.

Returns:

The common name for the process initiator.

getInitiatorId

java.lang.String getInitiatorId()

Retrieves the identifier of the person that initiated the process.

Returns:

The identifier for the process initiator.

getDescription

java.lang.String getDescription()

Retrieves the process description.

Returns:

The process description.