Process Class Relationships

filenet.vw.api
Class VWParticipantHistory

java.lang.Object
  |
  +--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.

Since:
VWWS3.10
See Also:
VWStepHistory.next()

Field Summary
static int STATUS_COMPLETED_ABNORMAL
           
static int STATUS_COMPLETED_NORMAL
           
static int STATUS_DELEGATED
           
static int STATUS_EXCEPTION
           
static int STATUS_IN_PROGRESS
           
static int STATUS_NULL
           
static int STATUS_OVERDUE
           
static int STATUS_REASSIGNED
           
static int STATUS_REMINDED
           
static int STATUS_RETURNED
           
static int STATUS_WO_FORCED_TO_DELETE
           
static int STATUS_WO_FORCED_TO_TERMINATE
           
 
Method Summary
 int getBoundUserId()
          Gets an integer value for the bound user ID.
 java.lang.String getComments()
          Gets the comments entered by the participant for this step.
 java.util.Date getCompletionDate()
          Get the date on which the participant completed the step.
 java.lang.String getCompletionUser()
          Gets the participant who completed, delegated, reassigned, returned or terminated the workflow step.
 java.util.Date getDateReceived()
          Gets a date value, which indicates when the participant received the step.
 boolean getIsOverdue()
          Determines whether or not the step is overdue.
 boolean getIsReminded()
          Determines whether or not a reminder was sent to a participant.
 boolean getIsSameParticipant(VWParticipantHistory participant)
          Determines, by 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()
          An array of VWDataField objects that represent exposed log fields.
 java.util.Date getOverdue()
          Gets the overdue date/time information.
 java.lang.String getParticipantName()
          Gets the name of the participant.
 java.lang.String getQueueName()
          Gets the name of the queue.
 java.util.Date getReminder()
          Gets the reminder date/time information.
 java.lang.String getResponse()
          Gets the participant's response to the step.
 int getStepStatus()
          Gets an integer associated with the activity status for the participant working on the step.
 java.lang.String getUserName()
          Gets the name of the participant who completed, reassigned or delegated the work.
 java.lang.String getWorkObjectNumber()
          Gets the work object number for the activity history for the participant.
 
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

STATUS_IN_PROGRESS

public static final int STATUS_IN_PROGRESS

STATUS_COMPLETED_NORMAL

public static final int STATUS_COMPLETED_NORMAL

STATUS_COMPLETED_ABNORMAL

public static final int STATUS_COMPLETED_ABNORMAL

STATUS_WO_FORCED_TO_DELETE

public static final int STATUS_WO_FORCED_TO_DELETE

STATUS_WO_FORCED_TO_TERMINATE

public static final int STATUS_WO_FORCED_TO_TERMINATE

STATUS_DELEGATED

public static final int STATUS_DELEGATED

STATUS_REASSIGNED

public static final int STATUS_REASSIGNED

STATUS_RETURNED

public static final int STATUS_RETURNED

STATUS_OVERDUE

public static final int STATUS_OVERDUE

STATUS_REMINDED

public static final int STATUS_REMINDED

STATUS_EXCEPTION

public static final int STATUS_EXCEPTION
Method Detail

getComments

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

getCompletionDate

public java.util.Date getCompletionDate()
Get 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()
Gets the participant who completed, delegated, reassigned, returned or terminated the workflow step.
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, which indicates when the participant received the step.
Returns:
The date when the participant received the step.

getBoundUserId

public int getBoundUserId()
                   throws VWException
Gets an integer value for the bound user ID.
Returns:
An integer value for the bound user ID.

getUserName

public java.lang.String getUserName()
                             throws VWException
Gets the name of the participant who completed, reassigned or delegated the work.
Returns:
The name of the participant who completed, reassigned or delegated the work.

getParticipantName

public java.lang.String getParticipantName()
                                    throws VWException
Gets the name of the participant.
Returns:
The name of the participant.

getQueueName

public java.lang.String getQueueName()
                              throws VWException
Gets the name of the queue.
Returns:
The name of the queue.

getResponse

public java.lang.String getResponse()
                             throws VWException
Gets the participant's response to the step.
Returns:
A string containing the response the participant entered when working on the step.

getStepStatus

public int getStepStatus()
                  throws VWException
Gets an integer associated with the activity status for the participant working on the step. The activity status integer values are shown below:


Returns:
An integer value indicating the current status for the work for the step, performed by the participant.

getLogFields

public VWDataField[] getLogFields()
                           throws VWException
An array of VWDataField objects that represent exposed log fields.
Returns:
An array of VWDataField objects that represent exposed log fields.

getWorkObjectNumber

public java.lang.String getWorkObjectNumber()
Gets the work object number for the activity history for the participant.
Returns:
The workflow number.

getIsSameParticipant

public boolean getIsSameParticipant(VWParticipantHistory participant)
Determines, by 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:
- A boolean value. The method returns true if the participant object specified in the participant parameter matches the current participant; otherwise, the 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:
- A boolean value. The method returns true if the work object specified in the wob parameter matches the current work object; otherwise, the method returns false.

getIsReminded

public boolean getIsReminded()
Determines whether or not a reminder was sent to a participant.
Returns:
A boolean value. The method returns true if a reminder was sent to a participant; otherwise, the method returns false.

getIsOverdue

public boolean getIsOverdue()
Determines whether or not the step is overdue.
Returns:
A boolean value. The method returns true if an overdue notice was sent to a participant; otherwise, the method returns false.

getReminder

public java.util.Date getReminder()
                           throws VWException
Gets the reminder date/time information.
Returns:
A date value indicating the day and time when the reminder was sent to a participant. The method returns null if no reminder was sent to a participant.

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. The method returns null if no overdue reminder was sent to a participant.


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.