Process API

filenet.vw.api
Class VWParticipantHistory

java.lang.Object
  extended by filenet.vw.api.VWParticipantHistory

public final class VWParticipantHistory
extends java.lang.Object

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.

Since:
VWWS3.10
See Also:
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

STATUS_NULL

public static final int STATUS_NULL
Value of 0; indicates this participant's status for the step is unknown or not set.

See Also:
Constant Field Values

STATUS_IN_PROGRESS

public static final int STATUS_IN_PROGRESS
Value of 1; indicates this participant's status for the step is In Progress.

See Also:
Constant Field Values

STATUS_COMPLETED_NORMAL

public static final int STATUS_COMPLETED_NORMAL
Value of 2; indicates this participant's status for the step is Completed Normal.

See Also:
Constant Field Values

STATUS_COMPLETED_ABNORMAL

public static final int STATUS_COMPLETED_ABNORMAL
Value of 3; indicates this participant's status for the step is Completed Abnormal.

See Also:
Constant Field Values

STATUS_WO_FORCED_TO_DELETE

public static final int STATUS_WO_FORCED_TO_DELETE
Value of 4; indicates this participant's status for the step is Work Object Forced To Delete.

See Also:
Constant Field Values

STATUS_WO_FORCED_TO_TERMINATE

public static final int STATUS_WO_FORCED_TO_TERMINATE
Value of 5; indicates this participant's status for the step is Work Object Forced To Terminate.

See Also:
Constant Field Values

STATUS_DELEGATED

public static final int STATUS_DELEGATED
Value of 6; indicates this participant's status for the step is Delegated.

See Also:
Constant Field Values

STATUS_REASSIGNED

public static final int STATUS_REASSIGNED
Value of 7; indicates this participant's status for the step is Reassigned.

See Also:
Constant Field Values

STATUS_RETURNED

public static final int STATUS_RETURNED
Value of 8; indicates this participant's status for the step is Returned.

See Also:
Constant Field Values

STATUS_OVERDUE

public static final int STATUS_OVERDUE
Value of 9; indicates this participant's status for the step is Overdue.

See Also:
Constant Field Values

STATUS_REMINDED

public static final int STATUS_REMINDED
Value of 10; indicates this participant's status for the step is Reminded.

See Also:
Constant Field Values

STATUS_GOTO_SUBMAP

public static final int STATUS_GOTO_SUBMAP
Value of 11; indicates this participant's status for the step is Goto Submap.

See Also:
Constant Field Values

STATUS_EXCEPTION

public static final int STATUS_EXCEPTION
Value of 11; indicates this participant's status for the step is Exception.

See Also:
Constant Field Values
Method Detail

_get_FILE_DATE

public static java.lang.String _get_FILE_DATE()
For FileNet internal use only, do not call.


_get_FILE_AUTHOR

public static java.lang.String _get_FILE_AUTHOR()
For FileNet internal use only, do not call.


_get_FILE_REVISION

public static java.lang.String _get_FILE_REVISION()
For FileNet internal use only, do not call.


getComments

public java.lang.String getComments()
Returns the comments entered by the participant for this step.


getCompletionDate

public java.util.Date getCompletionDate()
Returns the date on which the participant completed the step.

Returns:
A date value, which indicates when the participant completed the step.

getCompletionUser

public java.lang.String getCompletionUser()
Returns the participant who completed, delegated, reassigned, returned or terminated the workflow step, as a String value.

Returns:
- The name of the participant who completed, delegated, reassigned, returned or terminated the workflow step.

getCompletionUserPx

public VWParticipant getCompletionUserPx()
Returns the participant who completed, delegated, reassigned, returned or terminated the workflow step, as an instance of a VWParticipant object.

Returns:
- The name of the participant who completed, delegated, reassigned, returned or terminated the workflow step.

getDateReceived

public java.util.Date getDateReceived()
Gets a date value that indicates when the participant received the current step.

Returns:
The date when the participant received the current step.

getBoundUserId

public int getBoundUserId()
                   throws VWException
Returns the bound user ID.

Returns:
The bound user ID.
Throws:
VWException

getUserName

public java.lang.String getUserName()
                             throws VWException
Returns the name of the participant who completed, reassigned or delegated the work object for the step, as a String.

Returns:
The name of the participant who completed, reassigned or delegated the work object for the current step, as a String.
Throws:
VWException

getUserNamePx

public VWParticipant getUserNamePx()
                            throws VWException
Returns a VWParticipant object for the participant who completed, reassigned or delegated the work object for this step.

Returns:
VWParticipant object for the participant who completed, reassigned or delegated the work object for this step.
Throws:
VWException

getParticipantName

public java.lang.String getParticipantName()
                                    throws VWException
Returns the short name of the current participant, as a String.

Returns:
The short name of the current participant, as a String.
Throws:
VWException

getParticipantNamePx

public VWParticipant getParticipantNamePx()
                                   throws VWException
Returns a VWParticipant (security) object that represents the current participant.

Returns:
A VWParticipant (security) object that represents the current participant.
Throws:
VWException

getQueueName

public java.lang.String getQueueName()
                              throws VWException
Returns the name of the queue for this step. If a translation source exists, the authored name is translated.

Returns:
A String containing the translated queue name, if a translation source exists; otherwise, the authored name is returned. If an associated queue name cannot be found, null is returned.
Throws:
VWException

getResponse

public java.lang.String getResponse()
                             throws VWException
Returns the participant's response to the step. If a translation source exists, the authored response is translated.

Returns:
A String containing the translated response (entered when working on the step), if a translation source exists; otherwise, the authored response is returned. If an associated response cannot be found, null is returned.
Throws:
VWException

getStepStatus

public int getStepStatus()
                  throws VWException
Returns the activity status for the participant working on the step.

Returns:
The value of a status property for this instance, indicating the current status of the work on the step (performed by the participant).
Throws:
VWException

getLogFields

public VWDataField[] getLogFields()
                           throws VWException
Returns the exposed log fields. If a translation source exists, the authored names of the log fields are translated.

Returns:
An array of VWDataField objects representing the exposed log fields. If a translation source exists the translated names of the log fields are returned; otherwise, the authored names are returned.
Throws:
VWException - Thrown if the log fields cannot be listed.

getWorkObjectNumber

public java.lang.String getWorkObjectNumber()
Gets the current work object number for the activity history for the current participant.

Returns:
The work object number.

getIsSameParticipant

public boolean getIsSameParticipant(VWParticipantHistory participant)
Determines, using the participant name, if the specified participant is the same as the current participant.

Parameters:
participant - A VWParticipantHistory object which includes the participant to test against.
Returns:
- true if the participant object specified in the participant parameter matches the current participant; otherwise, this method returns false.

getIsSameParticipant

public boolean getIsSameParticipant(VWWorkObject wob)
                             throws VWException
Determines, by work object number, if the specified work object is the same as the work object for the current participant.

Parameters:
wob - A VWWorkObject object which includes the participant to test against.
Returns:
- true if the work object specified in the wob parameter matches the current work object; otherwise, this method returns false.
Throws:
VWException

getIsReminded

public boolean getIsReminded()
Indicates whether a reminder was sent to a participant.

Returns:
true if a reminder was sent to the current participant; otherwise, this method returns false.

getIsOverdue

public boolean getIsOverdue()
Indicates whether the step is an overdue notice was sent to the current participant.

Returns:
true if an overdue notice was sent to the current participant; otherwise, this method returns false.

getReminder

public java.util.Date getReminder()
                           throws VWException
Gets reminder date/time information for the current participant.

Returns:
A date value indicating the day and time when the reminder was sent to a participant, or null if no reminder was sent to a participant.
Throws:
VWException

getOverdue

public java.util.Date getOverdue()
                          throws VWException
Gets the overdue date/time information.

Returns:
A date value indicating the day and time when the overdue notice was sent to a participant. This method returns null if no overdue reminder was sent to a participant.
Throws:
VWException

isSystemInstructionsOperation

public static boolean isSystemInstructionsOperation(int operationId)
Indicates whether the operation is a system instructions operation.

Returns:
true if the operation is a system instructions operation; otherwise, this method returns false.

Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.