VWStepWorkObjectHistory (Process API Documentation)

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

```
public final class VWStepWorkObjectHistory
extends java.lang.Object
```
Use this class to query the participant histories of a step occurrence history item. Create an instance of this class with the VWStepOccurrenceHistory.next() method. Retrieve individual work object history items for a step with the VWStepWorkObjectHistory.next() method. A query series is completed when the next()} method returns null values.
VWStepWorkObjectHistory contains methods next() and VWStepWorkObjectHistory.hasNext() which function similarly to the next() and hasNext() methods in the Iterator interface in Java 2.

Since:

VWWS3.10

See Also:

VWWorkflowHistory, VWStepHistory, VWStepOccurrenceHistory.next(), VWParticipantHistory

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`STATUS_COMPLETED` Value of 0
`static int`	`STATUS_DELETED` Value of 2
`static int`	`STATUS_EXCEPTION` Value of 3
`static int`	`STATUS_GOTO_SUBMAP` Value of 4
`static int`	`STATUS_IN_PROGRESS` Value of 1

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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()` Indicates whether another element can be fetched from this VWStepWorkObjectHistory instance.
`VWParticipantHistory`	`next()` Retrieves the subsequent element for this VWStepWorkObjectHistory instance. Invoke this method repeatedly to retrieve a series of VWParticipantHistory objects.
`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
```
    Value of 0
    
    See Also:
    
    Constant Field Values
  - STATUS_IN_PROGRESS
```
public static final int STATUS_IN_PROGRESS
```
    Value of 1
    
    See Also:
    
    Constant Field Values
  - STATUS_DELETED
```
public static final int STATUS_DELETED
```
    Value of 2
    
    See Also:
    
    Constant Field Values
  - STATUS_EXCEPTION
```
public static final int STATUS_EXCEPTION
```
    Value of 3
    
    See Also:
    
    Constant Field Values
  - STATUS_GOTO_SUBMAP
```
public static final int STATUS_GOTO_SUBMAP
```
    Value of 4
    
    See Also:
    
    Constant Field Values
- 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
```
    Indicates whether another element can be fetched from this VWStepWorkObjectHistory instance.
    
    Returns:
    
    true if there are more elements that can be fetched.
    Note: This method requires a buffer size greater than 1 to operate properly. The default buffersize is 50.
    
    Throws:
    
    VWException
  - 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 the subsequent element for this VWStepWorkObjectHistory instance. Invoke this method repeatedly to retrieve a series of VWParticipantHistory objects. Returns null when no more objects can be returned.
    To use this method, create a VWStepWorkObjectHistory object with a VWStepOccurrenceHistory.next() 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 VWStepWorkObjectHistory.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).
    
    Returns:
    
    A VWParticipantHistory object.
    
    Throws:
    
    VWException
  - 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.

Methods inherited from class java.lang.Object

STATUS_COMPLETED

STATUS_IN_PROGRESS

STATUS_DELETED

STATUS_EXCEPTION

STATUS_GOTO_SUBMAP

setBufferSize

getBufferSize

hasNext

resetFetch

next

getWorkObjectNumber

getIsCompleted

getStepId