|
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.VWStepWorkObjectHistory
Use this class to query the participant histories of a step
occurrence history item. Create an instance of this class
with the VWStepOccurrenceHistory.next() method. Retrieve
individual participant 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.
VWWorkflowHistory
,
VWStepHistory
,
VWStepOccurrenceHistory.next()
,
VWParticipantHistory
Field Summary | |
static int |
STATUS_COMPLETED
|
static int |
STATUS_DELETED
|
static int |
STATUS_EXCEPTION
|
static int |
STATUS_IN_PROGRESS
|
Method Summary | |
int |
getBufferSize()
Retrieves the maximum number of elementsto return in a fetch. |
boolean |
getIsCompleted()
Determines whether or not process associated with the work item has been completed. |
int |
getStepId()
Retrieves the Id number for the step processor. |
java.lang.String |
getWorkObjectNumber()
Retrieves a string representation of the work object number. |
boolean |
hasNext()
Indicates whether another element can be fetched from this VWStepWorkObjectHistory instance. |
VWParticipantHistory |
next()
Retrieves the subsequent element for this VWStepWorkObjectHistory instance. Invoke this method repeatedly to retrieve a series of VWParticipantHistory objects. |
void |
resetFetch()
Resets the last element fetched for this 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 |
Field Detail |
public static final int STATUS_COMPLETED
public static final int STATUS_IN_PROGRESS
public static final int STATUS_DELETED
public static final int STATUS_EXCEPTION
Method Detail |
public void setBufferSize(int newSize) throws VWException
newSize
- An integer value specifying the new buffer size
- specifed by the number of elements. Specify a value greater
than zero (0).VWException
- Thrown if it cannot
sets 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() throws VWException
true
if there are more elements that can be
fetched. VWException
- public void resetFetch() throws VWException
VWException
- Thrown if it cannot
reset the last element fetched for this step history object.public VWParticipantHistory next() throws VWException
To use this method, create a VWStepWorkObjectHistory object with
a VWStepOccurrenceHistory.next()
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 java.lang.String getWorkObjectNumber()
public boolean getIsCompleted() throws VWException
VWException
- Thrown if it cannot
determine whether or not process associated with the work item
has been completed.public int getStepId()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |