Process Class Relationships

filenet.vw.api
Class VWWorkObject

java.lang.Object
  |
  +--filenet.vw.api.VWFieldsObject
        |
        +--filenet.vw.api.VWWorkElement
              |
              +--filenet.vw.api.VWWorkObject
All Implemented Interfaces:
java.io.Serializable

public final class VWWorkObject
extends filenet.vw.api.VWWorkElement
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
          Integer value of 2. Indicates that the data field was created by the system.
static int FIELD_USER_AND_SYSTEM_DEFINED
          Integer 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
          Integer 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()
          Checks the lock status of the work object.
 VWProcess fetchProcess()
          Retrieves the workflow process that contains this work object.
 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 system exception.
 java.lang.String getExceptionInstructionSheet()
          Deprecated. Replaced by getExceptionMap()
 java.lang.String getExceptionMap()
          Retrieves the name of the Process system 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.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 workobject.
 int getServerLocation()
          Get 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 workobject.
 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

FIELD_USER_DEFINED

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

FIELD_SYSTEM_DEFINED

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

FIELD_USER_AND_SYSTEM_DEFINED

public static final int FIELD_USER_AND_SYSTEM_DEFINED
Integer value of 3. Indicates that the data field was created by the system but is being controlled by the user.
Method Detail

fetchInstructionElement

public VWInstructionElement fetchInstructionElement(boolean lock,
                                                    boolean overrideLock)
                                             throws VWException
Fetches the Instruction Element information associated with this work object.
Parameters:
lock - A Boolean value. Specify true to lock the work object; specify false to leave the work object in its existing state.
overrideLock - A Boolean value. 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 - A Boolean value. Specify true to lock the work object; specify false to leave the work object in it existing state.
overrideLock - A Boolean value. 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 - A Boolean value. Specify true to lock the work object; specify false to leave the work object in its existing state.
overrideLock - A Boolean value. 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 - A Boolean value. Specify true to save the work object data field values.
dispatch - A Boolean value. 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 it 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 - A Boolean value. Specify true to save the work object data field values.
dispatch - A Boolean value. 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 it 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 it 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 it 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 - A Boolean value. Specify true to save the work object data field values.
dispatch - A Boolean value. 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 an exception condition for a work object. If you set the parameters for this method, an exception occurs when the system saves or dispatches this work object to the specified instruction sheet. The system catches errors for parameter values only when the application saves or unlocks the work object with dispatch set.
Parameters:
aInstructionSheetName - The name of the instruction sheet that the Process system executes when the system raises the exception. When specifying a value for this parameter, keep the following behavior in mind:

  • If you enter null (the default), the system raises no exception.
  • If you name an instruction sheet, the system raises an exception when the application unlocks and dispatches the work object.

aDescription - A string containing a description of the exception to be raised. This is not a Java exception.
Throws:
VWException - Thrown if it cannot set an exception condition for a work object.

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 WorkFlo Services 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 value the workflow author set for the description of the Process system exception. This is not a Java exception.
Returns:
The description of the WorkFlo Services exception to be raised.
See Also:
setException(String, String)

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 - A Boolean value. 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 - A Boolean value. 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 it 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 - A Boolean value. Specify true to override locks. System locks cannot be overridden.
Throws:
VWException - Thrown if it cannot lock the work object.

doLock

public void doLock(boolean overrideLock)
            throws VWException
Locks the work object.
Parameters:
overrideLock - A Boolean value. Specify true to override locks. System locks cannot be overridden.
Throws:
VWException - Thrown if it 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 it 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 it 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 it cannot terminate the current work object; for example, if someone other than you 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 it cannot terminate the current work object; for example, if someone other than you 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 it 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 it cannot delete the current work object.

fetchLockedStatus

public int fetchLockedStatus()
                      throws VWException
Checks 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 it cannot check 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.
Returns:
A string containing an array of data field names.

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.
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 containg 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.
Parameters:
fieldName - The name of the data field.
fieldValue - An object containg the new value for the data field.
compareValue - A Boolean value. 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 find the data field specified in the fieldName parameter.

hasFieldName

public boolean hasFieldName(java.lang.String fieldName)
                     throws VWException
Determines whether the specified data field exists.
Parameters:
fieldName - The name of the data field to check.
Returns:
A Boolean value. This method returns true if the system finds the data field specified in the fieldName parameter.
Throws:
VWException - Thrown if the fieldName parameter is null.

getIsAltered

public boolean getIsAltered()
Determines whether any data field has changed.
Returns:
A Boolean value. This method returns true if any data field values have changed; otherwise, this method returns false.

hasBeenAltered

public boolean hasBeenAltered(java.lang.String fieldName)
                       throws VWException
Determines whether a specific field has changed.
Returns:
A Boolean value. This method returns true if the values in the data field specified in the fieldName parameter haschanged; otherwise, this method returns false.
Throws:
VWException - Thrown if the fieldName parameter is null.

getWorkObjectName

public java.lang.String getWorkObjectName()
                                   throws VWException
Retrieves the work object name.
Returns:
The name of this work object. This is the value of the work object ID field the workflow author set on the work class Properties page in Composer.
Throws:
VWException - Thrown if it cannot retrieve the work object name.

getWorkObjectNumber

public java.lang.String getWorkObjectNumber()
                                     throws VWException
Retrieves 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 it cannot retrieve a string version of the work object number.

getTag

public java.lang.String getTag()
                        throws VWException
Retrieves a string version of the work object tag. The system normalizes and saves the work object name as a tag in the database, which ensures correct sorting of work object names as integers.
Returns:
A string containing a text representation of the work object tag.
Throws:
VWException - Thrown if it cannot retrieve a string version of the work object tag.

getWorkClassName

public java.lang.String getWorkClassName()
                                  throws VWException
Retrieves the name of the work class from which the application instantiates this work object.
Returns:
The name of the work class associated with this work object.
Throws:
VWException - Thrown if it cannot retrieve the name of the work class from which the application instantiates this work object.

getWorkPerformerClassName

public java.lang.String getWorkPerformerClassName()
                                           throws VWException
Retrieves the name of the Work Performer Class associated with the queue on which the work object resides.
Returns:
The name of the current Work Performer Class.
Throws:
VWException - Thrown if it cannot retrieve the name of the Work Performer Class associated with the queue on which the work object resides.

getOperationName

public java.lang.String getOperationName()
                                  throws VWException
Retrieves the name of the current operation on the work object.
Returns:
The name of current operation on the work object.
Throws:
VWException - Thrown if it cannot retrieve the name of the current operation on the work object.

toString

public java.lang.String toString()
Retrieves the string version of the work object name.
Overrides:
toString in class java.lang.Object
Returns:
The name of the work object.

doAbort

public void doAbort()
             throws VWException
Unlock this work object without updating its fields.
Throws:
VWException - Thrown if the system encounters an error while attempting to the work object.
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 - Thrown if the system encounters an error while attempting to save the current step or move the step to the next workflow step.
Since:
VWWS3.10

getProcess

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

Retrieves 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 - Thrown if the system cannot fetch the workflow process.
Since:
VWWS3.10

fetchProcess

public VWProcess fetchProcess()
                       throws VWException
Retrieves 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 - Thrown if the system cannot fetch the workflow process.
Since:
VWWS3.10

fetchStepElement

public VWStepElement fetchStepElement()
                               throws VWException
Fetches the current step in the workflow process.
Returns:
A VWStepElement object that represents the current step element associated with this work object.
Throws:
VWException - Thrown if the system cannot fetch the step element.
Since:
VWWS3.10

getDateReceived

public java.util.Date getDateReceived()
                               throws VWException
Retrieves the date on which you received this work object.
Returns:
A date value indicating the date on which the user first received this work object.
Throws:
VWException - Thrown if the system encounters an error while attempting to retrieve the date.
Since:
VWWS3.10

getExceptionMap

public java.lang.String getExceptionMap()
Retrieves the name of the Process system exception that corresponds to the workflow map.
Returns:
The workflow map name for the Process system exception to be raised. This is not a Java exception.
Since:
VWWS3.10

getDataFields

public VWDataField[] getDataFields(int fieldTypeFlag,
                                   int fieldCreatorFlag)
                            throws VWException
Retrieves a list of all data fields this work object supports.
Parameters:
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:

  • FIELD_USER_DEFINED
  • FIELD_SYSTEM_DEFINED
  • FIELD_USER_AND_SYSTEM_DEFINED

Combining FIELD_USER_DEFINED and FIELD_SYSTEM_DEFINED, using a logical OR operation, is also allowed.

Returns:
An array of data field objects.
Throws:
VWException - Thrown if the system encounters an error while attempting to return data field elements.
Since:
VWWS3.10
See Also:
VWDataField

getLaunchDate

public java.util.Date getLaunchDate()
                             throws VWException
Retrieves 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 - Thrown if the system encounters an error while attempting to retrieve the workflow process launch date.
Since:
VWWS3.10

getOriginator

public java.lang.String getOriginator()
                               throws VWException
Retrieves 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 - Thrown if the system encounters an error while attempting to retrieve the name of the workflow originator.
Since:
VWWS3.10

getParticipantName

public java.lang.String getParticipantName()
                                    throws VWException
Retrieves the name of the participant who is processing this work object.
Returns:
The name of the participant who is processing this work object.
Throws:
VWException - Thrown if the system encounters an error while attempting to retrieve the participant name.
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 - A Boolean value. 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".
Throws:
VWException - Thrown if the system encounters an error while attempting to reassign the current step.
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 - A boolean value. 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 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.
Since:
VWWS3.10

getWorkflowName

public java.lang.String getWorkflowName()
                                 throws VWException
Retrieves the name of the workflow associated with this step.
Returns:
The name of the workflow associated with this step.
Throws:
VWException - Thrown if it cannot retrieve the name of the workflow associated with this step.
Since:
VWWS3.10

getLockedUser

public java.lang.String getLockedUser()
                               throws VWException
Retrieves the name of the user who locked the work object.
Returns:
The name of 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 - Thrown if it cannot retrieve the name of the user who locked the work object.
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 - A Boolean value. 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:
A Boolean value. This method 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
Retrieves the name of the roster for this work object.
Returns:
The name of the roster for the current work object.
Throws:
VWException - Thrown if the system encounters an error while attempting to retrieve the roster name.
Since:
VWWS3.10

getWorkFlowNumber

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

Retrieves the string version of the workflow number. Use the returned F_WorkFlowNumber as an index key component.
Overrides:
getWorkFlowNumber in class filenet.vw.api.VWFieldsObject
Returns:
A string containing a text representation of the workflow number, which corresponds to the F_WorkFlowNumber.
Throws:
VWException - Thrown if it cannot retrieve the string version of the workflow number, which corresponds to the F_WorkFlowNumber.

getWorkflowNumber

public java.lang.String getWorkflowNumber()
                                   throws VWException
Retrieves 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 it cannot retrieve the string version of the workflow number.

getTrackers

public java.lang.String[] getTrackers()
                               throws VWException
Retrieves the list of trackers associated with this work object.
Returns:
An array of strings. Each string contains the name of a tracker participant associated with this work object.
Throws:
VWException - Thrown if it cannot retrieve the list of trackers associated with this work object.

getWorkOrderId

public int getWorkOrderId()
                   throws VWException
Retrieves the work order Id associated with this work object.
Returns:
An integer value indicating the work order Id.
Throws:
VWException - Thrown if it cannot retrieve the work order Id associated with this work object.

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
Retrieves 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
Retrieves 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 - Thrown if the system encounters an error while attempting to retrieve the overdue status.

getOperationType

public int getOperationType()
                     throws VWException
Retrieves 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 - Thrown if it cannot retrieve the operation type of the current work order.

getCurrentQueueName

public java.lang.String getCurrentQueueName()
                                     throws VWException
Retrieves the queue in which this work object resides.
Returns:
The name of the queue in which this object resides.
Throws:
VWException - Thrown if it cannot retrieve the queue in which this work object resides.

fetchStepProcessorInfo

public VWStepProcessorInfo fetchStepProcessorInfo()
                                           throws VWException
Retrieves the step processor information necessary for launching a step.
Returns:
A VWStrpProcessorInfo object containing the step processor information needed to initialize and launch a step.
Throws:
VWException - Thrown if it cannot retrieve the step processor information necessary for launching a step.
Since:
VWWS3.10

getComment

public java.lang.String getComment()
                            throws VWException
Retrieves 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 a null.
Throws:
VWException - Thrown if the system encounters an error while attempting to retrieve the comment.

getSubject

public java.lang.String getSubject()
                            throws VWException
Retrieves the subject of the workflow associated with this step.
Returns:
The subject of the workflow associated with this step.
Throws:
VWException - Thrown if it cannot retrieve the subject of the workflow associated with this step.

getInstructionSheetName

public java.lang.String getInstructionSheetName()
                                         throws VWException
Retrieves the name of the instruction sheet containing the instruction the work object is currently processing.
Returns:
The operation name the work object is currently attempting to process.
Throws:
VWException - Thrown if it cannot retrieve the name of the instruction sheet containing the instruction the work object is currently processing.

getStepResponses

public java.lang.String[] getStepResponses()
                                    throws VWException
Retrieves the list of available responses in this workobject.
Returns:
An array of strings that list all of the responses defined in this work object. If no responses exist, this method returns null.
Throws:
VWException - Thrown if the system encounters an error while attempting to retrieve the available responses.

getSelectedResponse

public java.lang.String getSelectedResponse()
                                     throws VWException
Retrieves your response to this workobject.
Returns:
The selected (default) response for this work object. Unless the setSelectedResponse() method was previously called, this method returns a null.
Throws:
VWException - Thrown if the system encounters an error while attempting to retrieve the selected response.

setSelectedResponse

public void setSelectedResponse(java.lang.String response)
                         throws VWException
Changes the selected (default) response for this work object.
Parameters:
response - The new selected response.
Throws:
VWException - Thrown if the system encounters an error while attempting to set the selected response.

setCallMap

public void setCallMap(java.lang.String aMapName)
                throws VWException
Specifies a map to be called when the system dispatches this work object. 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 the system dispatch is called.
Throws:
VWException - Thrown if it cannot set a map to be called when the system dispatches this work object.

getCallMap

public java.lang.String getCallMap()
Gets the name of the workflow map you specified in the setCallMap method.
Returns:
A String containing the workflow map name. This is not a Java exception.

getStepName

public java.lang.String getStepName()
                             throws VWException
Gets the step name.
Returns:
A String containing the step name. A null value means that the field does not exist.
Throws:
VWException - Thrown if the method is unable to get a string containing the step name.

getServerLocation

public int getServerLocation()
                      throws VWException
Get the current server location of the work object.
Returns:
Number of the server where the work object is
Throws:
VWException - Thrown if a problem occurs

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.