|
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 for a list of work object histories of a step occurrence. An object of this class is created by the VWStepOccurrenceHistory.next() method. Once this object is created, participant history items can be fetched with the next() method.
Use the hasNext() method to check if any more elements are available. A query ends when the next() method returns null values.
VWWorkflowHistory
,
VWStepHistory
,
VWStepOccurrenceHistory
,
VWParticipantHistory
Field Summary | |
static int |
STATUS_COMPLETED
|
static int |
STATUS_DELETED
|
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()
Determines if more elements are available to return. |
VWParticipantHistory |
next()
Retrieves a VWParticipantHistory object that represents history for the element. |
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
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
VWException
- Thrown if it cannot
determine if more elements are available to return.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
VWException
- The method throws an exception if the
system encounters an error while attempting to retrieve a
history object.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()
|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |