Process Class Relationships

filenet.vw.api
Class VWStepHistory

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

public final class VWStepHistory
extends java.lang.Object

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

VWStepHistory 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() method to check if more elements are available.

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

Method Summary
 int getBufferSize()
          Retrieves the maximum number of elements to return in a fetch.
 int getStepId()
          Retrieves the value of the step Id.
 java.lang.String getStepName()
          Retrieves the step name.
 boolean hasNext()
          Determines if more queue elements are available to be returned.
 VWStepOccurrenceHistory next()
          Calls this method repeatedly to retrieve the history for an occurrence of a step.
 void resetFetch()
          Resets the last element fetched for the current 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
 

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 that specifies the new buffer size in number of elements. Specify a value greater than 0 (zero).
Throws:
VWException - Thrown if it cannot set 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 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

hasNext

public boolean hasNext()
Determines if more queue elements are available to be returned.
Returns:
A Boolean value. The method returns true if more queue 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.

resetFetch

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

next

public VWStepOccurrenceHistory next()
                             throws VWException
Calls this method repeatedly to retrieve the history for an occurrence of a step. You must call this method repeatedly, for each step retrieval.
Returns:
A VWStepOccurrenceHistory object that represents a element containing history information. If no more items exist, the method returns null.
Throws:
VWException - The method throws an exception if the system encounters a problem while attempting to retrieve a history object.

getStepId

public int getStepId()
Retrieves the value of the step Id.
Returns:
An integer value that represents the unique Id for the current step.

getStepName

public java.lang.String getStepName()
Retrieves the step name.
Returns:
The name of the step.

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.