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 step history information. Create an instance of this class by calling the VWProcess.fetchWorkflowHistory(int) or VWProcess.fetchFilteredWorkflowHistory(int,int) methods, Retrieve individual step history items with the next() method. A query series is completed when the next()} method returns null values.

VWStepWorkObjectHistory contains methods next() and hasNext() which function similarly to the next() and hasNext() methods in the Iterator interface in Java 2.

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()
          Indicates whether another element can be fetched from this VWWorkflowHistory instance.
 VWStepHistory next()
          Retrieves the subsequent element for this VWWorkflowHistory instance. Invoke this method repeatedly to retrieve a series of VWStepHistory objects.
 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
Indicates whether another element can be fetched from this VWWorkflowHistory 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 VWStepHistory next()
                   throws VWException
Retrieves the subsequent element for this VWWorkflowHistory instance. Invoke this method repeatedly to retrieve a series of VWStepHistory objects. Returns null when no more objects can be returned.

To use this method, create a VWWorkflowHistory object with a VWProcess.fetchWorkflowHistory(int) or VWProcess.fetchFilteredWorkflowHistory(int,int) 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 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 VWStepHistory object that represents a unique history event for the step.
Throws:
VWException -  

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.
Returns:
An integer value indicating the 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 that 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.


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.