|
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.VWProcess
Use this class to access information about an executing workflow, such as status, history, or child/split work object information.
VWQueueElement
,
VWRosterElement
,
VWStepElement
,
VWWorkObject
,
VWFetchType
,
VWStepHistory
, Serialized FormMethod Summary | |
void |
delete()
Deletes all work objects of a running workflow process. |
VWMilestoneElement[] |
fetchFilteredWorkflowMilestones(int level,
boolean bLastOnly,
boolean bReachedOnly)
Fetches the milestone data for this workflow process, in which the milestone events have a level property less than or equal to the "theLevel" parameter passed to this method. |
VWWorkflowMilestones |
fetchReachedWorkflowMilestones(int theLevel)
Fetches milestone events with a level property less than or equal to the value of the "theLevel" parameter passed to this method. |
VWWorkflowDefinition |
fetchWorkflowDefinition()
Fetch the workflow definition for this workflow process. |
VWWorkflowHistory |
fetchWorkflowHistory(int instructionSheetID)
Fetches the history data for this workflow process that is associated with this workflow instruction sheet ID. |
int |
getBufferSize()
Gets the value of the buffer size setting. |
java.lang.String |
getEventLogName()
Gets the event log name of this workflow process. |
VWMilestoneDefinition[] |
getMilestoneDefinitions()
Gets the milestone data for this workflow process. |
java.lang.String |
getRosterName()
Gets the roster name of this workflow process. |
java.lang.String |
getWorkClassName()
Gets the work class name associated with this workflow process. |
boolean |
hasNext()
Determines whether there are more elements to retrieve. |
VWWorkObject |
next()
Retrieves an active work object. Invoke this method repeatedly to retrieve each active work object associated with the workflow process. |
void |
resetFetch()
Sets the fetch items count to zero (0) so the application can refetch items. |
void |
setBufferSize(int newSize)
Sets the maximum number of elements to return in a fetch. The default value is 100. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public VWWorkflowMilestones fetchReachedWorkflowMilestones(int theLevel) throws VWException
theLevel
- An integer value that is the criterion milestone
event level. Milestone events whose level value is less than
or equal to this value will be fetched from the event log.VWException
- Thrown if this method cannot fetch the
milestone data for this workflow process that is associated
with this workflow.VWMilestoneDefinition
,
VWMilestoneDefinition.setLevel(int)
public VWMilestoneElement[] fetchFilteredWorkflowMilestones(int level, boolean bLastOnly, boolean bReachedOnly) throws VWException
theLevel
- An integer value that is the criterion level
for the fetches. Only milestone events whose level value is less
than or equal to this value will be fetched from the event log.
bLastOnly
- A boolean value. 'True' limits fetches to be
to the milestone objects with the latest timestamp; 'false'
does not eliminate milestone objects on the basis of timestamp.
bReachedOnly
- A boolean value. 'True' limits fetches to
the reached milestone objects; 'false' does not limit fetches on
the basis of whether the milestone is reached.
VWException
- Thrown if this method cannot fetch the
milestone data for this workflow process.VWMilestoneDefinition
,
VWMilestoneDefinition.setLevel(int)
public VWWorkflowHistory fetchWorkflowHistory(int instructionSheetID) throws VWException
instructionSheetID
- The integer value for the ID of
the workflow map definition object.VWException
- Thrown if this method cannot
fetch the history data for this workflow process that is
associated with this workflow instruction sheet ID.public VWWorkObject next() throws VWException
Next fetches work objects sequentially. The application queries the server for the next block of data, once it has exhausted the currently buffered data. An element returns as long as there is an active work object associated with this workflow process.
The application retrieves work objects from the database in
blocks of the size specified in the setBufferSize(int)
method.
The server imposes a maximum block size, as well; therefore, the
effective block size may be smaller than the number specified
in VWProcess.setBufferSize. The blocksizes may differ
if the work objects are large or if the server reaches its limit.
VWException
- The method throws an exception if there
is an error in retrieving a work object from the server.public int getBufferSize()
public void setBufferSize(int newSize) throws VWException
newSize
- An integer value to use for setting the
maximum number of elements to return in a fetch. The value
must be greater than zero (0).VWException
- The method throws an exception if the
buffer is less than or equal to zero (0).public boolean hasNext() throws VWException
VWException
- This method returns an exception if it
cannot determine whether there are more elements to retrieve.public void resetFetch()
fetchWorkflowHistory(int)
,
VWWorkflowDefinition
public void delete() throws VWException
VWException
- Thrown if a
work object cannot be deleted. Even if only one work object
cannot be deleted, the entire deletion fails.public java.lang.String getRosterName() throws VWException
VWException
- Thrown if this method cannot
get the roster name of this workflow process.public java.lang.String getEventLogName() throws VWException
VWException
- Thrown if this method cannot
get the event log name of this workflow process.public java.lang.String getWorkClassName() throws VWException
VWException
- Thrown if this method cannot
get the work class name associated with this workflow process.public VWMilestoneDefinition[] getMilestoneDefinitions() throws VWException
VWException
- Thrown if this method cannot
get the milestone data for this workflow process.public VWWorkflowDefinition fetchWorkflowDefinition() throws VWException
VWException
-
|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |