Process Class Relationships

filenet.vw.api
Class VWStepOccurrenceHistory

java.lang.Object
  |
  +--filenet.vw.api.VWStepOccurrenceHistory

public final class VWStepOccurrenceHistory
extends java.lang.Object

Use this class to query for step occurrence history. An object of this class is created by the VWStepHistory.next() method. Once this object is created, step work object history items can be fetched with the next() method.

VWWorkflowHistory implements Iterator methods next() and hasNext(), which emulate the new collection model in Java 2. A query ends when the next() method returns null values. Use the hasNext()to check if any more elements are available.

Since:
VWWS3.10
See Also:
VWWorkflowHistory, VWStepHistory, VWStepWorkObjectHistory, VWParticipantHistory

Field Summary
static int STATUS_COMPLETED
           
static int STATUS_DELETED
           
static int STATUS_IN_PROGRESS
           
 
Method Summary
 int getBufferSize()
          Retrieves the maximum number of elements to return in a fetch.
 java.util.Date getCompletionDate()
          Gets the date on which the all participants completed the work at this step occurrence.
 java.util.Date getDateReceived()
          Gets the date on which the participant first received the work.
 int getOccurrenceId()
          Gets the occurrence id.
 int getStepStatus()
          Gets the step status of this step occurrence
 boolean hasNext()
          Determines if more items are available to be returned.
 VWStepWorkObjectHistory next()
          Retrieves a VWStepWorkObjectHistory object that contains history information.
 void resetFetch()
          Resets the last element fetched for this step history object.
 void setBufferSize(int newSize)
          Sets the maximum number of elements to return in a fetch.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STATUS_COMPLETED

public static final int STATUS_COMPLETED

STATUS_IN_PROGRESS

public static final int STATUS_IN_PROGRESS

STATUS_DELETED

public static final int STATUS_DELETED
Method Detail

setBufferSize

public void setBufferSize(int newSize)
                   throws VWException
Sets the maximum number of elements to return in a fetch. The default value is 50.
Parameters:
newSize - An integer value specifying the new buffer size in number of elements. Specify a number greater than 0 (zero). This must be greater than zero.
Throws:
VWException - The method throws an exception if buffer size specified in the newSize parameter is less than or equal to 0 (zero).

getBufferSize

public int getBufferSize()
Retrieves the maximum number of elements to return in a fetch. The default value is 50.
Returns:
An integer value that represents the maximum number of elements that was specified to return in a fetch.
Since:
VWWS3.10

resetFetch

public void resetFetch()
                throws VWException
Resets the last element fetched for this step history object. The new fetch results include previously fetched elements.

hasNext

public boolean hasNext()
                throws VWException
Determines if more items are available to be returned.
Returns:
A Boolean value. The method returns true if more elements are available to be returned; otherwise, the method returns false. If buffer size to fetch is 1, this check will not work as intended.
Throws:
VWException - Thrown if it cannot determine if more items are available to be returned.

next

public VWStepWorkObjectHistory next()
                             throws VWException
Retrieves a VWStepWorkObjectHistory object that contains history information. Call this method repeatedly to retrieve the history for a work object of a step.
Returns:
A VWStepWorkObjectHistory object that contains history for the step items. If no more items exist, the method returns null.
Throws:
VWException - The method throws an exception if the system encounters an error while attempting to retrieve a history object.

getOccurrenceId

public int getOccurrenceId()
Gets the occurrence id.
Returns:
- Returns the occurrence id.

getDateReceived

public java.util.Date getDateReceived()
                               throws VWException
Gets the date on which the participant first received the work.
Returns:
A date value that indicates the date on which the participant first received the work.

getCompletionDate

public java.util.Date getCompletionDate()
                                 throws VWException
Gets the date on which the all participants completed the work at this step occurrence.
Returns:
A date value that indicates the date on which all the participants completed the work at this step occurrence.

getStepStatus

public int getStepStatus()
                  throws VWException
Gets the step status of this step occurrence
Returns:
An integer value that indicates the status of the step occurrence. The method returns can return the following values:

  • 0: STATUS_COMPLETED
  • 1: STATUS_IN_PROGRESS
  • 2: STATUS_DELETED


Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.