|
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.VWStepHistory
Use this class to query for a step history. An object of this class is created by the VWWorkflowHistory.next() method. Once this object is created, step occurrence history items can be fetched with the next() method.
VWStepHistory 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 to check if more elements are available.
VWWorkflowHistory
,
VWStepOccurrenceHistory
,
VWStepWorkObjectHistory
,
VWParticipantHistory
Method Summary | |
int |
getBufferSize()
Retrieves the maximum number of elements to return in a fetch. |
int |
getStepId()
Retrieves the value of the step Id. |
java.lang.String |
getStepName()
Retrieves the step name. |
boolean |
hasNext()
Determines if more queue elements are available to be returned. |
VWStepOccurrenceHistory |
next()
Calls this method repeatedly to retrieve the history for an occurrence of a step. |
void |
resetFetch()
Resets the last element fetched for the current 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 |
Method Detail |
public void setBufferSize(int newSize) throws VWException
newSize
- An integer value that specifies the new buffer
size in number of elements. Specify a value greater than 0
(zero).VWException
- Thrown if it cannot
set the maximum number of elements to return in a fetch, for
example, if buffer size is less than or equal to 0.public int getBufferSize()
public boolean hasNext()
public void resetFetch()
public VWStepOccurrenceHistory next() throws VWException
VWException
- The method throws an exception if the
system encounters a problem while attempting to retrieve a history object.public int getStepId()
public java.lang.String getStepName()
|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |