VWStepOccurrenceHistory (Process API Documentation)

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

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

Since:

VWWS3.10

See Also:

VWWorkflowHistory, VWStepHistory.next(), VWStepWorkObjectHistory, VWParticipantHistory

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`STATUS_COMPLETED`
`static int`	`STATUS_DELETED`
`static int`	`STATUS_EXCEPTION`
`static int`	`STATUS_GOTO_SUBMAP`
`static int`	`STATUS_IN_PROGRESS`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getBufferSize()` Retrieves the maximum number of elements to return in a fetch.
`java.util.Date`	`getCompletionDate()` Gets the date on which the all participants completed the work at this step occurrence.
`java.util.Date`	`getDateReceived()` Gets the date on which the participant first received the work.
`int`	`getInstructionSheetId()` Gets the instruction sheet id
`int`	`getOccurrenceId()` Gets the occurrence id.
`java.lang.String`	`getOperationName()` Gets the operation name.
`int`	`getStepId()` Gets the step id.
`int`	`getStepStatus()` Gets the step status of this step occurrence
`boolean`	`hasNext()` Indicates whether another element can be fetched from this VWStepOccurrenceHistory instance.
`VWStepWorkObjectHistory`	`next()` Retrieves the subsequent element for this VWStepOccurrenceHistory instance. Invoke this method repeatedly to retrieve a series of VWStepWorkObjectHistory 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
```
    See Also:
    
    Constant Field Values
  - STATUS_IN_PROGRESS
```
public static final int STATUS_IN_PROGRESS
```
    See Also:
    
    Constant Field Values
  - STATUS_DELETED
```
public static final int STATUS_DELETED
```
    See Also:
    
    Constant Field Values
  - STATUS_EXCEPTION
```
public static final int STATUS_EXCEPTION
```
    See Also:
    
    Constant Field Values
  - STATUS_GOTO_SUBMAP
```
public static final int STATUS_GOTO_SUBMAP
```
    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 in number of elements. Specify a number greater than 0 (zero). This must be greater than zero.
    
    Throws:
    
    VWException - The method throws an exception if buffer size specified in the newSize parameter is less than or equal to 0 (zero).
  - 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
  - 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
  - hasNext
```
public boolean hasNext()
                throws VWException
```
    Indicates whether another element can be fetched from this VWStepOccurrenceHistory 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
  - next
```
public VWStepWorkObjectHistory next()
                             throws VWException
```
    Retrieves the subsequent element for this VWStepOccurrenceHistory instance. Invoke this method repeatedly to retrieve a series of VWStepWorkObjectHistory objects. Returns null when no more objects can be returned.
    To use this method, create a VWStepOccurrenceHistory object with a VWStepHistory.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 VWStepOccurrenceHistory.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 VWStepWorkObjectHistory object that contains a history of the work objects for a step item.
    
    Throws:
    
    VWException
  - getOperationName
```
public java.lang.String getOperationName()
                                  throws VWException
```
    Gets the operation name.
    
    Returns:
    
    - Returns the operation name.
    
    Throws:
    
    VWException
    
    Since:
    
    P8 4.5.1
  - getOccurrenceId
```
public int getOccurrenceId()
```
    Gets the occurrence id.
    
    Returns:
    
    - Returns the occurrence id.
  - getStepId
```
public int getStepId()
```
    Gets the step id.
    
    Returns:
    
    - Returns the step id.
  - getInstructionSheetId
```
public int getInstructionSheetId()
```
    Gets the instruction sheet id
    
    Returns:
    
    - Returns the instruction sheet id
  - getDateReceived
```
public java.util.Date getDateReceived()
                               throws VWException
```
    Gets the date on which the participant first received the work.
    
    Returns:
    
    A date value that indicates the date on which the participant first received the work.
    
    Throws:
    
    VWException
  - getCompletionDate
```
public java.util.Date getCompletionDate()
                                 throws VWException
```
    Gets the date on which the all participants completed the work at this step occurrence.
    
    Returns:
    
    A date value that indicates the date on which all the participants completed the work at this step occurrence.
    
    Throws:
    
    VWException
  - getStepStatus
```
public int getStepStatus()
                  throws VWException
```
    Gets the step status of this step occurrence
    Returns:
    An integer value that indicates the status of the step occurrence. The method returns can return the following values:
    
    0: STATUS_COMPLETED
    1: STATUS_IN_PROGRESS
    2: STATUS_DELETED
    Throws:
    
    VWException

Methods inherited from class java.lang.Object

STATUS_COMPLETED

STATUS_IN_PROGRESS

STATUS_DELETED

STATUS_EXCEPTION

STATUS_GOTO_SUBMAP

setBufferSize

getBufferSize

resetFetch

hasNext

next

getOperationName

getOccurrenceId

getStepId

getInstructionSheetId

getDateReceived

getCompletionDate

getStepStatus