Process Class Relationships

filenet.vw.api
Class VWWorkflowMilestones

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

public final class VWWorkflowMilestones
extends java.lang.Object

Queries for workflow milestone occurrences in the work flow log. VWProcess.fetchReachedWorkflowMilestones creates an object of this class, so that you can fetch milestone items (VWMilestoneElement objects)with the next() method.

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

This API implements iterator methods next() and hasNext(), which emulate the new collection model in Java 2.

Since:
VWWS4.20
See Also:
VWProcess.fetchReachedWorkflowMilestones(int), VWMilestoneElement, VWMilestoneDefinition

Method Summary
 boolean hasNext()
          Determines whether the retrieval iteration has more elements.
 VWMilestoneElement next()
          Retrieves subsequent milestone occurrences (if you call this method repeatedly).
 void resetFetch()
          Resets the last element fetched for this step history object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

resetFetch

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

hasNext

public boolean hasNext()
                throws VWException
Determines whether the retrieval iteration has more elements.

Note: Make the buffer size to fetch greater than 1 to check the elements as intended.

Returns:
A boolean value: 'True' if there are more queue elements; 'false' if there are no more queue elements
See Also:
VWWorkflowHistory.setBufferSize(int)

next

public VWMilestoneElement next()
                        throws VWException
Retrieves subsequent milestone occurrences (if you call this method repeatedly).

Note:Before using this method, create the VWWorkflowHistory object with VWProcess.fetchWorkflowHistory. This method sets the buffer size for retrieval from the server in the VWStepHistory object.

Returns:
A VWMilestoneElement object (a milestone occurrence) or null if there are no more items
Throws:
VWException - Thrown if there is a problem with retrieval of subsequent milestone occurrences
See Also:
VWProcess.fetchWorkflowHistory(int), VWWorkflowHistory.setBufferSize(int)

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.