|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWParticipantHistory
public final class VWParticipantHistory
Use this class to access the participant history for a step element.
An object of this class is created by the VWStepWorkObjectHistory.next()
method. Retrieve
individual participant history items with the #next()
method. A query series is completed when the next()} method
returns null values.
VWParticipantHistory contains methods next() and #hasNext()
which function similarly to the next() and hasNext()
methods in the Iterator interface in Java 2.
VWStepHistory.next()
Field Summary | |
---|---|
static int |
STATUS_COMPLETED_ABNORMAL
Value of 3; indicates this participant's status for the step is Completed Abnormal. |
static int |
STATUS_COMPLETED_NORMAL
Value of 2; indicates this participant's status for the step is Completed Normal. |
static int |
STATUS_DELEGATED
Value of 6; indicates this participant's status for the step is Delegated. |
static int |
STATUS_EXCEPTION
Value of 11; indicates this participant's status for the step is Exception. |
static int |
STATUS_GOTO_SUBMAP
Value of 11; indicates this participant's status for the step is Goto Submap. |
static int |
STATUS_IN_PROGRESS
Value of 1; indicates this participant's status for the step is In Progress. |
static int |
STATUS_NULL
Value of 0; indicates this participant's status for the step is unknown or not set. |
static int |
STATUS_OVERDUE
Value of 9; indicates this participant's status for the step is Overdue. |
static int |
STATUS_REASSIGNED
Value of 7; indicates this participant's status for the step is Reassigned. |
static int |
STATUS_REMINDED
Value of 10; indicates this participant's status for the step is Reminded. |
static int |
STATUS_RETURNED
Value of 8; indicates this participant's status for the step is Returned. |
static int |
STATUS_WO_FORCED_TO_DELETE
Value of 4; indicates this participant's status for the step is Work Object Forced To Delete. |
static int |
STATUS_WO_FORCED_TO_TERMINATE
Value of 5; indicates this participant's status for the step is Work Object Forced To Terminate. |
Method Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
int |
getBoundUserId()
Returns the bound user ID. |
java.lang.String |
getComments()
Returns the comments entered by the participant for this step. |
java.util.Date |
getCompletionDate()
Returns the date on which the participant completed the step. |
java.lang.String |
getCompletionUser()
Returns the participant who completed, delegated, reassigned, returned or terminated the workflow step, as a String value. |
VWParticipant |
getCompletionUserPx()
Returns the participant who completed, delegated, reassigned, returned or terminated the workflow step, as an instance of a VWParticipant object. |
java.util.Date |
getDateReceived()
Gets a date value that indicates when the participant received the current step. |
boolean |
getIsOverdue()
Indicates whether the step is an overdue notice was sent to the current participant. |
boolean |
getIsReminded()
Indicates whether a reminder was sent to a participant. |
boolean |
getIsSameParticipant(VWParticipantHistory participant)
Determines, using the participant name, if the specified participant is the same as the current participant. |
boolean |
getIsSameParticipant(VWWorkObject wob)
Determines, by work object number, if the specified work object is the same as the work object for the current participant. |
VWDataField[] |
getLogFields()
Returns the exposed log fields. |
java.util.Date |
getOverdue()
Gets the overdue date/time information. |
java.lang.String |
getParticipantName()
Returns the short name of the current participant, as a String. |
VWParticipant |
getParticipantNamePx()
Returns a VWParticipant (security) object that represents the current participant. |
java.lang.String |
getQueueName()
Returns the name of the queue for this step. |
java.util.Date |
getReminder()
Gets reminder date/time information for the current participant. |
java.lang.String |
getResponse()
Returns the participant's response to the step. |
int |
getStepStatus()
Returns the activity status for the participant working on the step. |
java.lang.String |
getUserName()
Returns the name of the participant who completed, reassigned or delegated the work object for the step, as a String. |
VWParticipant |
getUserNamePx()
Returns a VWParticipant object for the participant who completed, reassigned or delegated the work object for this step. |
java.lang.String |
getWorkObjectNumber()
Gets the current work object number for the activity history for the current participant. |
static boolean |
isSystemInstructionsOperation(int operationId)
Indicates whether the operation is a system instructions operation. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int STATUS_NULL
public static final int STATUS_IN_PROGRESS
public static final int STATUS_COMPLETED_NORMAL
public static final int STATUS_COMPLETED_ABNORMAL
public static final int STATUS_WO_FORCED_TO_DELETE
public static final int STATUS_WO_FORCED_TO_TERMINATE
public static final int STATUS_DELEGATED
public static final int STATUS_REASSIGNED
public static final int STATUS_RETURNED
public static final int STATUS_OVERDUE
public static final int STATUS_REMINDED
public static final int STATUS_GOTO_SUBMAP
public static final int STATUS_EXCEPTION
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public java.lang.String getComments()
public java.util.Date getCompletionDate()
public java.lang.String getCompletionUser()
public VWParticipant getCompletionUserPx()
public java.util.Date getDateReceived()
public int getBoundUserId() throws VWException
VWException
public java.lang.String getUserName() throws VWException
VWException
public VWParticipant getUserNamePx() throws VWException
VWException
public java.lang.String getParticipantName() throws VWException
VWException
public VWParticipant getParticipantNamePx() throws VWException
VWException
public java.lang.String getQueueName() throws VWException
VWException
public java.lang.String getResponse() throws VWException
VWException
public int getStepStatus() throws VWException
VWException
public VWDataField[] getLogFields() throws VWException
VWException
- Thrown if the log fields cannot be listed.public java.lang.String getWorkObjectNumber()
public boolean getIsSameParticipant(VWParticipantHistory participant)
participant
- A VWParticipantHistory object which includes
the participant to test against.
true
if the
participant object specified in the participant parameter
matches the current participant; otherwise, this method returns
false
.public boolean getIsSameParticipant(VWWorkObject wob) throws VWException
wob
- A VWWorkObject object which includes the participant
to test against.
true
if the
work object specified in the wob parameter
matches the current work object; otherwise, this method returns
false
.
VWException
public boolean getIsReminded()
true
if a reminder was sent
to the current participant; otherwise, this method returns
false
.public boolean getIsOverdue()
true
if an overdue notice was sent
to the current participant; otherwise, this method
returns false
.public java.util.Date getReminder() throws VWException
VWException
public java.util.Date getOverdue() throws VWException
VWException
public static boolean isSystemInstructionsOperation(int operationId)
true
if the operation is a system instructions
operation; otherwise, this method returns false
.
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |