Process Class Relationships

filenet.vw.api
Class VWWorkflowHistory

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

public final class VWWorkflowHistory
extends java.lang.Object

Use this class to query workflow history information. Create an instance of this class by calling the VWProcess.fetchWorkflowHistory() method. Once you have a VWWorkflowHistory object, you can fetch step history items using the next() method.

This API implements Iterator methods next() and hasNext(), which emulate the new collection model in Java 2. 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.

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

Method Summary
 VWStepHistory fetchStepHistory(int stepId)
          Fetches the latest history of the step, given the step ID.
 int getBufferSize()
          Retrieves the maximum number of elements to return in a fetch.
 java.lang.String getLaunchComments()
          Gets comments included in the workflow when it was launched.
 java.util.Date getLaunchDate()
          Gets the launch date of the workflow.
 java.lang.String getLaunchResponse()
          Gets the response included in the workflow when it was launched.
 java.lang.String getOriginator()
          Gets the name of the workflow originator.
 java.lang.String getWorkClassName()
          Returns the work class name of the workflow.
 boolean hasNext()
          Determines whether the iteration has more elements.
 VWStepHistory next()
          Retrieves the history for an occurrence of a step.
 void resetFetch()
          Resets the last element fetched for this step history object.
 void setBufferSize(int newSize)
          Changes 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

resetFetch

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

hasNext

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

The buffer size specified in the newSize parameter of the setBufferSize() method. Make the buffer size to fetch greater than 1 to check as intended.

Returns:
A Boolean value. This method returns true if there are more queue elements to return; otherwise, the method returns false.
Throws:
VWException - Thrown if it cannot determine whether the iteration has more elements.

next

public VWStepHistory next()
                   throws VWException
Retrieves the history for an occurrence of a step. To get all of the available history elements, call this method repeatedly.

Before using this method, create the VWWorkflowHistory object using the VWProcess.fetchWorkflowHistory() method. The fetchWorkflowHistory() method sets the buffer size for retrieval from the server in the VWStepHistory object.

Returns:
A VWStepHistory object that represents a unique history event for the step. If no more items exist, the method returns null.
Throws:
VWException - Thrown if the system encounters a problem while attempting to retrieve a history object.

fetchStepHistory

public VWStepHistory fetchStepHistory(int stepId)
                               throws VWException
Fetches the latest history of the step, given the step ID.
Parameters:
stepId - An integer value specifying the Id of the step to retrieve history information.
Returns:
A VWStepHistory object containing the history information for the step whose Id was specified in the stepId parameter.
Throws:
VWException - Thrown if the attempted fetch operation fails.

setBufferSize

public void setBufferSize(int newSize)
                   throws VWException
Changes 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 for the number of elements to return in a fetch. Specify a value greater than 0 (zero).
Throws:
VWException - Thrown 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 indicating the specified maximum number of elements to return in a fetch.
Since:
VWWS3.10

getLaunchDate

public java.util.Date getLaunchDate()
Gets the launch date of the workflow.
Returns:
A date value that indicates the date of the workflow was launched.

getOriginator

public java.lang.String getOriginator()
Gets the name of the workflow originator.
Returns:
The name of the workflow originator.

getLaunchComments

public java.lang.String getLaunchComments()
Gets comments included in the workflow when it was launched.
Returns:
The comment entered by the originator, when the workflow was launched.

getLaunchResponse

public java.lang.String getLaunchResponse()
Gets the response included in the workflow when it was launched.
Returns:
The response entered by the originator, when the workflow was launched.

getWorkClassName

public java.lang.String getWorkClassName()
Returns the work class name of the workflow.
Returns:
Returns the work class name of the workflow.

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.