|
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.VWStepOccurrenceHistory
Use this class to query for step occurrence history. An object of this class is created by the VWStepHistory.next() method. Once this object is created, step work object history items can be fetched with the next() method.
VWWorkflowHistory 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()to check if any more elements are available.
VWWorkflowHistory
,
VWStepHistory
,
VWStepWorkObjectHistory
,
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 elements to return in a fetch. |
java.util.Date |
getCompletionDate()
Gets the date on which the all participants completed the work at this step occurrence. |
java.util.Date |
getDateReceived()
Gets the date on which the participant first received the work. |
int |
getOccurrenceId()
Gets the occurrence id. |
int |
getStepStatus()
Gets the step status of this step occurrence |
boolean |
hasNext()
Determines if more items are available to be returned. |
VWStepWorkObjectHistory |
next()
Retrieves a VWStepWorkObjectHistory object that contains history information. |
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
in number of elements. Specify a number greater than 0 (zero).
This must be greater than zero.VWException
- The method throws an exception if
buffer size specified in the newSize parameter is less than or
equal to 0 (zero).public int getBufferSize()
public void resetFetch() throws VWException
public boolean hasNext() throws VWException
VWException
- Thrown if it cannot
determine if more items are available to be returned.public VWStepWorkObjectHistory next() throws VWException
VWException
- The method throws an exception if the
system encounters an error while attempting to retrieve a
history object.public int getOccurrenceId()
public java.util.Date getDateReceived() throws VWException
public java.util.Date getCompletionDate() throws VWException
public int getStepStatus() throws VWException
|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |