Process API

filenet.vw.api
Class VWWorkObject

java.lang.Object
  extended by filenet.vw.api.VWWorkObject
All Implemented Interfaces:
java.io.Serializable

public final class VWWorkObject
extends java.lang.Object
implements java.io.Serializable

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:

See Also:
Serialized Form

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
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 doAbort()
          Unlocks 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 doReassignByDomain(java.lang.String theDomainName, java.lang.String participant, boolean delegateFlag, java.lang.String queueName)
          Changes the participant responsible for processing the current step.
 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)
          Deprecated. Use fetchStepElement instead. 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 containing this instance.
 VWReturnStackElement[] fetchReturnStackElements()
          Retrieves work object return stack.
 VWStepElement fetchStepElement()
          Fetches the current step in the workflow process.
 VWStepProcessorInfo fetchStepProcessorInfo()
          Fetches the step processor information associated with this instance.
 java.lang.String[] getAuthoredFieldNames()
          Retrieves the authored (untranslated) names of the data fields this work object supports.
 java.lang.String getAuthoredStepName()
          Gets the authored (untranslated) step name for this work object.
 java.lang.String getCallMap()
          Gets the name of the workflow map.
 java.lang.String getComment()
          Returns the comment for this step.
 java.lang.String getCurrentQueueName()
          Returns the name of the queue in which this work object resides.
 VWDataField getDataField(java.lang.String name)
          Gets the requested data field from the log element.
 VWDataField[] getDataFields(int fieldTypeFlag, int fieldCreatorFlag)
          Returns a list of all data fields this work object supports.
 java.util.Date getDateReceived()
          Returns the date on which the work object was last saved.
 java.util.Date getDeadline()
          Retrieve the date by which the step should be completed.
 java.lang.String getExceptionDescription()
          Gets the description of the Process Engine exception specified for this work object.
 java.lang.String getExceptionInstructionSheet()
          Deprecated. Replaced by getExceptionMap
 java.lang.String getExceptionMap()
          Returns the name of workflow map for the Process Engine exception specified in setException.
 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()
          Returns the name of the instruction sheet containing the instruction this 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()
          Returns the last error number of the return stack frame for this work object.
 java.lang.String getLastErrorText()
          Returns the last error text of the return stack frame for this work object.
 java.util.Date getLaunchDate()
          Returns the date on which the workflow process that contains this work object was launched.
 java.lang.String getLockedUser()
          Returns the name of the user who locked the work object.
 VWParticipant getLockedUserPx()
          Returns the VWParticipant (security) object that represents the user who locked the current work object.
 java.lang.String getOperationName()
          Returns the name of the current operation on this work object.
 int getOperationType()
          Returns the operation type of the current work order.
 java.lang.String getOriginator()
          Returns the name of the user who initiated the workflow process that contains this work object.
 VWParticipant getOriginatorPx()
          Returns the VWParticipant (security) object that represents the user who initiated the workflow process containing the current step.
 int getOverdue()
          Returns the status of the overdue notice.
 java.lang.String getParticipantName()
          Returns the short name of the participant who is processing this work object.
 VWParticipant getParticipantNamePx()
          Returns a VWParticipant (security) object that represents the current participant.
 VWProcess getProcess()
          Deprecated. Replaced by fetchProcess
 java.util.Date getReminder()
          Returns the date on which a reminder is to be issued for the step.
 java.lang.String getRosterName()
          Returns the name of the roster for this work object.
 java.lang.String getSelectedResponse()
          Returns default response (the value in the F_Response system field) for this work object.
 int getServerLocation()
          Gets the current server location of the work object.
 java.lang.String getStepDescription()
          Gets the description of the step.
 java.lang.String getStepName()
          Gets the step label (name) for this work object.
 java.lang.String[] getStepResponses()
          Returns the list of available responses for this work object.
 java.lang.String getSubject()
          Returns the subject of the workflow (the value in the F_Subject system field) associated with this work object.
 java.lang.String getTag()
          Returns a String version of the work object tag.
 java.lang.String[] getTrackers()
          Deprecated. Replaced by VWWorkObject.getTrackersPx(), which returns an array of VWParticipant objects for the tracker participants associated with this work object.
 VWParticipant[] getTrackersPx()
          Returns an array of VWParticipant objects for the tracker participants associated with this work object.
 java.lang.String getWorkClassName()
          Returns the name of the work class from which the application instantiates this work object.
 java.lang.String getWorkflowName()
          Returns the name of the workflow associated with this step.
 java.lang.String getWorkflowNumber()
          Gets the workflow number.
 java.lang.String getWorkFlowNumber()
          Deprecated. Replaced by getWorkflowNumber()
 java.lang.String getWorkObjectName()
          Returns the name of this work object.
 java.lang.String getWorkObjectNumber()
          Returns a string version of the work object number.
 int getWorkOrderId()
          Returns the work order ID associated with this work object; may be null.
 java.lang.String getWorkPerformerClassName()
          Returns the name of the work performer class associated with the queue on which the work object resides.
 boolean hasBeenAltered(java.lang.String fieldName)
          Indicates whether the specified field has changed in this work object.
 boolean hasFieldName(java.lang.String fieldName)
          Indicates whether the specified data field exists in this work object.
 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 this work object is dispatched.
 void setDataFields(VWDataField[] dataFields, boolean compareValues)
          Changes the values for specified data fields.
 void setException(java.lang.String aInstructionSheetName, java.lang.String aDescription)
          Sets a Process Engine exception condition (not a Java exception) for this 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 in this work object.
 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

FIELD_USER_DEFINED

public static final int FIELD_USER_DEFINED
Value of 1. Indicates that the data field was created by the user.

See Also:
Constant Field Values

FIELD_SYSTEM_DEFINED

public static final int FIELD_SYSTEM_DEFINED
Value of 2. Indicates that the data field was created by the system.

See Also:
Constant Field Values

FIELD_USER_AND_SYSTEM_DEFINED

public static final 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.

See Also:
Constant Field Values
Method Detail

_get_FILE_DATE

public static java.lang.String _get_FILE_DATE()
For FileNet internal use only, do not call.


_get_FILE_AUTHOR

public static java.lang.String _get_FILE_AUTHOR()
For FileNet internal use only, do not call.


_get_FILE_REVISION

public static java.lang.String _get_FILE_REVISION()
For FileNet internal use only, do not call.


fetchInstructionElement

public VWInstructionElement fetchInstructionElement(boolean lock,
                                                    boolean overrideLock)
                                             throws VWException
Deprecated. Use fetchStepElement instead. Fetches the instruction element information associated with this work object.

Parameters:
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.
Returns:
A VWInstructionElement object that represents this work object.
Throws:
VWException

refresh

public void refresh(boolean lock,
                    boolean overrideLock)
             throws VWException
Deprecated. Replaced by doRefresh(boolean, boolean)

Retrieves an updated version of the work object to get recent data.

Parameters:
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.
Throws:
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.

doRefresh

public void doRefresh(boolean lock,
                      boolean overrideLock)
               throws VWException
Retrieves an updated version of the work object to get recent data.

Parameters:
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.
Throws:
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.

unlockMany

public static VWException[] unlockMany(VWWorkObject[] workObjects,
                                       boolean save,
                                       boolean dispatch)
                                throws VWException
Deprecated. Replaced by doUnlockMany(VWWorkObject[], boolean, boolean)

Unlocks an array of work objects. The work objects must be from the same queue or roster. For example, each must be from the same VWQueueQuery or VWRosterQuery object.

Parameters:
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.
Returns:
An array of VWException objects that represent the input elements. If no input elements exist, this method returns an array of nulls, which indicates that all work objects were processed successfully.
Throws:
VWException - Thrown if the method cannot unlock an array of work objects.

doUnlockMany

public static VWException[] doUnlockMany(VWWorkObject[] workObjects,
                                         boolean save,
                                         boolean dispatch)
                                  throws VWException
Unlocks an array of work objects. The work objects must be from the same queue or roster. For example, each must be from the same VWQueueQuery or VWRosterQuery object.

Parameters:
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.
Returns:
An array of VWException objects that represent the input elements. If no input elements exist, this method returns an array of nulls, which indicates that all work objects were processed successfully.
Throws:
VWException - Thrown if the method cannot unlock an array of work objects.

saveMany

public static VWException[] saveMany(VWWorkObject[] workObjects)
                              throws VWException
Deprecated. Replaced by doSaveMany(VWWorkObject[])

Saves information for an array of work objects. The work objects must be from the same queue or roster. In particular, each must be from the same VWQueueQuery or VWRosterQuery object.

Parameters:
workObjects - An array of work objects to save.
Returns:
An array of VWException objects that represent the input elements. If no input elements exist, this method returns an array of nulls, which indicates that all work objects were processed successfully.
Throws:
VWException - Thrown if the method cannot save information for an array of work objects.

doSaveMany

public static VWException[] doSaveMany(VWWorkObject[] workObjects)
                                throws VWException
Saves information for an array of work objects. The work objects must be from the same queue or roster. For example, each must be from the same VWQueueQuery or VWRosterQuery object.

Parameters:
workObjects - An array of work objects to save.
Returns:
An array of VWException objects that represent the input elements. If no input elements exist, this method returns an array of nulls, which indicates that all work objects were processed successfully.
Throws:
VWException - Thrown if the method cannot save information for an array of work objects.

unlock

public void unlock(boolean save,
                   boolean dispatch)
            throws VWException
Deprecated. Replaced by doSave(boolean)

Unlocks a work object.

Parameters:
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.
Throws:
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.

setException

public void setException(java.lang.String aInstructionSheetName,
                         java.lang.String aDescription)
                  throws VWException
Sets a Process Engine exception condition (not a Java exception) for this work object. The exception occurs when this work object is saved or dispatched to the specified instruction sheet.

Any errors for the specified parameter values are caught only when the application saves or unlocks the work object with dispatch set.

Parameters:
aInstructionSheetName - A String containing the name of the instruction sheet that is to be executed when the Process engine exception is thrown. This defaults to null.

When specifying a value for this parameter, keep the following behavior in mind:

  • If null (the default), no exception is thrown.
  • If an instruction sheet is specified, the exception is thrown when the application unlocks and dispatches or saves this work object.
aDescription - A String containing a description of the Process Engine exception to be thrown.
Throws:
VWException - Thrown if exception condition cannot be set for this work object.
See Also:
getExceptionMap, getExceptionDescription

getExceptionInstructionSheet

public java.lang.String getExceptionInstructionSheet()
Deprecated. Replaced by getExceptionMap

Gets the value the workflow author set for the name of the Exception instruction sheet.

Returns:
The name of the instruction sheet to which to return if the Java application raises a Process exception. If the system is to raise an exception upon a dispatch or save, this method returns null. This is not a Java exception.
See Also:
setException(String, String)

getExceptionDescription

public java.lang.String getExceptionDescription()
Gets the description of the Process Engine exception specified for this work object. This is not a Java exception.

Returns:
A String containing the description of the Process Engine exception raised.
See Also:
setException

save

public void save()
          throws VWException
Deprecated. Replaced by doSave(boolean)

Saves the work object.

Throws:
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.

lockMany

public static VWException[] lockMany(VWWorkObject[] wobjs,
                                     boolean overrideLock)
                              throws VWException
Deprecated. Replaced by doLockMany(VWWorkObject[], boolean)

Locks multiple work objects in a single call and refreshes them with current information. The array of work objects must come from one of the following:

Parameters:
wobjs - An array of work objects to lock.
overrideLock - Specify true to override locks. System locks cannot be overidden.
Returns:
An array of VWException objects that represent the input elements. If no input elements exist, this method returns an array of nulls, which indicates that all work objects were processed successfully.
Throws:
VWException - Thrown if a general system error of some kind occurs, such as a file permission problem ir database malfunctioning.

doLockMany

public static VWException[] doLockMany(VWWorkObject[] wobjs,
                                       boolean overrideLock)
                                throws VWException
Locks multiple work objects in a single call and refreshes them with current information. The array of work objects must come from one of the following:

Parameters:
wobjs - An array of work objects to lock.
overrideLock - Specify true to override locks. System locks cannot be overidden.
Returns:
An array of VWException objects that represent the input elements. If no input elements exist, this method returns an array of nulls, which indicates that all work objects were processed successfully.
Throws:
VWException - Thrown if the method cannot lock multiple work objects in a single call and refresh them with current information.

lock

public void lock(boolean overrideLock)
          throws VWException
Deprecated. Replaced by doLock( boolean)

Locks the work object.

Parameters:
overrideLock - Specify true to override locks. System locks cannot be overridden.
Throws:
VWException - Thrown if the method cannot lock the work object.

doLock

public void doLock(boolean overrideLock)
            throws VWException
Locks the work object.

Parameters:
overrideLock - Specify true to override locks. System locks cannot be overridden.
Throws:
VWException - Thrown if the method cannot lock the work object.

terminateMany

public static VWException[] terminateMany(VWWorkObject[] elements)
                                   throws VWException
Deprecated. Replaced by doTerminateMany( VWWorkObject[])

Terminates the specified work objects. Terminating a work object dispatches the work object to the Terminate Instruction Sheet. Work objects in the array must come from a query on the same roster or queue.

Parameters:
elements - An array of work objects to terminate.
Returns:
An array of VWException objects that represent the input elements. If no input elements exist, this method returns an array of nulls, which indicates that all work objects were processed successfully.
Throws:
VWException - Thrown if the method cannot terminate the specified work objects.

doTerminateMany

public static VWException[] doTerminateMany(VWWorkObject[] elements)
                                     throws VWException
Terminates the specified work objects. Terminating a work object dispatches the work object to the Terminate Instruction Sheet. Work objects in the array must come from a query on the same roster or queue.

Parameters:
elements - An array of work objects to terminate.
Returns:
An array of VWException objects that represent the input elements. If no input elements exist, this method returns an array of nulls, which indicates that all work objects were processed successfully.
Throws:
VWException - Thrown if the method cannot terminate the specified work objects.

terminate

public void terminate()
               throws VWException
Deprecated. Replaced by doTerminate()

Terminates the current work object. Terminating a work object dispatches the work object to the terminate instruction sheet.

Throws:
VWException - Thrown if the method cannot terminate the current work object; for example, if someone other than the caller locked the work object.

doTerminate

public void doTerminate()
                 throws VWException
Terminate this work object. Terminating a work object dispatches it to the terminate instruction sheet.

Throws:
VWException - Thrown if the method cannot terminate the current work object; for example, if someone other than the caller locked the work object.

doDeleteMany

public static VWException[] doDeleteMany(VWWorkObject[] elements,
                                         boolean overrideLock,
                                         boolean force)
                                  throws VWException
Deletes the specified work objects. Work objects in the array must come from a query on the same roster or queue.

Parameters:
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).
Returns:
An array of VWException objects that represent the input elements. If no input elements exist, this method returns an array of nulls, which indicates that all work objects were processed successfully.
Throws:
VWException - Thrown if the method cannot delete the specified work objects.

doDelete

public void doDelete(boolean overrideLock,
                     boolean force)
              throws VWException
Delete this work object.

Parameters:
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).
Throws:
VWException - Thrown if the method cannot delete the current work object.

fetchLockedStatus

public int fetchLockedStatus()
                      throws VWException
Retrieves the lock status of the work object. This method requires a network call to retrieve the lock status for a work object.

Returns:
An integer value indicating the current lock status for this work object. This method returns one of the following values:

  • 0 LOCKED_BY_NONE
  • 1 LOCKED_BY_USER
  • 2 LOCKED_BY_SYSTEM

Throws:
VWException - Thrown if the method cannot retrieve the lock status of the work object; for example, if it cannot execute a network call.
See Also:
VWQueueElement(for status definitions)

getFieldNames

public java.lang.String[] getFieldNames()
Retrieves the names of the data fields this work object supports. If a translation source exists, the authored field names are translated.

Returns:
A String array containing the translated field names, if a translation source exists; otherwise, the authored names are returned.

getAuthoredFieldNames

public java.lang.String[] getAuthoredFieldNames()
Retrieves the authored (untranslated) names of the data fields this work object supports.

Returns:
An array of authored data field names.
Since:
P8 4.0

getFieldValue

public java.lang.Object getFieldValue(java.lang.String fieldName)
                               throws VWException
Retrieves the value of a data field.

Parameters:
fieldName - The name of the data field. If a translation source exists, the authored field name is translated.
Returns:
An Object containing the value of the specified data field. The object must be of one of the following types: integer, string, double, boolean, or java.util.Date. The value can be null.
Throws:
VWException - Thrown if the name for the data field does not exist.

setFieldValue

public void setFieldValue(java.lang.String fieldName,
                          java.lang.Object fieldValue)
                   throws VWException
Deprecated. Replaced by setFieldValue(String, Object, boolean)

Changes the value of a specified data field.

Parameters:
fieldName - The name of the data field.
fieldValue - An object containing the new value for the data field.
Throws:
VWException - Thrown if the system cannot find the data field specified in the fieldName parameter.

setFieldValue

public void setFieldValue(java.lang.String fieldName,
                          java.lang.Object fieldValue,
                          boolean compareValue)
                   throws VWException
Changes the value of a specified data field in this work object.

Parameters:
fieldName - A String containing the name of the data field. If a translation source exists, the authored field name is translated.
fieldValue - An Object containing the new value for the data field.
compareValue - Specify true to set only the values modified; specify false if you want all values in a field to indicate that they have been modified.
Throws:
VWException - Thrown if the data field specified cannot be found.

hasFieldName

public boolean hasFieldName(java.lang.String fieldName)
                     throws VWException
Indicates whether the specified data field exists in this work object.

Parameters:
fieldName - A String containing the name of the data field to check. If a translation source exists, the authored field name is translated.
Returns:
A boolean value of true if the data field specified exists in this work object.
Throws:
VWException - Thrown if the fieldName parameter is null.

getIsAltered

public boolean getIsAltered()
Determines whether any data field has changed.

Returns:
true if any data field values have changed; otherwise, this method returns false.

hasBeenAltered

public boolean hasBeenAltered(java.lang.String fieldName)
                       throws VWException
Indicates whether the specified field has changed in this work object.

Parameters:
fieldName - A String containing the name of the field. If a translation source exists, the authored field name is translated.
Returns:
A boolean value of true if the values in the data field specified have changed; otherwise, false is returned.
Throws:
VWException - Thrown for various causes, including when the fieldName parameter is null.

getWorkObjectName

public java.lang.String getWorkObjectName()
                                   throws VWException
Returns the name of this work object. If a translation source exists, the authored name is translated.

Returns:
A String containing the translated name of this work object, if a translation source exists; otherwise, the authored name is returned.
Throws:
VWException - Thrown if the work object name cannot be retrieved.

getWorkObjectNumber

public java.lang.String getWorkObjectNumber()
                                     throws VWException
Returns a string version of the work object number. Use the returned F_WobNum as an index key component.

Returns:
A string containing a text representation of the work object number, which corresponds to the F_WobNum queue field.
Throws:
VWException - Thrown if the method cannot retrieve a string version of the work object number.

getTag

public java.lang.String getTag()
                        throws VWException
Returns a String version of the work object tag. The work object name is normalized and saved as a tag, which ensures correct sorting of work object names as integers.

If the F_Tag value is not set, "*" is returned. Refer to the Workflow Designer documentation for information about F_Tag and the use of "*".

Returns:
A String containing a text representation of the work object tag, or "*" if the F_Tag value is not set.
Throws:
VWException - Thrown if a String version of the work object tag cannot be retrieved.

getWorkClassName

public java.lang.String getWorkClassName()
                                  throws VWException
Returns the name of the work class from which the application instantiates this work object. If a translation source exists, the authored work class name is translated.

Returns:
A String containing the translated name of the work class associated with this work object, if a translation source exists; otherwise, the authored name is returned.
Throws:
VWException - Thrown if the name of the work class cannot be retrieved.

getWorkPerformerClassName

public java.lang.String getWorkPerformerClassName()
                                           throws VWException
Returns the name of the work performer class associated with the queue on which the work object resides. If a translation source exists, the authored name is translated.

Returns:
A String containing the translated name of the work performer class, if a translation source exists; otherwise, the authored name is returned.
Throws:
VWException - Thrown if the work performer class name cannot be retrieved.

getOperationName

public java.lang.String getOperationName()
                                  throws VWException
Returns the name of the current operation on this work object. If a translation source exists, the authored operation name is translated.

Returns:
A String containing the translated operation name, if a translation source exists; otherwise, the authored name is returned.
Throws:
VWException - Thrown if the name of the current operation on this work object cannot be retrieved.

getStepName

public java.lang.String getStepName()
                             throws VWException
Gets the step label (name) for this work object. If a translation source exists, the authored step name is translated.

Returns:
A String containing the translated step name for this work object, if a translation source exists; otherwise, the authored name is returned.
Throws:
VWException - Thrown if the step label cannot be retrieved.
Since:
VWWS3.10

getAuthoredStepName

public java.lang.String getAuthoredStepName()
                                     throws VWException
Gets the authored (untranslated) step name for this work object.

Returns:
A String containing the authored name, if it exists. If the step name cannot be found, null is returned.
Throws:
VWException - Thrown if the step name cannot be found for this work object.
Since:
P8 4.0

toString

public java.lang.String toString()
Retrieves the string version of the work object name. If the F_Tag value is not set, "*" is returned. Refer to the Workflow Designer documentation for information about F_Tag and the use of "*".

Overrides:
toString in class java.lang.Object
Returns:
A String containing the name of the work object, or "*" if the F_Tag value is not set.

doAbort

public void doAbort()
             throws VWException
Unlocks this work object without updating its fields.

Throws:
VWException
Since:
VWWS3.10

doDispatch

public void doDispatch()
                throws VWException
Saves changes made in this work object, unlocks it, and moves the current step to the next workflow step.

Throws:
VWException
Since:
VWWS3.10

getProcess

public VWProcess getProcess()
                     throws VWException
Deprecated. Replaced by fetchProcess

Returns the workflow process that contains this work object. The application can fetch the VWAttachment parameters and the VWStepElement associated with this work object.

Returns:
A VWProcess object that represents the workflow process containing this work object.
Throws:
VWException
Since:
VWWS3.10

fetchProcess

public VWProcess fetchProcess()
                       throws VWException
Retrieves the workflow process containing this instance. If a translation source exists, the authored workflow information is translated.

The application can use the VWProcess object returned to fetch the VWAttachment parameters and the VWStepElement associated with this work object.

Returns:
A VWProcess object representing the workflow process containing this instance. If a translation source exists, the translated workflow information is returned; otherwise, the authored information is returned.
Throws:
VWException - Thrown if the workflow process cannot be retrieved.
Since:
VWWS3.10

fetchStepElement

public VWStepElement fetchStepElement()
                               throws VWException
Fetches the current step in the workflow process. If a translation source exists, the authored step element information is translated.

Returns:
A VWStepElement object representing the current step associated with this work object. If a translation source exists, the translated step element information is returned; otherwise, the authored information is returned.
Throws:
VWException - Thrown if the step element cannot be retrieved.
Since:
VWWS3.10

getDateReceived

public java.util.Date getDateReceived()
                               throws VWException
Returns the date on which the work object was last saved. This date is updated every time the work object is saved, and may not indicate the initial date the work object was received.

Returns:
A date value indicating the date on which the work object was last saved.
Throws:
VWException
Since:
VWWS3.10

getExceptionMap

public java.lang.String getExceptionMap()
Returns the name of workflow map for the Process Engine exception specified in setException. If a translation source exists, the authored map name is translated.

Returns:
A String containing the translated map name for the Process Engine exception, if a translation source exists; otherwise, the authored map name is returned.
Since:
VWWS3.10

getDataFields

public VWDataField[] getDataFields(int fieldTypeFlag,
                                   int fieldCreatorFlag)
                            throws VWException
Returns a list of all data fields this work object supports. If a translation source exists, the data field information is translated.

Parameters:
fieldTypeflag - An integer indicating which field types to return (see VWFieldType. You can combine field types using a bitwise OR operation.
fieldCreatorFlag - An integer corresponding to any of the following literal values (use a bitwise OR to combine FIELD_USER_DEFINED and FIELD_SYSTEM_DEFINED):
Returns:
An array of VWDataField objects for the supported data fields. If a translation source exists, the translated information is returned for the data fields; otherwise, the authored information is returned.
Throws:
VWException
Since:
VWWS3.10

getDataField

public VWDataField getDataField(java.lang.String name)
                         throws VWException
Gets the requested data field from the log element.

Parameters:
name - A String containing the name of the data field. If a translation source exists, the authored field name is translated.
Returns:
A VWDataField object for the data field specified. If the field cannot be found, null is returned.
Throws:
VWException
Since:
P8 4.0

getLaunchDate

public java.util.Date getLaunchDate()
                             throws VWException
Returns the date on which the workflow process that contains this work object was launched.

Returns:
A date value indicating the date on which the workflow process that contains this work object was launched.
Throws:
VWException
Since:
VWWS3.10

getOriginator

public java.lang.String getOriginator()
                               throws VWException
Returns the name of the user who initiated the workflow process that contains this work object.

Returns:
The name of the user who initiated the workflow process that contains this work object.
Throws:
VWException
Since:
VWWS3.10

getOriginatorPx

public VWParticipant getOriginatorPx()
                              throws VWException
Returns the VWParticipant (security) object that represents the user who initiated the workflow process containing the current step.

Returns:
The VWParticipant (security) object that represents the user who initiated the workflow process containing the current step, or null, if no user name is found.
Throws:
VWException
Since:
VWWS3.10

getParticipantName

public java.lang.String getParticipantName()
                                    throws VWException
Returns the short name of the participant who is processing this work object.

Returns:
The short name of the participant who is currently processing this work object.
Throws:
VWException
Since:
VWWS3.10

getParticipantNamePx

public VWParticipant getParticipantNamePx()
                                   throws VWException
Returns a VWParticipant (security) object that represents the current participant.

Returns:
A VWParticipant (security) object that represents the current participant.
Throws:
VWException
Since:
VWWS3.10

doReassign

public void doReassign(java.lang.String participant,
                       boolean delegateFlag,
                       java.lang.String queueName)
                throws VWException
Delegates the current step assignment associated with this work object to another participant.

Parameters:
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 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".
Throws:
VWException
Since:
VWWS3.10

doReassignByDomain

public void doReassignByDomain(java.lang.String theDomainName,
                               java.lang.String participant,
                               boolean delegateFlag,
                               java.lang.String queueName)
                        throws VWException
Changes the participant responsible for processing the current step.

Parameters:
theDomainName - The LDAP domain of the new participant being assigned to process the step.
participant - The name of the new participant being assigned to process the step.
delegateFlag - true to flag the reassignment for later review; false, otherwise.
queueName - The queue name to which the work item is to be moved, or null. null indicates the current queue of this work item is a user-centric queue, or "Inbox" if the current queue of this work item is not a user-centric queue.
Throws:
VWException
Since:
VWWS3.10

doReturnToSource

public void doReturnToSource()
                      throws VWException
Returns the work object to the queue from which it was originally reassigned or delegated.

Throws:
VWException - Thrown if the system encounters an error while attempting to move the work object.

doSave

public void doSave(boolean unlock)
            throws VWException
Saves this work object.

Parameters:
unlock - Specify true to unlock and save the work object; otherwise, specify false to maintain the current lock and save the work object.
Throws:
VWException - Thrown for various causes, including when this method throws an exception if someone other than the current user locked the work object.
Since:
VWWS3.10

getWorkflowName

public java.lang.String getWorkflowName()
                                 throws VWException
Returns the name of the workflow associated with this step.

Returns:
The name of the workflow associated with this step.
Throws:
VWException
Since:
VWWS3.10

getLockedUser

public java.lang.String getLockedUser()
                               throws VWException
Returns the name of the user who locked the work object.

Returns:
The VWParticipant (security) object that represents the user who locked the current work object. If the work object is locked by the system or not locked, this method returns null.
Throws:
VWException
Since:
VWWS3.10

getLockedUserPx

public VWParticipant getLockedUserPx()
                              throws VWException
Returns the VWParticipant (security) object that represents the user who locked the current work object.

Returns:
The name of the user who locked the current work object, or null. Null indicates the current work object is unlocked, or the current work object is locked by the system.
Throws:
VWException
Since:
VWWS3.10

setDataFields

public void setDataFields(VWDataField[] dataFields,
                          boolean compareValues)
                   throws VWException
Changes the values for specified data fields. Only fields other than system or Read-only fields are modifiable.

Parameters:
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.
Throws:
VWException - Thrown if the system cannot set a field specified in the dataFields parameter.
Since:
VWWS3.10

getIsTracker

public boolean getIsTracker()
                     throws VWException
Determines whether this a tracker work object.

Returns:
true if the work object is a tracker; otherwise, this method returns false.
Throws:
VWException - Thrown if the system encounters an error while attempting to the tracker flag.
Since:
VWWS3.10

getRosterName

public java.lang.String getRosterName()
                               throws VWException
Returns the name of the roster for this work object. If a translation source exists, the authored roster name is translated.

Returns:
A String containing the translated roster name, if a translation source exists; otherwise, the authored name is returned.
Throws:
VWException - Thrown if an error occurs while attempting to retrieve the roster name.
Since:
VWWS3.10

getWorkFlowNumber

public java.lang.String getWorkFlowNumber()
                                   throws VWException
Deprecated. Replaced by getWorkflowNumber()

Returns the string version of the workflow number. Use the returned F_WorkFlowNumber as an index key component.

Returns:
A string containing a text representation of the workflow number, which corresponds to the F_WorkFlowNumber.
Throws:
VWException - Thrown if the method cannot retrieve the string version of the workflow number, which corresponds to the F_WorkFlowNumber.

getWorkflowNumber

public java.lang.String getWorkflowNumber()
                                   throws VWException
Gets the workflow number. You can use the returned F_WorkFlowNumber value as an index key component.

Returns:
The workflow object number in String format, which corresponds to the F_WorkFlowNumber; or null. null means the F_WorkFlowNumber field does not exist.
Throws:
VWException

getTrackers

public java.lang.String[] getTrackers()
                               throws VWException
Deprecated. Replaced by VWWorkObject.getTrackersPx(), which returns an array of VWParticipant objects for the tracker participants associated with this work object.

Returns the list of trackers associated with this work object.

Returns:
List of the names of tracker participants associated with this work object.
Throws:
VWException

getTrackersPx

public VWParticipant[] getTrackersPx()
                              throws VWException
Returns an array of VWParticipant objects for the tracker participants associated with this work object.

Returns:
An array of VWParticipant objects for the tracker participants associated with this work object.
Throws:
VWException

getWorkOrderId

public int getWorkOrderId()
                   throws VWException
Returns the work order ID associated with this work object; may be null.

Returns:
Work order ID.
Throws:
VWException

getDeadline

public java.util.Date getDeadline()
                           throws VWException
Retrieve the date by which the step should be completed.

Returns:
A date value that indicates the date by which this step must completed by the assigned participants.
Throws:
VWException - Thrown if the system encounters an error while attempting to retrieve the dead line date.

getReminder

public java.util.Date getReminder()
                           throws VWException
Returns the date on which a reminder is to be issued for the step.

Returns:
A date value that indicates the date on which a reminder is to be issued for this step.
Throws:
VWException - Thrown if the system encounters an error while attempting to retrieve the reminder date.

getOverdue

public int getOverdue()
               throws VWException
Returns the status of the overdue notice.

Returns:
An integer value that indicates the status for the reminder. This method will return one of the following values:

  • 0 Not overdue
  • 1 Reminder date has arrived
  • 2 Deadline has arrived

Throws:
VWException

getOperationType

public int getOperationType()
                     throws VWException
Returns the operation type of the current work order. The operation ID identifies the type of the operation being performed.

Returns:
An integer value indicating the operation being performed. This method will return one of the following values:

  • 0: ASSIGN SERVICE
  • 1: BEGIN TIMER
  • 2: BIND TO STATION
  • 3: BIND TO USER
  • 4: BRANCH
  • 5: CALL
  • 6: CREATE
  • 7: DELAY INSTRUCTION
  • 8: END ALL TIMERS
  • 9: END TIMER
  • 10: GO TO
  • 11: LABEL
  • 12: RELEASE
  • 13: RESUME TIMER
  • 14: RETURN
  • 15: STATIC SPLIT
  • 16: SUSPEND TIMER
  • 17: TERMINATE
  • 18: UNBIND
  • 19: WAIT FOR EVENT
  • 20: WHILE
  • 21: END WHILE
  • 22: RENDEZVOUS
  • 23: USER DEFINED
  • 24: NONOP SERVICE
  • 25: NONE SERVICE
  • 26: LEAF SERVICE
  • 27: BEGIN CHECKPOINT
  • 28: END CHECKPOINT
  • 29: ROLLBACK CHECKPOINT
  • 30: STOP SERVICE
  • 31: BEGIN SEQMODE SERVICE
  • 32: END SEQMODE SERVICE
  • 33: STEP SERVICE

Throws:
VWException

getCurrentQueueName

public java.lang.String getCurrentQueueName()
                                     throws VWException
Returns the name of the queue in which this work object resides. If a translation source exists, the authored queue name is translated.

Returns:
A String containing the translated queue name, if a translation source exists; otherwise the authored map name is returned.
Throws:
VWException

fetchStepProcessorInfo

public VWStepProcessorInfo fetchStepProcessorInfo()
                                           throws VWException
Fetches the step processor information associated with this instance. If a translation source exists, the authored step processor information is translated. The step processor information contains data that can used to open a step processor.

Returns:
The VWStepProcessorInfo object for the step processor assigned to the step.
Throws:
VWException
Since:
VWWS3.10

getComment

public java.lang.String getComment()
                            throws VWException
Returns the comment for this step.

Returns:
The comment entered by a user for the step. Unless the setComment() method was previously called, this method returns null.
Throws:
VWException

getSubject

public java.lang.String getSubject()
                            throws VWException
Returns the subject of the workflow (the value in the F_Subject system field) associated with this work object. If a translation source exists, the authored subject value is translated.

Note: The subject cannot be translated if it is changed at launch time.

Returns:
A String containing the translated subject, if a translation source exists; otherwise the authored value is returned.
Throws:
VWException - Thrown if an error occurs while attempting to retrieve the subject.

getInstructionSheetName

public java.lang.String getInstructionSheetName()
                                         throws VWException
Returns the name of the instruction sheet containing the instruction this work object is currently processing. If a translation source exists, the authored instruction sheet name is translated.

Returns:
A String containing the translated name of the current instruction sheet, if a translation source exists; otherwise, the authored name is returned.
Throws:
VWException - Thrown if the name of the instruction sheet for this work object cannot be found.

getStepResponses

public java.lang.String[] getStepResponses()
                                    throws VWException
Returns the list of available responses for this work object. If a translation source exists, the authored responses are translated.

Returns:
A String array containing the responses defined for this work object, if a translation source exists; otherwise, the authored responses are returned. If no responses are defined, null is returned.
Throws:
VWException - Thrown if the responses cannote be retrieved.

getSelectedResponse

public java.lang.String getSelectedResponse()
                                     throws VWException
Returns default response (the value in the F_Response system field) for this work object. If a translation source exists, the authored response value is translated.

Returns:
A String containing the translated default response, if a translation source exists; otherwise the authored response is returned. Unless the response for this work object was previously specified using setSelectedResponse, null is returned.
Throws:
VWException

setSelectedResponse

public void setSelectedResponse(java.lang.String response)
                         throws VWException
Changes the selected (default) response for this work object.

Parameters:
response - A String containing the new selected response. If a translation source exists, this response is translated; otherwise, the authored response is used.
Throws:
VWException - Thrown for various causes, including when no responses are available.

getStepDescription

public java.lang.String getStepDescription()
                                    throws VWException
Gets the description of the step. If a translation source exists, the authored step name is translated.

Returns:
A String containing the translated description for the step, if a translation source exists; otherwise, the authored description is returned.
Throws:
VWException - Thrown if the step description cannot be retrieved.

setCallMap

public void setCallMap(java.lang.String aMapName)
                throws VWException
Specifies a map to be called when this work object is dispatched. After the specified map call completes, by default, processing resumes immediately following the calling step. In the design phase of the workflow process, an alternative return location to the beginning of this step may be specified.

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.

Parameters:
aMapName - The name of the map to execute when this work object is dispatched.
Throws:
VWException - Thrown for various causes, including when the aMapName parameter is null.
See Also:
getCallMap

getCallMap

public java.lang.String getCallMap()
Gets the name of the workflow map. If a translation source exists, the authored map name is translated.

Returns:
A String containing the translated map name, if a translation source exists; otherwise the authored map name is returned.
See Also:
setCallMap

fetchReturnStackElements

public VWReturnStackElement[] fetchReturnStackElements()
                                                throws VWException
Retrieves work object return stack. An array of return frame stack elements are returned from the server.

Returns:
Returns an array of return stack objects.
Throws:
VWException

getLastErrorNumber

public java.lang.String getLastErrorNumber()
                                    throws VWException
Returns the last error number of the return stack frame for this work object.

Returns:
The last error number of the stack frame for the work object null is returned if there were no errors.
Throws:
VWException

getLastErrorText

public java.lang.String getLastErrorText()
                                  throws VWException
Returns the last error text of the return stack frame for this work object.

Returns:
The last error number of the stack frame for the work object blank is returned if there were no errors.
Throws:
VWException

getServerLocation

public int getServerLocation()
                      throws VWException
Gets the current server location of the work object.

Returns:
Number of the server for the work object
Throws:
VWException

Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.