Process API

filenet.vw.api
Class VWStepHistory

java.lang.Object
  extended by 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 calling the VWWorkflowHistory.next() or VWWorkflowHistory.fetchStepHistory(int) method. Once this object is created, step occurrence history items can be fetched with the next() method.

VWStepHistory contains methods next() and hasNext() which function similarly to the next() and hasNext() methods in the Iterator interface in Java 2 to retrieve all active work objects in this workflow. A retrieval series completes when the next() method returns a null value.

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

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 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()
          Indicates whether another element can be fetched from this VWStepHistory instance.
 boolean isCompoundStep()
          Indicates whether the step type of the current history object is a compound step.
 VWStepOccurrenceHistory next()
          Retrieves the subsequent element for this VWStepHistory instance.
 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

_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.


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()
Indicates whether another element can be fetched from this VWStepHistory instance.

Returns:
true if there are more queue elements that can be fetched.
Note
This method requires a buffer size greater than 1 to operate properly. The default buffersize is 50.

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
Retrieves the subsequent element for this VWStepHistory instance. Invoke this method repeatedly to retrieve a series of VWStepOccurrenceHistory objects. Returns null when no more objects can be returned.

To use this method, create a VWStepHistory object with a VWWorkflowHistory.next() or VWWorkflowHistory.fetchStepHistory(int) call.

After a set of items in the current retrieval buffer is exhausted, additional items will be retrieved from the Process server and buffered. The effective buffer block size is the lesser of the number specified with a preceding setBufferSize(int) call and the number imposed by the Process server limit. You can modify retrieval performance by changing the input buffer size with setBufferSize(int).
Note
This method requires a buffer size greater than 1 to operate properly. The default buffersize is 50.

Returns:
A VWStepOccurrenceHistory object that represents an element containing history information. If no more items exist, the method returns null.
Throws:
VWException

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. If a translation source exists, the authored step name is translated.

Returns:
A String containing the translated name of the step, if a translation source exists; otherwise the authored name is returned.

isCompoundStep

public boolean isCompoundStep()
Indicates whether the step type of the current history object is a compound step.

Returns:
true if the current history object is a compound step.
See Also:
VWCompoundStepDefinition

Process API

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