|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWStepOccurrenceHistory
public final class VWStepOccurrenceHistory
Use this class to query the step occurrence history of work
objects for a step. Create an instance of this class with the
VWStepHistory.next() method. Retrieve individual step work
object history items with the next()
method.
A query series is completed when the next()} method returns
null values.
VWStepOccurrenceHistory contains methods next() and hasNext()
which function similarly to the next() and hasNext()
methods in the Iterator interface in Java 2.
VWWorkflowHistory
,
VWStepHistory.next()
,
VWStepWorkObjectHistory
,
VWParticipantHistory
Field Summary | |
---|---|
static int |
STATUS_COMPLETED
|
static int |
STATUS_DELETED
|
static int |
STATUS_EXCEPTION
|
static int |
STATUS_GOTO_SUBMAP
|
static int |
STATUS_IN_PROGRESS
|
Method Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
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 |
getInstructionSheetId()
Gets the instruction sheet id |
int |
getOccurrenceId()
Gets the occurrence id. |
int |
getStepId()
Gets the step id. |
int |
getStepStatus()
Gets the step status of this step occurrence |
boolean |
hasNext()
Indicates whether another element can be fetched from this VWStepOccurrenceHistory instance. |
VWStepWorkObjectHistory |
next()
Retrieves the subsequent element for this VWStepOccurrenceHistory instance. |
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
public static final int STATUS_GOTO_SUBMAP
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
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
VWException
public boolean hasNext() throws VWException
true
if there are more elements that can be
fetched. VWException
public VWStepWorkObjectHistory next() throws VWException
To use this method, create a VWStepOccurrenceHistory object with
a VWStepHistory.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 int getOccurrenceId()
public int getStepId()
public int getInstructionSheetId()
public java.util.Date getDateReceived() throws VWException
VWException
public java.util.Date getCompletionDate() throws VWException
VWException
public int getStepStatus() throws VWException
VWException
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |