|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWProcess
public final class 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: Used in the filterFlags parameter of the fetchFilteredWorkflowHistory method
to specify that only completed step history data is to be returned. |
static int |
FILTER_NONE
Value of 0: Used in the filterFlags parameter of the fetchFilteredWorkflowHistory method
to specify that all step history data is to be returned. |
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. |
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 associated with the specified workflow map. |
VWMilestoneElement[] |
fetchFilteredWorkflowMilestones(int level,
boolean bLastOnly,
boolean bReachedOnly)
Fetches the milestone data for this workflow process, based on the filtering levels specified. |
VWWorkflowMilestones |
fetchReachedWorkflowMilestones(int theLevel)
Fetches the milestone events reached, based on the milestone level specified. |
VWWorkflowDefinition |
fetchWorkflowDefinition()
Deprecated. Replaced by fetchWorkflowDefinition
Fetches the workflow definition for this workflow process. |
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. |
VWSession |
getSession()
Get the session associated with this mapnode definition. |
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. |
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. |
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
method
to specify that all step history data is to be returned.
public static final int FILTER_COMPLETED_STEP_HISTORY
fetchFilteredWorkflowHistory
method
to specify that only completed step history data is to be returned.
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 VWWorkflowMilestones fetchReachedWorkflowMilestones(int theLevel) throws VWException
theLevel
- An integer indicating the milestone level (see VWMilestoneDefinition.setLevel
and VWMilestoneDefinition.getLevel
) to use as the limiting level. Milestones having a level value less than
or equal to this value will be fetched from the event log.
VWException
VWMilestoneDefinition
public VWMilestoneElement[] fetchFilteredWorkflowMilestones(int level, boolean bLastOnly, boolean bReachedOnly) throws VWException
level
- An integer indicating the milestone level (see VWMilestoneDefinition.setLevel
and VWMilestoneDefinition.getLevel
) to use as the limiting level. Only milestones having a level value less
than or equal to this value will be fetched from the event log.
bLastOnly
- A boolean of true indicates the fetch operation is further limited to
the milestone objects with the latest timestamp; false indicates the fetch
does not eliminate milestone objects on the basis of timestamp.
bReachedOnly
- A boolean value of true indicates the fetch operation is further limited to
the reached milestone objects; false indicates the fetch is not limited on
the basis of whether the milestone is reached.
VWException
VWMilestoneDefinition
public VWWorkflowHistory fetchWorkflowHistory(int instructionSheetID) throws VWException
instructionSheetID
- An integer indicating the ID of the associated VWMapDefinition 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 the associated roster name cannot be found.public java.lang.String getEventLogName() throws VWException
VWException
- Thrown if the associated event log name cannot be found.public java.lang.String getWorkClassName() throws VWException
VWException
- Thrown if the associated work class name cannot be found.public VWMilestoneDefinition[] getMilestoneDefinitions() throws VWException
VWException
- Thrown if the milestone data cannot be found.public VWWorkflowDefinition fetchWorkflowDefinition() throws VWException
fetchWorkflowDefinition
Fetches the workflow definition for this workflow process.
VWException
public VWWorkflowDefinition fetchWorkflowDefinition(boolean convert) throws VWException
convert
- A boolean value of true
indicates that the fetched workflow definition should be
converted. This ensures thatthe workflow definition is correct and
complete in the following situations:
A value of false indicates that conversion (for the purposes indicated above) is not necessary, and the returned workflow definition should be in the same form as it was before it was transferred to the server.
VWException
public VWWorkflowHistory fetchFilteredWorkflowHistory(int mapId, int filterFlag) throws VWException
mapId
- An integer 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
public VWSession getSession() throws VWException
VWException
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |