|
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 calling the VWWorkflowHistory.next()
or VWWorkflowHistory.fetchStepHistory(int)
method. Once
this object is created, step occurrence history items can be
fetched with the next() method.
VWStepHistory contains methods next()
and hasNext()
which function similarly to the next() and hasNext()
methods in the Iterator interface in Java 2 to retrieve all
active work objects in this workflow.
A retrieval series completes when the next() method returns a null
value.
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()
Indicates whether another element can be fetched from this VWStepHistory instance. |
boolean |
isCompoundStep()
Indicates whether the step type of the current history object is a compound step. |
VWStepOccurrenceHistory |
next()
Retrieves the subsequent element for this VWStepHistory instance. Invoke this method repeatedly to retrieve a series of VWStepOccurrenceHistory objects. |
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()
true
if there are more queue
elements that can be fetched.
public void resetFetch()
public VWStepOccurrenceHistory next() throws VWException
To use this method, create a VWStepHistory object with a
VWWorkflowHistory.next()
or VWWorkflowHistory.fetchStepHistory(int)
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).
Note
This method
requires a buffer size greater than 1 to operate properly.
The default buffersize is 50.
VWException
- public int getStepId()
public java.lang.String getStepName()
public boolean isCompoundStep()
true
if the current history object is a
compound step.VWCompoundStepDefinition
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |