atg.process
Class ProcessInstanceInfo

java.lang.Object
  atg.process.ProcessInstanceInfo

public class ProcessInstanceInfo
extends java.lang.Object

Contains information about a process instance currently going through a process. Points to an array of ProcessElementInfos, which together indicate the instance's location in the process.

See Also:

ProcessElementInfo

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

ProcessInstanceInfo(java.lang.String pProcessName, java.lang.String pSegmentName, boolean pIndividual, java.lang.String pProcessInstanceId, java.lang.String pSubjectId, java.lang.String pStateId, ProcessElementInfo[] pElementInfos)
Creates a new ProcessInstanceInfo with the given properties.

Method Summary

ProcessElementInfo[]	getElementInfos() Returns the array of ProcessElementInfo objects, which together indicate the instance's location in the process.
java.lang.String	getProcessInstanceId() Returns the repository id of the process instance.
java.lang.String	getProcessName() Returns the process name.
java.lang.String	getSegmentName() Returns the segment name.
java.lang.String	getStateId() Returns the id of the process state machine state this process instance is currently in.
java.lang.String	getSubjectId() Returns the repository id of the subject this process instance is associated with.
boolean	isIndividual() Returns true if the process instance is individual, false if collective.
boolean	isWaitingAtState(ProcessWaitState pWaitState) Returns true if this process instance is waiting at the given ProcessWaitState, false otherwise.
void	setElementInfos(ProcessElementInfo[] pElementInfos) Sets the array of ProcessElementInfo objects, which together indicate the instance's location in the process.
void	setIndividual(boolean pIndividual) Sets the individual flag.
void	setProcessInstanceId(java.lang.String pProcessInstanceId) Sets the repository id of the process instance.
void	setProcessName(java.lang.String pProcessName) Sets the process name.
void	setSegmentName(java.lang.String pSegmentName) Sets the segment name.
void	setStateId(java.lang.String pStateId) Sets the id of the process state machine state this process instance is currently in.
void	setSubjectId(java.lang.String pSubjectId) Sets the subject id.
java.lang.String	toString() Returns a String representation of this ProcessInstanceInfo.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ProcessInstanceInfo

public ProcessInstanceInfo(java.lang.String pProcessName,
                           java.lang.String pSegmentName,
                           boolean pIndividual,
                           java.lang.String pProcessInstanceId,
                           java.lang.String pSubjectId,
                           java.lang.String pStateId,
                           ProcessElementInfo[] pElementInfos)

Creates a new ProcessInstanceInfo with the given properties.

Method Detail

getProcessName

public java.lang.String getProcessName()

Returns the process name.

setProcessName

public void setProcessName(java.lang.String pProcessName)

Sets the process name.

getSegmentName

public java.lang.String getSegmentName()

Returns the segment name.

setSegmentName

public void setSegmentName(java.lang.String pSegmentName)

Sets the segment name.

isIndividual

public boolean isIndividual()

Returns true if the process instance is individual, false if collective.

setIndividual

public void setIndividual(boolean pIndividual)

Sets the individual flag.

getProcessInstanceId

public java.lang.String getProcessInstanceId()

Returns the repository id of the process instance.

setProcessInstanceId

public void setProcessInstanceId(java.lang.String pProcessInstanceId)

Sets the repository id of the process instance.

getSubjectId

public java.lang.String getSubjectId()

Returns the repository id of the subject this process instance is associated with. If the instance is collective, returns null.

setSubjectId

public void setSubjectId(java.lang.String pSubjectId)

Sets the subject id.

getStateId

public java.lang.String getStateId()

Returns the id of the process state machine state this process instance is currently in.

setStateId

public void setStateId(java.lang.String pStateId)

Sets the id of the process state machine state this process instance is currently in.

getElementInfos

public ProcessElementInfo[] getElementInfos()

Returns the array of ProcessElementInfo objects, which together indicate the instance's location in the process. Unlike the state machine id, this expresses the instance's location in terms of the actual process definition element ids.

setElementInfos

public void setElementInfos(ProcessElementInfo[] pElementInfos)

Sets the array of ProcessElementInfo objects, which together indicate the instance's location in the process.

isWaitingAtState

public boolean isWaitingAtState(ProcessWaitState pWaitState)

Returns true if this process instance is waiting at the given ProcessWaitState, false otherwise. Note that the wait state could be a partial wait state; true is returned if the process instance is waiting at a superset of the elements specified by the wait state.

toString

public java.lang.String toString()

Returns a String representation of this ProcessInstanceInfo.

Overrides:

toString in class java.lang.Object