|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--filenet.vw.api.VWWorkflowHistory
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.
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 |
public void resetFetch()
public boolean hasNext() throws VWException
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.
VWException
- Thrown if it cannot
determine whether the iteration has more elements.public VWStepHistory next() throws VWException
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.
VWException
- Thrown if the
system encounters a problem while attempting to retrieve a
history object.public VWStepHistory fetchStepHistory(int stepId) throws VWException
stepId
- An integer value specifying the Id of the step
to retrieve history information.VWException
- Thrown if the
attempted fetch operation fails.public void setBufferSize(int newSize) throws VWException
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).VWException
- Thrown if
buffer size specified in the newSize parameter is less than or
equal to 0 (zero).public int getBufferSize()
public java.util.Date getLaunchDate()
public java.lang.String getOriginator()
public java.lang.String getLaunchComments()
public java.lang.String getLaunchResponse()
public java.lang.String getWorkClassName()
|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |