|
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.VWFieldsObject | +--filenet.vw.api.VWWorkElement | +--filenet.vw.api.VWWorkObject
Use this class to access all data fields in a work object and fetch Instruction Element information associated with the work object.
Create an instance of this class with the following methods:
Field Summary | |
static int |
FIELD_SYSTEM_DEFINED
Value of 2. Indicates that the data field was created by the system. |
static int |
FIELD_USER_AND_SYSTEM_DEFINED
Value of 3. Indicates that the data field was created by the system but is being controlled by the user. |
static int |
FIELD_USER_DEFINED
Value of 1. Indicates that the data field was created by the user. |
Method Summary | |
void |
doAbort()
Unlock this work object without updating its fields. |
void |
doDelete(boolean overrideLock,
boolean force)
Delete this work object. |
static VWException[] |
doDeleteMany(VWWorkObject[] elements,
boolean overrideLock,
boolean force)
Deletes the specified work objects. |
void |
doDispatch()
Saves changes made in this work object, unlocks it, and moves the current step to the next workflow step. |
void |
doLock(boolean overrideLock)
Locks the work object. |
static VWException[] |
doLockMany(VWWorkObject[] wobjs,
boolean overrideLock)
Locks multiple work objects in a single call and refreshes them with current information. |
void |
doReassign(java.lang.String participant,
boolean delegateFlag,
java.lang.String queueName)
Delegates the current step assignment associated with this work object to another participant. |
void |
doRefresh(boolean lock,
boolean overrideLock)
Retrieves an updated version of the work object to get recent data. |
void |
doReturnToSource()
Returns the work object to the queue from which it was originally reassigned or delegated. |
void |
doSave(boolean unlock)
Saves this work object. |
static VWException[] |
doSaveMany(VWWorkObject[] workObjects)
Saves information for an array of work objects. |
void |
doTerminate()
Terminate this work object. |
static VWException[] |
doTerminateMany(VWWorkObject[] elements)
Terminates the specified work objects. |
static VWException[] |
doUnlockMany(VWWorkObject[] workObjects,
boolean save,
boolean dispatch)
Unlocks an array of work objects. |
VWInstructionElement |
fetchInstructionElement(boolean lock,
boolean overrideLock)
Fetches the Instruction Element information associated with this work object. |
int |
fetchLockedStatus()
Retrieves the lock status of the work object. |
VWProcess |
fetchProcess()
Retrieves the workflow process that contains this work object. |
VWReturnStackElement[] |
fetchReturnStackElements()
Retrieves work object return stack. |
VWStepElement |
fetchStepElement()
Fetches the current step in the workflow process. |
VWStepProcessorInfo |
fetchStepProcessorInfo()
Retrieves the step processor information necessary for launching a step. |
java.lang.String |
getCallMap()
Gets the name of the workflow map you specified in the setCallMap method. |
java.lang.String |
getComment()
Retrieves the comment for this step. |
java.lang.String |
getCurrentQueueName()
Retrieves the queue in which this work object resides. |
VWDataField[] |
getDataFields(int fieldTypeFlag,
int fieldCreatorFlag)
Retrieves a list of all data fields this work object supports. |
java.util.Date |
getDateReceived()
Retrieves the date on which you received this work object. |
java.util.Date |
getDeadline()
Retrieve the date by which the step should be completed. |
java.lang.String |
getExceptionDescription()
Gets the value the workflow author set for the description of the Process exception. |
java.lang.String |
getExceptionInstructionSheet()
Deprecated. Replaced by getExceptionMap() |
java.lang.String |
getExceptionMap()
Retrieves the name of the Process Engine exception that corresponds to the workflow map. |
java.lang.String[] |
getFieldNames()
Retrieves the names of the data fields this work object supports. |
java.lang.Object |
getFieldValue(java.lang.String fieldName)
Retrieves the value of a data field. |
java.lang.String |
getInstructionSheetName()
Retrieves the name of the instruction sheet containing the instruction the work object is currently processing. |
boolean |
getIsAltered()
Determines whether any data field has changed. |
boolean |
getIsTracker()
Determines whether this a tracker work object. |
java.lang.String |
getLastErrorNumber()
Retrieves the last error number of the return stack frame for this work object. |
java.lang.String |
getLastErrorText()
Retrieves the last error text of the return stack frame for this work object. |
java.util.Date |
getLaunchDate()
Retrieves the date on which the workflow process that contains this work object was launched. |
java.lang.String |
getLockedUser()
Retrieves the name of the user who locked the work object. |
java.lang.String |
getOperationName()
Retrieves the name of the current operation on the work object. |
int |
getOperationType()
Retrieves the operation type of the current work order. |
java.lang.String |
getOriginator()
Retrieves the name of the user who initiated the workflow process that contains this work object. |
int |
getOverdue()
Retrieves the status of the overdue notice. |
java.lang.String |
getParticipantName()
Retrieves the name of the participant who is processing this work object. |
VWProcess |
getProcess()
Deprecated. Replaced by fetchProcess() |
java.util.Date |
getReminder()
Retrieves the date on which a reminder is to be issued for the step. |
java.lang.String |
getRosterName()
Retrieves the name of the roster for this work object. |
java.lang.String |
getSelectedResponse()
Retrieves your response to this work object. |
int |
getServerLocation()
Gets the current server location of the work object. |
java.lang.String |
getStepName()
Gets the step name. |
java.lang.String[] |
getStepResponses()
Retrieves the list of available responses in this work object. |
java.lang.String |
getSubject()
Retrieves the subject of the workflow associated with this step. |
java.lang.String |
getTag()
Retrieves a string version of the work object tag. |
java.lang.String[] |
getTrackers()
Retrieves the list of trackers associated with this work object. |
java.lang.String |
getWorkClassName()
Retrieves the name of the work class from which the application instantiates this work object. |
java.lang.String |
getWorkflowName()
Retrieves the name of the workflow associated with this step. |
java.lang.String |
getWorkflowNumber()
Retrieves the string version of the workflow number. |
java.lang.String |
getWorkFlowNumber()
Deprecated. Replaced by getWorkflowNumber() |
java.lang.String |
getWorkObjectName()
Retrieves the work object name. |
java.lang.String |
getWorkObjectNumber()
Retrieves a string version of the work object number. |
int |
getWorkOrderId()
Retrieves the work order ID associated with this work object. |
java.lang.String |
getWorkPerformerClassName()
Retrieves the name of the Work Performer Class associated with the queue on which the work object resides. |
boolean |
hasBeenAltered(java.lang.String fieldName)
Determines whether a specific field has changed. |
boolean |
hasFieldName(java.lang.String fieldName)
Determines whether the specified data field exists. |
void |
lock(boolean overrideLock)
Deprecated. Replaced by doLock( boolean) |
static VWException[] |
lockMany(VWWorkObject[] wobjs,
boolean overrideLock)
Deprecated. Replaced by doLockMany(VWWorkObject[], boolean) |
void |
refresh(boolean lock,
boolean overrideLock)
Deprecated. Replaced by doRefresh(boolean, boolean) |
void |
save()
Deprecated. Replaced by doSave(boolean) |
static VWException[] |
saveMany(VWWorkObject[] workObjects)
Deprecated. Replaced by doSaveMany(VWWorkObject[]) |
void |
setCallMap(java.lang.String aMapName)
Specifies a map to be called when the system dispatches this work object. |
void |
setDataFields(VWDataField[] dataFields,
boolean compareValues)
Changes the values for specified data fields. |
void |
setException(java.lang.String aInstructionSheetName,
java.lang.String aDescription)
Sets an exception condition for a work object. |
void |
setFieldValue(java.lang.String fieldName,
java.lang.Object fieldValue)
Deprecated. Replaced by setFieldValue(String, Object, boolean) |
void |
setFieldValue(java.lang.String fieldName,
java.lang.Object fieldValue,
boolean compareValue)
Changes the value of a specified data field. |
void |
setSelectedResponse(java.lang.String response)
Changes the selected (default) response for this work object. |
void |
terminate()
Deprecated. Replaced by doTerminate() |
static VWException[] |
terminateMany(VWWorkObject[] elements)
Deprecated. Replaced by doTerminateMany( VWWorkObject[]) |
java.lang.String |
toString()
Retrieves the string version of the work object name. |
void |
unlock(boolean save,
boolean dispatch)
Deprecated. Replaced by doSave(boolean) |
static VWException[] |
unlockMany(VWWorkObject[] workObjects,
boolean save,
boolean dispatch)
Deprecated. Replaced by doUnlockMany(VWWorkObject[], boolean, boolean) |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int FIELD_USER_DEFINED
public static final int FIELD_SYSTEM_DEFINED
public static final int FIELD_USER_AND_SYSTEM_DEFINED
Method Detail |
public VWInstructionElement fetchInstructionElement(boolean lock, boolean overrideLock) throws VWException
lock
- Specify true
to lock the work object;
specify false
to leave the work object in its existing state.overrideLock
- Specify true
to override
locks on the work object; specify false
to keep the lock in
place.VWException
- public void refresh(boolean lock, boolean overrideLock) throws VWException
doRefresh(boolean, boolean)
lock
- Specify true
to lock the work
object; specify false
to leave the work object in it existing
state.overrideLock
- Specify true
to override
locks on the work object; specify false
to keep the lock in
place.VWException
- This method throws an exception when a there
is a change in the current queue contents since the last
refresh. Such a change occurs when a work object is removed
from the current queue or when a work object is fetched from
another queue, in the course of ordinary workflow activity.
The developer should take measures to prevent superfluous error
messages in such situations.public void doRefresh(boolean lock, boolean overrideLock) throws VWException
lock
- Specify true
to lock the work
object; specify false
to leave the work object in its existing
state.overrideLock
- Specify true
to override
locks on the work object; specify false
to keep the lock in place.VWException
- This method throws an exception when a there
is a change in the current queue contents since the last
refresh. Such a change occurs when a work object is removed
from the current queue or when a work object is fetched from
another queue, in the course of ordinary workflow activity.
The developer should take measures to prevent superfluous error
messages in such situations.public static VWException[] unlockMany(VWWorkObject[] workObjects, boolean save, boolean dispatch) throws VWException
doUnlockMany(VWWorkObject[], boolean, boolean)
workObjects
- An array of work objects to unlock.save
- Specify true
to save the work
object data field values.dispatch
- Specify true
to dispatch the
work objects contained in the array. Work objects must be
saved before being dispatched.VWException
- Thrown if the method cannot
unlock an array of work objects.public static VWException[] doUnlockMany(VWWorkObject[] workObjects, boolean save, boolean dispatch) throws VWException
workObjects
- An array of work objects to unlock.save
- Specify true
to save the work
object data field values.dispatch
- Specify true
to dispatch the
work objects contained in the array. Work objects must be
saved before being dispatched.VWException
- Thrown if the method
cannot unlock an array of work objects.public static VWException[] saveMany(VWWorkObject[] workObjects) throws VWException
doSaveMany(VWWorkObject[])
workObjects
- An array of work objects to save.VWException
- Thrown if the method
cannot save information for an array of work objects.public static VWException[] doSaveMany(VWWorkObject[] workObjects) throws VWException
workObjects
- An array of work objects to save.VWException
- Thrown if the method cannot
save information for an array of work objects.public void unlock(boolean save, boolean dispatch) throws VWException
doSave(boolean)
save
- Specify true
to save the work
object data field values.dispatch
- Specify true
to dispatch the
work object. Work objects must be saved before being dispatched.VWException
- Thrown if the
system encounters a problem while attempting to unlock a work
object. For example, this method throws an exception if someone
other than the current user locked the work object.public void setException(java.lang.String aInstructionSheetName, java.lang.String aDescription) throws VWException
aInstructionSheetName
- The name of
the instruction sheet that the
Process Engine
executes when the system
raises the exception. When specifying a value for this
parameter, keep the following behavior in mind:
aDescription
- A string containing a description of the
exception to be raised. This is not a Java exception.VWException
- Thrown if the method cannot
set an exception condition for a work object.public java.lang.String getExceptionInstructionSheet()
getExceptionMap()
setException(String, String)
public java.lang.String getExceptionDescription()
setException(String, String)
public void save() throws VWException
doSave(boolean)
VWException
- Thrown if the
system encounters a problem while attempting to save the work
object; for example, this method throws an exception if someone
other than the current user locked the work object.public static VWException[] lockMany(VWWorkObject[] wobjs, boolean overrideLock) throws VWException
doLockMany(VWWorkObject[], boolean)
wobjs
- An array of work objects to lock.overrideLock
- Specify true
to override
locks. System locks cannot be overidden.VWException
- Thrown if a
general system error of some kind occurs, such as a file permission
problem ir database malfunctioning.public static VWException[] doLockMany(VWWorkObject[] wobjs, boolean overrideLock) throws VWException
wobjs
- An array of work objects to lock.overrideLock
- Specify true
to override
locks. System locks cannot be overidden.VWException
- Thrown if the method cannot
lock multiple work objects in a single call and refresh
them with current information.public void lock(boolean overrideLock) throws VWException
doLock( boolean)
overrideLock
- Specify true
to override
locks. System locks cannot be overridden.VWException
- Thrown if the method cannot
lock the work object.public void doLock(boolean overrideLock) throws VWException
overrideLock
- Specify true
to override
locks. System locks cannot be overridden.VWException
- Thrown if the method cannot
lock the work object.public static VWException[] terminateMany(VWWorkObject[] elements) throws VWException
doTerminateMany( VWWorkObject[])
elements
- An array of work objects to terminate.VWException
- Thrown if the method
cannot terminate the specified work objects.public static VWException[] doTerminateMany(VWWorkObject[] elements) throws VWException
elements
- An array of work objects to terminate.VWException
- Thrown if the method cannot
terminate the specified work objects.public void terminate() throws VWException
doTerminate()
VWException
- Thrown if the method cannot
terminate the current work object; for example, if someone
other than the caller locked the work object.public void doTerminate() throws VWException
VWException
- Thrown if the method cannot
terminate the current work object; for example, if someone
other than the caller locked the work object.public static VWException[] doDeleteMany(VWWorkObject[] elements, boolean overrideLock, boolean force) throws VWException
elements
- An array of work objects to delete.overrideLock
- Specify true
to delete the work objects regardless of
their locked state.force
- Specify true
to force the work objects to be deleted (use only
for corrupted work objects).VWException
- Thrown if the method cannot
delete the specified work objects.public void doDelete(boolean overrideLock, boolean force) throws VWException
overrideLock
- Specify true
to delete the work object regardless of
the locked state.force
- Specify true
to force the work object to be deleted (use only
for corrupted work objects).VWException
- Thrown if the method cannot
delete the current work object.public int fetchLockedStatus() throws VWException
VWException
- Thrown if the method cannot
retrieve the lock status of the work object; for example, if it cannot
execute a network call.VWQueueElement(for status definitions)
public java.lang.String[] getFieldNames()
public java.lang.Object getFieldValue(java.lang.String fieldName) throws VWException
fieldName
- The name of the data field.VWException
- Thrown if the
name for the data field does not exist.public void setFieldValue(java.lang.String fieldName, java.lang.Object fieldValue) throws VWException
setFieldValue(String, Object, boolean)
fieldName
- The name of the data field.fieldValue
- An object containing the new value for the
data field.VWException
- Thrown if the
system cannot find the data field specified in the fieldName
parameter.public void setFieldValue(java.lang.String fieldName, java.lang.Object fieldValue, boolean compareValue) throws VWException
fieldName
- The name of the data field.fieldValue
- An object containing the new value for the
data field.compareValue
- Specify true
to set only
the values modified; otherwise, specify false
if you want all
values in a field to flag they are modified.VWException
- Thrown if the
system cannot find the data field specified in the fieldName
parameter.public boolean hasFieldName(java.lang.String fieldName) throws VWException
fieldName
- The name of the data field to
check.true
if the system
finds the data field specified in the fieldName parameter.VWException
- Thrown if the
fieldName parameter is null.public boolean getIsAltered()
true
if any data
field values have changed; otherwise, this method returns
false
.public boolean hasBeenAltered(java.lang.String fieldName) throws VWException
true
if the values
in the data field specified in the fieldName parameter
has changed; otherwise, this method returns false
.VWException
- Thrown if the
fieldName parameter is null.public java.lang.String getWorkObjectName() throws VWException
VWException
- Thrown if the method cannot
retrieve the work object name.public java.lang.String getWorkObjectNumber() throws VWException
VWException
- Thrown if the method cannot
retrieve a string version of the work object number.public java.lang.String getTag() throws VWException
VWException
- Thrown if the method cannot
retrieve a string version of the work object tag.public java.lang.String getWorkClassName() throws VWException
VWException
- Thrown if the method cannot
retrieve the name of the work class from which the
application instantiates this work object.public java.lang.String getWorkPerformerClassName() throws VWException
VWException
- Thrown if the method cannot
retrieve the name of the Work Performer Class associated with
the queue on which the work object resides.public java.lang.String getOperationName() throws VWException
VWException
- Thrown if the method cannot
retrieve the name of the current operation on the work
object.public java.lang.String toString()
toString
in class java.lang.Object
public void doAbort() throws VWException
VWException
- Thrown if the
system encounters an error while attempting to the work object.public void doDispatch() throws VWException
VWException
- Thrown if the
system encounters an error while attempting to save the
current step or move the step to the next workflow step.public VWProcess getProcess() throws VWException
fetchProcess()
VWException
- Thrown if the
system cannot fetch the workflow process.public VWProcess fetchProcess() throws VWException
VWException
- Thrown if the
system cannot fetch the workflow process.public VWStepElement fetchStepElement() throws VWException
VWException
- Thrown if the
system cannot fetch the step element.public java.util.Date getDateReceived() throws VWException
VWException
- Thrown if the
system encounters an error while attempting to retrieve the date.public java.lang.String getExceptionMap()
public VWDataField[] getDataFields(int fieldTypeFlag, int fieldCreatorFlag) throws VWException
fieldTypeflag
- An integer value acting as a flag the
user sets to specify which parameter types to return, adding
(using a logical OR operation ) the VWFieldTypes desired to
create the flag.fieldCreatorFlag
- An integer value that flags the type or
types of returned fields. The flag set may be set to any of the
following literal values:
Combining FIELD_USER_DEFINED and FIELD_SYSTEM_DEFINED, using a logical OR operation, is also allowed.
VWException
- Thrown if the
system encounters an error while attempting to return data
field elements.VWDataField
public java.util.Date getLaunchDate() throws VWException
VWException
- Thrown if the
system encounters an error while attempting to retrieve the
workflow process launch date.public java.lang.String getOriginator() throws VWException
VWException
- Thrown if the
system encounters an error while attempting to retrieve the
name of the workflow originator.public java.lang.String getParticipantName() throws VWException
VWException
- Thrown if the
system encounters an error while attempting to retrieve the
participant name.public void doReassign(java.lang.String participant, boolean delegateFlag, java.lang.String queueName) throws VWException
participant
- The name of the
participant to whom you reassign this step.
delegateFlag
- Specify true
if you
delegate the assignment and plan to review the completed
assignment.
queueName
- The name of the queue to
which you wish to move the work object. If the queueName is
null, the destination queue will default to the current queue
of the work item when the current queue is a user-centric queue.
When the current queue is not a user-centric queue, the
destination queue will default to "Inbox".VWException
- Thrown if the
system encounters an error while attempting to reassign the
current step.public void doReturnToSource() throws VWException
VWException
- Thrown if the
system encounters an error while attempting to move the work
object.public void doSave(boolean unlock) throws VWException
unlock
- Specify true
to unlock and save
the work object; otherwise, specify false
to maintain the
current lock and save the work object.VWException
- Thrown if the
system encounters an error while attempting to save the work
object. For example, this method throws an exception if someone
other than the current user locked the work object.public java.lang.String getWorkflowName() throws VWException
VWException
- Thrown if the method cannot
retrieve the name of the workflow associated with this step.public java.lang.String getLockedUser() throws VWException
VWException
- Thrown if the method cannot
retrieve the name of the user who locked the work object.public void setDataFields(VWDataField[] dataFields, boolean compareValues) throws VWException
dataFields
- An array of VWDataField objects that contain
the values to be set in the data fields.compareValues
- Specify true
to set only
the values modified; otherwise, specify false
if you want all
values in a field to flag they are modified.VWException
- Thrown if the
system cannot set a field specified in the dataFields parameter.public boolean getIsTracker() throws VWException
true
if the work object is a
tracker; otherwise, this method returns false
.VWException
- Thrown if the
system encounters an error while attempting to the tracker flag.public java.lang.String getRosterName() throws VWException
VWException
- Thrown if the
system encounters an error while attempting to retrieve the
roster name.public java.lang.String getWorkFlowNumber() throws VWException
getWorkflowNumber()
getWorkFlowNumber
in class filenet.vw.api.VWFieldsObject
VWException
- Thrown if the method cannot
retrieve the string version of the workflow number, which
corresponds to the F_WorkFlowNumber.public java.lang.String getWorkflowNumber() throws VWException
VWException
- Thrown if the method cannot
retrieve the string version of the workflow number.public java.lang.String[] getTrackers() throws VWException
VWException
- Thrown if the method cannot
retrieve the list of trackers associated with this work object.public int getWorkOrderId() throws VWException
VWException
- Thrown if the method cannot
retrieve the work order ID associated with this work object.public java.util.Date getDeadline() throws VWException
VWException
- Thrown if the
system encounters an error while attempting to retrieve the
dead line date.public java.util.Date getReminder() throws VWException
VWException
- Thrown if the
system encounters an error while attempting to retrieve the
reminder date.public int getOverdue() throws VWException
VWException
- Thrown if the
system encounters an error while attempting to retrieve the
overdue status.public int getOperationType() throws VWException
VWException
- Thrown if the method cannot
retrieve the operation type of the current work order.public java.lang.String getCurrentQueueName() throws VWException
VWException
- Thrown if the method cannot
retrieve the queue in which this work object resides.public VWStepProcessorInfo fetchStepProcessorInfo() throws VWException
VWException
- Thrown if the method cannot
retrieve the step processor information necessary for
launching a step.public java.lang.String getComment() throws VWException
VWException
- Thrown if the
system encounters an error while attempting to retrieve the
comment.public java.lang.String getSubject() throws VWException
VWException
- Thrown if the method cannot
retrieve the subject of the workflow associated with this step.public java.lang.String getInstructionSheetName() throws VWException
VWException
- Thrown if the method cannot
retrieve the name of the instruction sheet containing the
instruction the work object is currently processing.public java.lang.String[] getStepResponses() throws VWException
VWException
- Thrown if the
system encounters an error while attempting to retrieve the
available responses.public java.lang.String getSelectedResponse() throws VWException
VWException
- Thrown if the
system encounters an error while attempting to retrieve the
selected response.public void setSelectedResponse(java.lang.String response) throws VWException
response
- The new selected response.VWException
- Thrown if the
system encounters an error while attempting to set the
selected response.public void setCallMap(java.lang.String aMapName) throws VWException
Saving the work item updates an execution stack for the work object, but it will not dispatch the item to the next queue. The work item does not move to another queue until it is dispatched.
aMapName
- The name of
the map to execute when the system dispatch is called.VWException
- Thrown if the method
cannot set a map to be called
when the system dispatches this work object.public java.lang.String getCallMap()
public VWReturnStackElement[] fetchReturnStackElements() throws VWException
VWException
- If the complete return stack elements cannot be returned.public java.lang.String getLastErrorNumber() throws VWException
VWException
- Thrown if the method cannot
retrieve the last error numberpublic java.lang.String getLastErrorText() throws VWException
VWException
- Thrown if the method cannot
retrieve the last error textpublic java.lang.String getStepName() throws VWException
VWException
- Thrown if the method is unable to get a string
containing the step name.public int getServerLocation() throws VWException
VWException
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |