Process Class Relationships

filenet.vw.api
Class VWInstructionElement

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

public final class VWInstructionElement
extends filenet.vw.api.VWWorkElement

Use this class to access the current operation on a workflow object, along with the operation parameters. An Instruction Element represents the Instruction invocation for the workflow object, which eliminates needing to retrieve the entire workflow object. Once you have an Instruction Element, your application can fetch a workflow object.

The following methods can create an instance of this class:

See Also:
VWQueue.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int), VWRoster.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int), VWQueueElement, VWQueueQuery, VWRosterElement, VWRosterQuery, VWWorkObject, Serialized Form

Field Summary
static int MODE_IN
          Value of 1: indicates that the field has an IN mode.
static int MODE_IN_OUT
          Value of 3: indicates that the field has an IN and OUT mode.
static int MODE_OUT
          Value of 2: indicates that the field has an OUT mode.
 
Method Summary
 void doAbort()
          Unlocks the workflow object associated with the Instruction Element, without updating the workflow object fields.
 void doDispatch()
          Saves changes made to the work object associated with this Instruction Element, unlocks the work object, and moves the current step to the next workflow step.
 void doLock(boolean overrideLock)
          Locks a workflow object.
static VWException[] doLockMany(VWInstructionElement[] intrs, boolean overrideLock)
          Locks Instruction Elements associated with workflow objects in a single call.
 void doRefresh(boolean lock, boolean overrideLock)
          Fetches the specified Instruction Element to get the most current information.
 void doSave(boolean unlock)
          Saves the workflow object associated with the Instruction Element.
static VWException[] doSaveMany(VWInstructionElement[] invs)
          Saves and updates information for each workflow object specified by the passed array of Instruction Elements.
 void doTerminate()
          Terminates the workflow object associated with the Instruction Element.
static VWException[] doTerminateMany(VWInstructionElement[] elements)
          Terminates workflow objects associated with the passed Instruction Elements.
static VWException[] doUnlockMany(VWInstructionElement[] invs, boolean save, boolean dispatch)
          Unlocks the array of workflow objects specified by the passed Instruction Elements.
 int fetchLockedStatus()
          Checks the status of the workflow object.
 VWWorkObject fetchWorkObject(boolean lock, boolean overrideLock)
          Fetches a workflow object specified in the Instruction Element.
 java.lang.String getExceptionDescription()
          Returns the string value the user set as the description of the VWException.
 java.lang.String getExceptionInstructionSheet()
          Returns the string value the user set as the name of the exception instruction sheet.
 java.lang.String getExceptionMap()
          Gets the exception workflow map for the workflow object associated with the Instruction Element.
 int getFieldMode(java.lang.String fieldName)
          Specifies the parameter mode for the specified field as IN, OUT, or INOUT.
 java.lang.String[] getFieldNames()
          Lists the field names for the Instruction Element parameters.
 java.lang.Object getFieldValue(java.lang.String fieldName)
          Gets the value of the specified field.
 boolean getIsAltered()
          Determines whether or not the fields have been modified.
 java.lang.String getOperationName()
          Gets the name of the current Operation.
 VWParameter[] getParameterDataFields()
          Gets the data fields for the Instruction Element, which excludes participant lists and attachments.
 int getServerLocation()
          Gets the current server location of the work object.
 java.lang.String getStepName()
          Gets the step name.
 java.lang.String getTag()
          Gets the workflow object tag, as the workflow system stores it in the database.
 java.lang.String getWorkClassName()
          Gets the name of the work class which can be used to instantiate the workflow object.
 java.lang.String getWorkFlowNumber()
          Gets the string version of the WorkFlow number.
 java.lang.String getWorkObjectName()
          Gets the workflow object name.
 java.lang.String getWorkObjectNumber()
          Gets the string version of the F_WobNum(workflow object number).
 java.lang.String getWorkPerformerClassName()
          Gets the name of the Work Performer Class associated with the queue on which the workflow object currently resides.
 boolean hasBeenAltered(java.lang.String fieldName)
          Determines whether or not the field has been modified.
 boolean hasFieldName(java.lang.String fieldName)
          Determines whether or not the specified field exists.
 void lock(boolean overrideLock)
          Deprecated. Replaced by doLock(boolean)
static VWException[] lockMany(VWInstructionElement[] intrs, boolean overrideLock)
          Deprecated. Replaced by doLockMany(VWInstructionElement[], boolean)
 void logMessage(int loggingOption, java.lang.String message)
          Logs a message to the default server log.
 void refresh(boolean lock, boolean overrideLock)
          Deprecated. Replaced by doRefresh(boolean, boolean)
 void save()
          Deprecated. Replaced by doSave(boolean)
static VWException[] saveMany(VWInstructionElement[] invs)
          Deprecated. Replaced by doSaveMany(VWInstructionElement[])
 void setException(java.lang.String anInstructionSheetName, java.lang.String aDescription)
          Sets a exception condition for the workflow object specified by the Instruction Element.
 void setFieldValue(java.lang.String fieldName, java.lang.Object fieldValue)
          Sets a value for the specified field.
 void terminate()
          Deprecated. Replaced by doTerminate()
static VWException[] terminateMany(VWInstructionElement[] elements)
          Deprecated. Replaced by doTerminateMany(VWInstructionElement[])
 java.lang.String toString()
          Provides a string version of the workflow object name.
 void unlock(boolean save, boolean dispatch)
          Deprecated. Replaced by doUnlockMany(VWInstructionElement[], boolean, boolean)
static VWException[] unlockMany(VWInstructionElement[] invs, boolean save, boolean dispatch)
          Deprecated. Replaced by doUnlockMany(VWInstructionElement[], boolean, boolean)
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

MODE_IN

public static final int MODE_IN
Value of 1: indicates that the field has an IN mode.

MODE_OUT

public static final int MODE_OUT
Value of 2: indicates that the field has an OUT mode.
See Also:
getFieldMode(java.lang.String)

MODE_IN_OUT

public static final int MODE_IN_OUT
Value of 3: indicates that the field has an IN and OUT mode.
See Also:
getFieldMode(java.lang.String)
Method Detail

fetchWorkObject

public VWWorkObject fetchWorkObject(boolean lock,
                                    boolean overrideLock)
                             throws VWException
Fetches a workflow object specified in the Instruction Element.
Parameters:
lock - A Boolean value. Specify true to lock the workflow object; false otherwise. See also next parameter, below.
overrideLock - A Boolean value. Specify true to override an existing lock on the workflow object, except for a system lock.
Returns:
An instance of the Workflow object that was specified in the Instruction Element.
Throws:
VWException - Thrown if this method cannot fetch a workflow object specified in the Instruction Element.

refresh

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

Fetches the specified Instruction Element to update workflow information.
Parameters:
lock - A Boolean value. Specify true to lock the workflow object.
overrideLock - A Boolean value. Specify true to override an existing lock on the workflow object, except for a system lock.
Throws:
VWException - Thrown if this method cannot fetch the specified Instruction Element to update workflow information.

doRefresh

public void doRefresh(boolean lock,
                      boolean overrideLock)
               throws VWException
Fetches the specified Instruction Element to get the most current information.
Parameters:
lock - A Boolean value. Specify true to lock the workflow object.
overrideLock - A Boolean value. Specify true to override an existing lock on the workflow object, except for a system lock object.
Throws:
VWException - The fetch did not succeed.

unlockMany

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

Unlocks the array of workflow objects specified by the passed Instruction Elements.

The workflow objects must be from the same queue or roster. Each Instruction Element must be from the same VWQueueQuery or VWRosterQuery object.

Parameters:
invs - An array of Instruction Elements to be processed.
save - A Boolean value. Specify true to save workflow object data field values.
dispatch - A Boolean value. Specify true to dispatch the workflow objects. You must save a workflow object before dispatching it.
Returns:
An array of null values or a VWException corresponding to the input elements.
Throws:
VWException - The method throws an exception if a general system or database error occurs.

doUnlockMany

public static VWException[] doUnlockMany(VWInstructionElement[] invs,
                                         boolean save,
                                         boolean dispatch)
                                  throws VWException
Unlocks the array of workflow objects specified by the passed Instruction Elements.

Each Instruction Element must be from the same VWQueueQuery or VWRosterQuery object.

Parameters:
invs - An array of Instruction Elements to be processed.
save - A Boolean value. Specify true to save workflow object data field values.
dispatch - A Boolean value. Specify true to dispatch the workflow objects. You must save a workflow object before dispatching it.
Returns:
An array of values, either null or VWException, that corresponds to the input elements.
Throws:
VWException - The method throws an exception if a general system or database error occurs.

saveMany

public static VWException[] saveMany(VWInstructionElement[] invs)
                              throws VWException
Deprecated. Replaced by doSaveMany(VWInstructionElement[])

Saves and updates information for each workflow object specified by the passed array of Instruction Elements.

The Instruction Elements must be from from the same queue or roster. Each Instruction Element must be from the same VWQueueQuery or VWRosterQuery object.

Parameters:
invs - An array of Instruction Elements to be processed.
Returns:
An array of values, either null or VWException, that corresponds to the input elements.
Throws:
VWException - The method throws an exception if a general system or database error occurs.

doSaveMany

public static VWException[] doSaveMany(VWInstructionElement[] invs)
                                throws VWException
Saves and updates information for each workflow object specified by the passed array of Instruction Elements.

The Instruction Elements must be from from the same queue or roster. Each Instruction Element must be from the same VWQueueQuery or VWRosterQuery object.

Parameters:
invs - An array of Instruction Elements to be processed.
Returns:
An array of values, either null or VWException, that corresponds to the input elements.
Throws:
VWException - The method throws an exception if a general system or database error occurs.

unlock

public void unlock(boolean save,
                   boolean dispatch)
            throws VWException
Deprecated. Replaced by doUnlockMany(VWInstructionElement[], boolean, boolean)

Unlocks the workflow object specified by the Instruction Element.
Parameters:
save - A Boolean value. Specify true to save the workflow object data field values.
dispatch - A Boolean value. Specify true to dispatch the workflow object. You must save a workflow object before dispatching it.
Throws:
VWException - The method throws an exception if the workflow object could not be unlocked. An example would be if it had not been locked by the current user.

setException

public void setException(java.lang.String anInstructionSheetName,
                         java.lang.String aDescription)
                  throws VWException
Sets a exception condition for the workflow object specified by the Instruction Element. If the parameters for this method are set, a VWException occurs when the workflow object is saved or dispatched. The object dispatches to the named instruction sheet.

If a user sets the dispatch flag to 'true', the system catches an error in a parameter value only after the application saves the Instruction Element or unlocks the workflow object associated with the Instruction Element.

Parameters:
aInstructionSheetName - The name of the instruction sheet* Process Engine executes when an exception occurs. A null entry, which is the default, indicates that no exception occurs. Any other entry means an exception occurs when the system unlocks and dispatches a workflow object.
aDescription - -- The description of a VWException, which is not a Java exception.
Throws:
VWException - An exception is thrown if the exception strings could not be set.

getExceptionInstructionSheet

public java.lang.String getExceptionInstructionSheet()
Returns the string value the user set as the name of the exception instruction sheet.
Returns:
The method returns null if no exception is to be raised on the dispatch or save; otherwise, the method returns a string containing the name of the instruction sheet to return to if the Java application raises a VWException. This is not a Java exception.
See Also:
setException(java.lang.String, java.lang.String)

getExceptionDescription

public java.lang.String getExceptionDescription()
Returns the string value the user set as the description of the VWException.
Returns:
The description of the VWException to be raised. This is not a Java exception.
See Also:
setException(java.lang.String, java.lang.String)

save

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

Saves the workflow object.
Throws:
VWException - The method throws an exception if the method could not save the workflow object. This would be the case, for example, if a user other than the current user locked the workflow object.

lockMany

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

Locks Instruction Elements associated with workflow objects in a single call. This method is typically used in conjunction with doSaveMany(filenet.vw.api.VWInstructionElement[]), to update groups of Instruction Elements.

The array of workflow objects comes from one of the following sources:

Parameters:
intrs - An array of Instruction Elements to be processed.
overrideLock - A Boolean value. Specify true to override locks that are not system locks.
Returns:
If the operation succeeds, the method returns null. If the operation fails, the method returns a VWException, which indicates a problem with the specified input element.
Throws:
VWException - The method throws an exception if a general system or database error occurs.
See Also:
doSaveMany(VWInstructionElement[])

doLockMany

public static VWException[] doLockMany(VWInstructionElement[] intrs,
                                       boolean overrideLock)
                                throws VWException
Locks Instruction Elements associated with workflow objects in a single call. This method is typically used in conjunction with doSaveMany(filenet.vw.api.VWInstructionElement[]), to update groups of Instruction Elements.

The array of workflow objects come from one of the following sources:

Parameters:
intrs - An array of Instruction Elements to be processed.
overrideLock - A Boolean value. Specify true to override locks that are not system locks.
Returns:
If the operation succeeds, the method returns null. If the operation fails, the method returns a VWException, which indicates a problem with the specified input element.
Throws:
VWException - The method throws an exception if a general system or database error occurs.
See Also:
doSaveMany(VWInstructionElement[])

lock

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

Locks a workflow object.
Parameters:
overrideLock - A Boolean value. Specify true to override locks that are not system locks.
Throws:
VWException - Thrown if the workflow object could not be locked.

doLock

public void doLock(boolean overrideLock)
            throws VWException
Locks a workflow object.
Parameters:
overrideLock - A Boolean value. Specify true to override locks that are not system locks.
Throws:
VWException - Thrown if the workflow object could not be locked.

terminateMany

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

Terminates workflow objects associated with the passed Instruction Elements. Terminating a workflow object dispatches the object to the terminate instruction sheet. The array of workflow objects must come from a query on the same roster or queue.
Parameters:
elements - An array of workflow objects to be processed.
Returns:
If the operation succeeds, the method returns null. If the operation fails, the method returns a VWException which corresponds with the input elements.
Throws:
VWException - This method throws an error if a general system or database error occurs.

doTerminateMany

public static VWException[] doTerminateMany(VWInstructionElement[] elements)
                                     throws VWException
Terminates workflow objects associated with the passed Instruction Elements. Terminating a workflow object dispatches the object to the terminate instruction sheet. The array of workflow objects must come from a query on the same roster or queue.
Parameters:
elements - An array of workflow objects to be processed.
Returns:
If the operation succeeds, the method returns null. If the operation fails, the method returns a VWException which corresponds with the input elements.
Throws:
VWException - This method throws an error if a general system or database error occurs.

terminate

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

Terminates the workflow object associated with the Instruction Element. Terminating a workflow object dispatches the object to the terminate instruction sheet.
Throws:
VWException - This method throws an error if the workflow object could not be terminated. An example of this would be if a user other than the current user locks the workflow object.

doTerminate

public void doTerminate()
                 throws VWException
Terminates the workflow object associated with the Instruction Element. Terminating a workflow object dispatches the object to the terminate instruction sheet.
Throws:
VWException - This method throws an error if the workflow object could not be terminated. An example of this would be if a user other than the current user locks the workflow object.

fetchLockedStatus

public int fetchLockedStatus()
                      throws VWException
Checks the status of the workflow object. This method requires network transfer to get the status information.
Returns:
An integer value indicating the lock status of the workflow object. 0(zero) indicates that the object is not locked(LOCKED_BY_NONE, 1(one) indicates that the object is locked by a user(LOCKED_BY_USER), and 2(two) indicates the object is locked by the system (LOCKED_BY_SYSTEM). See VWQueueElement for status definitions.
Throws:
VWException - This method throws an error if the workflow object lock status could not be determined.
See Also:
VWQueueElement

getFieldNames

public java.lang.String[] getFieldNames()
Lists the field names for the Instruction Element parameters. This method retrieves only user-defined fields for Instruction Elements.
Returns:
An array of the user-defined field names.

getFieldValue

public java.lang.Object getFieldValue(java.lang.String fieldName)
                               throws VWException
Gets the value of the specified field.
Parameters:
fieldName - The name of the specified field.
Returns:
A object containing the value of the specified field; a field that has an OUT mode parameter returns a null value. An object and an array of objects must be of one of the following types: Integer, String, Double, or Boolean. A field can have a null value.
Throws:
VWException - The method throws an exception if the field specified in the fieldName parameter string does not exist.

setFieldValue

public void setFieldValue(java.lang.String fieldName,
                          java.lang.Object fieldValue)
                   throws VWException
Sets a value for the specified field.

Note: Only fields with OUT and INOUT parameter modes are editable.

Parameters:
fieldName - The name of the required field.
fieldValue - An object containing the value of the named field. An object and an array of objects must be of one of the following types: Integer, String, Double, or Boolean. A field can have a null value.
Throws:
VWException - The method throws an exception if the field specified in the fieldName parameter string does not exist.
See Also:
hasFieldName( String )

hasFieldName

public boolean hasFieldName(java.lang.String fieldName)
                     throws VWException
Determines whether or not the specified field exists.
Parameters:
fieldName - The name of the specified field.
Returns:
A Boolean value. The method returns true if the field specified in the fieldName parameter exists; the method returns false if the system cannot find the field, for any reason.
Throws:
VWException - The method throws an exception if the field name parameter is null.

getIsAltered

public boolean getIsAltered()
Determines whether or not the fields have been modified.
Returns:
A Boolean value. The method returns true if a field has been altered; otherwise, the method returns false.

hasBeenAltered

public boolean hasBeenAltered(java.lang.String fieldName)
                       throws VWException
Determines whether or not the field has been modified.
Parameters:
fieldName - The name of the specified field.
Returns:
A Boolean value. The method returns true if the field has been modified; otherwise, the method returns false.
Throws:
VWException - The method throws an exception if the field name parameter is null.

getFieldMode

public int getFieldMode(java.lang.String fieldName)
                 throws VWException
Specifies the parameter mode for the specified field as IN, OUT, or INOUT. Only OUT and INOUT parameter modes are editable. The Operation parameter mode determines the direction which data flows between the parameter and the workflow object. The mode controls the flow in the following manner:

Parameters:
fieldName - The name of the required field.
Returns:
An integer value indicating the mode of the specified field: 1(one) indicates IN mode, 2(two) indicates OUT mode, and 3(three) indicates INOUT mode.
Throws:
VWException - The method throws an exception if the field specified in the fieldName parameter does not exist.

getWorkObjectName

public java.lang.String getWorkObjectName()
                                   throws VWException
Gets the workflow object name. The name is the workflow object ID field, set on the work class properties page in the Composer interface.
Returns:
A string value containing the name of the workflow object.
Throws:
VWException - The method throws an exception if the field specified in the fieldName parameter does not exist.

getWorkObjectNumber

public java.lang.String getWorkObjectNumber()
                                     throws VWException
Gets the string version of the F_WobNum(workflow object number). Use the returned string as an index value.
Returns:
The workflow object number, which corresponds to the F_WobNum queue field.
Throws:
VWException - The method throws an exception if a general system or database problem occurs.

getTag

public java.lang.String getTag()
                        throws VWException
Gets the workflow object tag, as the workflow system stores it in the database. The workflow system creates the workflow object tag by normalizing numeric representation in the workflow name. Workflow system normalization formats numbers in a name to be consistently sortable.
Returns:
A string representing the Tag.
Throws:
VWException - The method throws an exception if a general system or database problem occurs.

getWorkClassName

public java.lang.String getWorkClassName()
                                  throws VWException
Gets the name of the work class which can be used to instantiate the workflow object.
Returns:
A string name of the work class.
Throws:
VWException - The method throws an exception if a general system or database problem occurs.

getWorkPerformerClassName

public java.lang.String getWorkPerformerClassName()
                                           throws VWException
Gets the name of the Work Performer Class associated with the queue on which the workflow object currently resides.
Returns:
The name of the current Work Performer Class.
Throws:
VWException - The method throws an exception if a general system or database problem occurs.

getOperationName

public java.lang.String getOperationName()
                                  throws VWException
Gets the name of the current Operation.
Returns:
The name of current Operation.
Throws:
VWException - The method throws an exception if a general system or database problem occurs.

logMessage

public void logMessage(int loggingOption,
                       java.lang.String message)
                throws VWException
Logs a message to the default server log. This method is does not operate on rosters, so it should not be used on objects created by the VWRoster.createQuery() or the deprecated method VWRoster.startQuery(). To log user-defined messages, the specified logging option must be currently turned ON(1) in the WorkPerformer's set of logging options and in the configuration logging vector. Each of the specified logging options is for the programmer's use in categorizing logging messages.
Parameters:
loggingOption - An integer value that indicates the available Process Engine message category to log. The programmer is responsible for maintaining meaningful message grouping in each category. Available logging categories or "option types" are:

  • 410: LOGGING_OPTION_TYPE_USER1_MESSAGE1
  • 420: LOGGING_OPTION_TYPE_USER1_MESSAGE2
  • 430: LOGGING_OPTION_TYPE_USER1_MESSAGE3
  • 440: LOGGING_OPTION_TYPE_USER1_MESSAGE4
  • 450: LOGGING_OPTION_TYPE_USER2_MESSAGE1
  • 460: LOGGING_OPTION_TYPE_USER2_MESSAGE2
  • 470: LOGGING_OPTION_TYPE_USER2_MESSAGE3
  • 480: LOGGING_OPTION_TYPE_USER3_MESSAGE4
message - The text message to log.
Throws:
VWException - The method throws an exception if the message could not be logged, as when this method is used on a roster. LogMessage is not intended for use with an object created by the createQuery() or startQuery() (deprecated) methods of the VWRoster class.
Since:
VWWS3.10

toString

public java.lang.String toString()
Provides a string version of the workflow object name.
Overrides:
toString in class java.lang.Object
Returns:
A string containing name of the workflow object.

doAbort

public void doAbort()
             throws VWException
Unlocks the workflow object associated with the Instruction Element, without updating the workflow object fields.
Throws:
VWException - The method throws an exception if the unlock operation for the workflow object is unsuccessful.
Since:
VWWS3.10

doDispatch

public void doDispatch()
                throws VWException
Saves changes made to the work object associated with this Instruction Element, unlocks the work object, 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

getExceptionMap

public java.lang.String getExceptionMap()
                                 throws VWException
Gets the exception workflow map for the workflow object associated with the Instruction Element.
Throws:
VWException - The method throws an exception if the exception workflow map for the workflow object could not be retrieved. This would often be a general system or database problem.
Since:
VWWS3.10

doSave

public void doSave(boolean unlock)
            throws VWException
Saves the workflow object associated with the Instruction Element.
Parameters:
unlock - A Boolean value. Specify true to save and unlock the workflow object, which stops the processing associated with the workflow object. Specify false to save the workflow object, which keeps the object locked and continues processing it.
Throws:
VWException - The method throws an exception if the save operation fails or the workflow object was not locked by the current user.
Since:
VWWS3.10

getParameterDataFields

public VWParameter[] getParameterDataFields()
                                     throws VWException
Gets the data fields for the Instruction Element, which excludes participant lists and attachments.
Returns:
An array of data fields for the Instruction Element.
Since:
VWWS3.10

getWorkFlowNumber

public java.lang.String getWorkFlowNumber()
                                   throws VWException
Gets the string version of the WorkFlow number. Use the returned F_WorkFlowNumber as an index key component.
Returns:
Workflow object number as a string, which corresponds to the F_WorkFlowNumber. Returns null if the field does not exist.
Throws:
VWException -  

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
Gets the current server location of the work object.
Returns:
Number of the server for the work object
Throws:
VWException -  


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.