|
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.
VWProcess 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.
VWQueueElement
,
VWRosterElement
,
VWStepElement
,
VWWorkObject
,
VWFetchType
,
VWStepHistory
, Serialized FormField Summary | |
static int |
FILTER_COMPLETED_STEP_HISTORY
Value of 1: use this in the in the filterFlags parameter of the fetchFilteredWorkflowHistory(int, int) method to specify only
completed step history data to be returned. |
static int |
FILTER_NONE
Value of 0: use this in the filterFlags parameter of the fetchFilteredWorkflowHistory(int, int) method to specify
that all step history data be returned. |
Method Summary | |
void |
delete()
Deletes all work objects of a running workflow process. |
VWWorkflowHistory |
fetchFilteredWorkflowHistory(int mapId,
int filterFlag)
Fetches step history data for the current workflow process that is associated with this workflow map ID, specified to be either completed step history only, or all history data. |
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 level 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()
Deprecated. Replaced by fetchWorkflowDefinition(boolean), which can handle workflow definitions that reference work classes from a previous version of Process that was known as Panagon Visual WorkFlo. This method also can include references to workflow definitions that need to explicitly incorporate a default terminate or malfunction map. |
VWWorkflowDefinition |
fetchWorkflowDefinition(boolean convert)
Fetches 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 work objects to retrieve. |
VWWorkObject |
next()
Retrieves the subsequent work object in the series of active work objects associated with this process. Invoke this method repeatedly to retrieve a series of active work objects. Returns null when no more active work objects can be returned. |
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 |
Field Detail |
public static final int FILTER_NONE
fetchFilteredWorkflowHistory(int, int)
method to specify
that all step history data be returned.public static final int FILTER_COMPLETED_STEP_HISTORY
fetchFilteredWorkflowHistory(int, int)
method to specify only
completed step history data to be returned.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
- VWMilestoneDefinition
,
VWMilestoneDefinition.setLevel(int)
public VWMilestoneElement[] fetchFilteredWorkflowMilestones(int level, boolean bLastOnly, boolean bReachedOnly) throws VWException
level
- 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
- 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
- public VWWorkObject next() throws VWException
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 retrieval
buffer size. To change the current retrieval buffer size, set it
with a setBufferSize(int) call.
Note
This method
requires a buffer size greater than 1 to operate properly.
VWException
- hasNext()
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
true
if there are more
elements that can be fetched.VWException
- next()
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
- public VWWorkflowDefinition fetchWorkflowDefinition(boolean convert) throws VWException
convert
- The value true
indicates that the fetched workflow definition should be
converted, so that the workflow definition is correct and
complete in the following situations:
false
value indicates
that the returned workflow definition should be in the same form
as it was before it was transferred to the server.
Conversion is not necessary if the returned workflow definition does not need to include inherited (not explicitly defined) terminate or malfunction maps, and the referenced work class has not been transferred from a previous version of Process that was known as Panagon Visual WorkFlo.
VWException
- public VWWorkflowHistory fetchFilteredWorkflowHistory(int mapId, int filterFlag) throws VWException
mapId
- The integer value for the ID of the workflow map
definition object.filterFlag
- Set this to FILTER_COMPLETED_STEP_HISTORY
(value of 1) if you want the method to exclusively return
completed step history data, or FILTER_NONE (value of 0) to
return all history data.VWException
- fetchWorkflowHistory(int)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |