Process Class Relationships

filenet.vw.api
Class VWStepWorkObjectHistory

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

public final class VWStepWorkObjectHistory
extends java.lang.Object

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

Use the hasNext() method to check if any more elements are available. A query ends when the next() method returns null values.

Since:
VWWS3.10
See Also:
VWWorkflowHistory, VWStepHistory, VWStepOccurrenceHistory, 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 elementsto return in a fetch.
 boolean getIsCompleted()
          Determines whether or not process associated with the work item has been completed.
 int getStepId()
          Retrieves the Id number for the step processor.
 java.lang.String getWorkObjectNumber()
          Retrieves a string representation of the work object number.
 boolean hasNext()
          Determines if more elements are available to return.
 VWParticipantHistory next()
          Retrieves a VWParticipantHistory object that represents history for the element.
 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 - specifed by the number of elements. Specify a value greater than zero (0).
Throws:
VWException - Thrown if it cannot sets the maximum number of elements to return in a fetch, for example, if buffer size is less than or equal to 0.

getBufferSize

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

hasNext

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

resetFetch

public void resetFetch()
                throws VWException
Resets the last element fetched for this step history object. The new fetch results include previously fetched elements.
Throws:
VWException - Thrown if it cannot reset the last element fetched for this step history object.

next

public VWParticipantHistory next()
                          throws VWException
Retrieves a VWParticipantHistory object that represents history for the element. Call this method repeatedly to retrieve the all available participant history objects.

Returns:
A VWParticipantHistory object. If no history object exists, the method returns null.
Throws:
VWException - The method throws an exception if the system encounters an error while attempting to retrieve a history object.

getWorkObjectNumber

public java.lang.String getWorkObjectNumber()
Retrieves a string representation of the work object number.
Returns:
A string containing a text version of the work object number.

getIsCompleted

public boolean getIsCompleted()
                       throws VWException
Determines whether or not process associated with the work item has been completed.
Returns:
A Boolean value. The method returns true if the work item was completed; otherwise, the method returns false.
Throws:
VWException - Thrown if it cannot determine whether or not process associated with the work item has been completed.

getStepId

public int getStepId()
Retrieves the Id number for the step processor.
Returns:
An integer value that indicates the unique value of the step processor Id.

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.