|
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 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.
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 |
public void resetFetch()
public boolean hasNext() throws VWException
true
if there are more elements that can be
fetched. VWException
- public VWStepHistory next() throws VWException
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).
VWException
- 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()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |