VWWorkflowMilestones (Process API Documentation)

Skip navigation links

Process API

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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

```
public final class VWWorkflowMilestones
extends java.lang.Object
```
Queries for workflow milestone occurrences in the workflow log. Use VWProcess.fetchReachedWorkflowMilestones(int) to create an object of this class, so that you can iteratively fetch milestone items (VWMilestoneElement objects) with the next() method. This API makes use of methods next() and hasNext() in a way that is similar to the Iterator interface in Java 2.
A query ends when the next() method returns null. Use the hasNext() method if you wish to check for more elements in the iterated series of milestone items.

Since:

VWWS4.20

See Also:

VWProcess.fetchReachedWorkflowMilestones(int), VWMilestoneElement, VWMilestoneDefinition

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`hasNext()` Returns `true` if the current VWWorkflowMilestones instance has more VWMilestoneElement object elements.
`VWMilestoneElement`	`next()` Returns the next element in an iterated series of VWMilestoneElement members that belong to the current instance of the VWWorkflowMilestones class.
`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
```
    Returns true if the current VWWorkflowMilestones instance has more VWMilestoneElement object elements. (In other words, returns true if VWWorkflowMilestones.next() would return a non-null element.)
    
    Returns:
    
    true if the current VWWorkflowMilestones instance has more VWMilestoneElement object elements
    
    Throws:
    
    VWException
  - next
```
public VWMilestoneElement next()
                        throws VWException
```
    Returns the next element in an iterated series of VWMilestoneElement members that belong to the current instance of the VWWorkflowMilestones class.
    
    Returns:
    
    A VWMilestoneElement object (a milestone occurrence) that represents a unique milestone for the step. If no more items exist, the method returns null.
    
    Throws:
    
    VWException - Thrown if there is a problem with retrieval of subsequent milestone occurrences
    
    See Also:
    
    VWProcess.fetchReachedWorkflowMilestones(int)