Process Class Relationships

filenet.vw.api
Class VWStepElement

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

public final class VWStepElement
extends filenet.vw.api.VWWorkElement
implements java.io.Serializable, IVWtoXML

Use this class to access a step in a workflow process. Accessing a step allows a participant in a workflow process to accept work and add attachments to the process. The participant may delegate/reassign a step to another user.

Since:
VWWS3.10
See Also:
VWQueueElement, VWQueueQuery, VWWorkObject, Serialized Form

Field Summary
static int FIELD_SYSTEM_DEFINED
          Value of 2. Indicates that the field is a system-defined field.
static int FIELD_USER_AND_SYSTEM_DEFINED
          Value of 3. Indicates that the field is both a user- and system-defined field.
static int FIELD_USER_DEFINED
          Value of 1. Indicates that the field is a user-defined field.
 
Method Summary
 void doAbort()
          Unlocks a work item associated with this step without updating the fields on the work item.
 void doDispatch()
          Saves changes made to the work object associated with this step element, unlocks the work object, and moves the current step to the next workflow step.
 void doLock(boolean overrideLock)
          Locks the work item associated with this step element.
 void doReassign(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)
          Fetches an updated version of the instruction to get the latest information.
 void doReturnToSource()
          Returns the work item to the queue from which a user originally reassigned or delegated the work item.
 void doSave(boolean unlock)
          Saves the work item associated with this step element.
static VWException[] doUnlockMany(VWStepElement[] stepElements, boolean save, boolean dispatch)
          Unlocks an array of step elements.
 VWProcess fetchProcess()
          Retrieves the workflow process that contains this step element object.
 VWWorkObject fetchWorkObject(boolean lock, boolean overrideLock)
          Fetches the work item associated with this step element.
 java.lang.String getCallMap()
          Gets the name of the workflow map you set using the setCallMap method.
 boolean getCanReassign()
          Determines whether the work item can be reassigned.
 boolean getCanReturnToSource()
          Determines whether the work item can be returned to the queue from which the user delegated or reassigned it.
 boolean getCanViewHistory()
          Determines whether this step element's history can be viewed through the step processor.
 boolean getCanViewStatus()
          Determines whether this step element can be viewed through the tracker application.
 java.lang.String getComment()
          Gets the comment for this step.
 java.lang.String getCurrentMapName()
          Gets the name of the map for the step.
 java.lang.String getCurrentQueueName()
          Gets the name of the queue on which the work item resides.
 java.util.Date getDateReceived()
          Gets the date on which the user received this step.
 java.util.Date getDeadline()
          Gets the date value that represents the date by which the step must be completed.
 java.lang.String getExceptionDescription()
          Gets the value the workflow author set for description of the workflow exception.
 java.lang.String getExceptionMap()
          Gets the name of the workflow exception that corresponds to the workflow map.
 boolean getIsLaunchStep()
          Determines whether the current work item is a launch step.
 boolean getIsTracker()
          Determines whether the current work item is a tracker work item.
 java.util.Date getLaunchDate()
          Gets the date on which the workflow process associated with this step started.
 java.lang.String getOperationName()
          Gets the name of the current operation on the work item.
 java.lang.String getOriginator()
          Gets the name of the user who initiated the workflow process containing this step.
 int getOverdue()
          Gets status of the overdue notice.
 java.lang.String[] getParameterNames()
          Lists system and user step element parameter names.
 VWParameter[] getParameters(int fieldTypeFlag, int fieldCreatorFlag)
          Gets the system or user (or both) parameters in this step, given their specific types.
 java.lang.Object getParameterValue(java.lang.String parameterName)
          Gets the value of a specified parameter.
 java.lang.String getParticipantName()
          Gets the name of the participant who is processing the current step.
 java.lang.String getQueueName()
          Gets the name of the queue this step element associated with the current operation.
 java.util.Date getReminder()
          Gets the date on which the application issues a reminder for this step.
 java.lang.String getRosterName()
          Gets the name of the roster associated with the work item.
 java.lang.String getSelectedResponse()
          Gets the response selected by the user for the current step.
 int getServerLocation()
          Gets the current server location of the work object.
 java.lang.String getStepDescription()
          Gets the description of a step.
 java.lang.String getStepName()
          Gets the String step name.
 java.lang.String[] getStepResponses()
          Gets a list of available responses for the current step.
 java.lang.String getSubject()
          Gets the subject of the workflow associated with the current step.
 java.lang.String getTag()
          Gets the work item tag.
 int getWorkClassId()
          Gets the ID of the work class for this work item.
 java.lang.String getWorkClassName()
          Gets the name of the work class from which the application instantiates the work item.
 java.lang.String getWorkflowName()
          Gets the name of the workflow associated with the current step.
 java.lang.String getWorkflowNumber()
          Gets the string version of the workflow number.
 java.lang.String getWorkFlowNumber()
          Deprecated. Replaced by getWorkflowNumber()
 java.lang.String getWorkObjectName()
          Gets the work item name.
 java.lang.String getWorkObjectNumber()
          Gets the work item number, in string format.
 int getWorkSpaceId()
          Gets the ID of the work space for this work item.
 boolean hasParameterName(java.lang.String parameterName)
          Determines whether a specific parameter exists.
 void setCallMap(java.lang.String aMapName)
          Specifies a map to be called when the system dispatches this work object.
 void setComment(java.lang.String comment)
          Sets the comment for this step.
 void setException(java.lang.String workflowMapName, java.lang.String description)
          Sets an exception condition for the work item that corresponds to the workflow map associated with this step element.
 void setParameters(VWParameter[] parameters, boolean compareValues)
          Sets the values for specified parameters in an array.
 void setParameterValue(java.lang.String parameterName, java.lang.Object parameterValue, boolean compareValue)
          Sets a value for a specified parameter.
 void setSelectedResponse(java.lang.String response)
          Sets a selected response for this step.
 java.lang.String toString()
          Gets the string version of the work item name.
 void toXML(java.lang.StringBuffer theBuffer)
          Appends an XML string that represents this VWStepElement object to the buffer specified by the input parameter.
 
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 field is a user-defined field.

FIELD_SYSTEM_DEFINED

public static final int FIELD_SYSTEM_DEFINED
Value of 2. Indicates that the field is a system-defined field.

FIELD_USER_AND_SYSTEM_DEFINED

public static final int FIELD_USER_AND_SYSTEM_DEFINED
Value of 3. Indicates that the field is both a user- and system-defined field.
Method Detail

doAbort

public void doAbort()
             throws VWException
Unlocks a work item associated with this step without updating the fields on the work item.
Throws:
VWException - The method throws an exception if the system cannot unlock the work item.

doDispatch

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

fetchWorkObject

public VWWorkObject fetchWorkObject(boolean lock,
                                    boolean overrideLock)
                             throws VWException
Fetches the work item associated with this step element.
Parameters:
lock - A boolean value. Specify true to lock the work item; otherwise, specify false.
overrideLock - A boolean value. Specify true to override the lock on the work item.
Returns:
A VWWorkObject object that represents the work item associated with the step element.
Throws:
VWException - The method throws an exception if the system cannot fetch the work item.

fetchProcess

public VWProcess fetchProcess()
                       throws VWException
Retrieves the workflow process that contains this step element object.
Returns:
A VWProcess object that represents the workflow process containing this step element.
Throws:
VWException - Thrown if the system cannot fetch the workflow process.
Since:
VWWS4.20

getIsTracker

public boolean getIsTracker()
                     throws VWException
Determines whether the current work item is a tracker work item.
Returns:
A boolean value. The method returns true if the work item associated with this step element is a tracker.
Throws:
VWException - The method throws an exception if it cannot determine whether the current work item is a tracker work item.

getParameters

public VWParameter[] getParameters(int fieldTypeFlag,
                                   int fieldCreatorFlag)
                            throws VWException
Gets the system or user (or both) parameters in this step, given their specific types.
Parameters:
fieldTypeflag - An integer value specifying the parameter type.

  • 1: Integer (FIELD_TYPE_INT)
  • 2: String (FIELD_TYPE_STRING)
  • 4: Boolean (FIELD_TYPE_BOOLEAN)
  • 8: Float (FIELD_TYPE_FLOAT)
  • 16: Time (FIELD_TYPE_TIME)
  • 32: Attachment (FIELD_TYPE_ATTACHMENT)
  • 64: Participant (FIELD_TYPE_PARTICIPANT)

You can logically OR or AND the VWFieldType values to enter a value for this parameter.

fieldCreatorFlag - An integer value specifying the field type (user, system, or both).

Valid values are as follows:

  • 1: User (FIELD_USER_DEFINED)
  • 2: System (FIELD_SYSTEM_DEFINED)
  • 3: User and System (FIELD_USER_AND_SYSTEM_DEFINED)

You can logically OR or AND these values.

Returns:
An array of VWParameter objects that represent the parameters for this step. If the no parameters exist or the system cannot find parameters, the method returns null.
Throws:
VWException - The method throws an exception if an error while the system attempts to return the parameters.
See Also:
VWParameter

getComment

public java.lang.String getComment()
                            throws VWException
Gets the comment for this step.
Returns:
A String containing the comment entered for this step. Unless setComment() was called prior to calling this method, the String might contain a null value.
Throws:
VWException - The method throws an exception if it cannot get the comment for this step.

setComment

public void setComment(java.lang.String comment)
                throws VWException
Sets the comment for this step.
Parameters:
comment - A String containing the new comment for this step.
Throws:
VWException - This method returns an exception if it cannot set the comment for this step.

getDateReceived

public java.util.Date getDateReceived()
                               throws VWException
Gets the date on which the user received this step.
Returns:
A date value representing the date on which the user received this step. If the system cannot locate the information, the method returns null.
Throws:
VWException - The method throws an exception if it cannot get the date on which the user received this step.

getExceptionDescription

public java.lang.String getExceptionDescription()
Gets the value the workflow author set for description of the workflow exception.
Returns:
A String containing the description of the workflow exception, which is raised if a workflow error or exception occurs. This is not a Java exception.
See Also:
setException(java.lang.String, java.lang.String)

getExceptionMap

public java.lang.String getExceptionMap()
Gets the name of the workflow exception that corresponds to the workflow map.
Returns:
A String containing the workflow map name of the workflow exception, which is raised if a workflow error or exception occurs. This is not a Java exception.

setException

public void setException(java.lang.String workflowMapName,
                         java.lang.String description)
                  throws VWException
Sets an exception condition for the work item that corresponds to the workflow map associated with this step element. If you set the parameters for this method, a workflow exception occurs when the application saves or dispatches a step element. The system dispatches a work item to the workflow map you name. This is not a Java exception.

The system catches a parameter value error only upon saving, dispatching, or terminating this step element.

Parameters:
workflowMapName - A String containing the name of the workflow map the Process workflow executes when the system raises the exception:

  • If you enter null (the default), the system raises no exception.
  • If you enter a map name, the system raises an exception when the system saves, dispatches, or terminates the work item associated with this step element.

description - A String containing the description of the exception to be raised.
Throws:
VWException - The method throws an exception if it cannot set an exception condition for the work item that corresponds to the workflow map associated with this step element.

getLaunchDate

public java.util.Date getLaunchDate()
                             throws VWException
Gets the date on which the workflow process associated with this step started.
Returns:
A date value representing the date which the workflow process associated with the step began. If the system cannot find the date information, the method returns null.
Throws:
VWException - The method throws an exception if it cannot get the date on which the workflow process associated with this step started.

getOriginator

public java.lang.String getOriginator()
                               throws VWException
Gets the name of the user who initiated the workflow process containing this step.
Returns:
A String containing the name of the user who started the workflow process containing the current step. If the no user name is found, the method returns null.
Throws:
VWException - The method throws an exception if it cannot retrieve the name of the originator of the workflow process.

getParticipantName

public java.lang.String getParticipantName()
                                    throws VWException
Gets the name of the participant who is processing the current step. If the participant name is a user queue, the method returns the name of the user of the work item associated with the current step.
Returns:
A String containing the name of the participant currently processing the step. If the system cannot find the participant name, the method returns null.
Throws:
VWException - The method throws an exception if it cannot retrieve the name of the participant currently processing the step.

getStepResponses

public java.lang.String[] getStepResponses()
                                    throws VWException
Gets a list of available responses for the current step.
Returns:
An array of strings that represent the available responses for the current step. If no responses exist, the method returns null.
Throws:
VWException - The method throws an exception if it cannot retrieve the available responses for the current step.

getSelectedResponse

public java.lang.String getSelectedResponse()
                                     throws VWException
Gets the response selected by the user for the current step.
Returns:
The response selected by the user for the current step.If the setSelectedResponse() method has not been called previously, the method returns null.
Throws:
VWException - The method throws an exception if it cannot retrieve the selected response.

setSelectedResponse

public void setSelectedResponse(java.lang.String response)
                         throws VWException
Sets a selected response for this step.
Parameters:
response - The response being selected for the step.
Throws:
VWException - The method throws an exception if it cannot set the selected response.

doLock

public void doLock(boolean overrideLock)
            throws VWException
Locks the work item associated with this step element.
Parameters:
overrideLock - A boolean value. Specify true to override the lock; otherwise, specify false. This method cannot override a system lock.
Throws:
VWException - The method throws an exception if a problem occurs while the system attempts to lock the work item.

doReturnToSource

public void doReturnToSource()
                      throws VWException
Returns the work item to the queue from which a user originally reassigned or delegated the work item.
Throws:
VWException - The method throws an exception if a problem occurs while the system attempts to return the work item to the source queue.

doRefresh

public void doRefresh(boolean lock,
                      boolean overrideLock)
               throws VWException
Fetches an updated version of the instruction to get the latest information.
Parameters:
lock - A boolean value. Specify true to lock the work ite m; otherwise, specify false.
overrideLock - A boolean value. Specify true to override any lock on the work item except a system lock; otherwise, specify false.
Throws:
VWException - The method throws an exception if it cannot fetch an updated version of the instruction to get the latest information.

A benign change in the current queue contents since the last refresh results in an exception being thrown when this API is invoked. Such a change occurs when a work object is removed from the current queue or fetched from another queue in the course of ordinary workflow activity. The developer is responsible for preventing superfluous error messages in such situations.


doReassign

public void doReassign(java.lang.String participant,
                       boolean delegateFlag,
                       java.lang.String queueName)
                throws VWException
Changes the participant responsible for processing the current step.
Parameters:
participant - The name of the new participant being assigned to process the step.
delegateFlag - A boolean value. Specify true if you delegate the assignment and plan to review the completed assignment; otherwise specify false.
queueName - The queue name to which the work item is to be moved.

If the queueName parameter value is null the queueName 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 queueName will default to "Inbox".

Throws:
VWException - The method throws an exception if the system cannot reassign this step to the other participant.

doSave

public void doSave(boolean unlock)
            throws VWException
Saves the work item associated with this step element.
Parameters:
unlock - A boolean value. Specify true to save and unlock the work item; specify false to maintain the current lock and save the work item.
Throws:
VWException - The method throws an exception if an error occurs while the system attempts to save the work item, or if someone other than you locked the work item.

doUnlockMany

public static VWException[] doUnlockMany(VWStepElement[] stepElements,
                                         boolean save,
                                         boolean dispatch)
                                  throws VWException
Unlocks an array of step elements. The step elements 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 VWStepElement object that represent the step elements to unlock.

save - A boolean value. Specify true to save data field values of the step elements; otherwise, specify false.

dispatch - A boolean value. Specify true to dispatch the step elements. You must save step element data before dispatching the step.
Returns:
An array VWException objects that represent to input elements, or an array of null values.
Throws:
VWException - The method throws an exception if it cannot unlock an array of step elements.

getWorkObjectNumber

public java.lang.String getWorkObjectNumber()
                                     throws VWException
Gets the work item number, in string format. The returned value is useful to compare to a queue index key component containing F_WobNum.
Returns:
The work item number, in string format, as it corresponds to the F_WobNum queue field.
Throws:
VWException -  

getWorkObjectName

public java.lang.String getWorkObjectName()
                                   throws VWException
Gets the work item name.
Returns:
The name of the work item.
Throws:
VWException - The method throws an exception if it cannot get the work item name.

getTag

public java.lang.String getTag()
                        throws VWException
Gets the work item tag.
Returns:
The tag of the work item. The system normalizes the work item name and saves it as a tag in the database. Normalizing ensures correct sorting of work items.
Throws:
VWException - The method throws an exception if it cannot get the work item tag.

getWorkClassName

public java.lang.String getWorkClassName()
                                  throws VWException
Gets the name of the work class from which the application instantiates the work item.
Returns:
The name of the work class.
Throws:
VWException - The method throws an exception if it cannot get the name of the work class from which the application instantiates the work item.

getQueueName

public java.lang.String getQueueName()
                              throws VWException
Gets the name of the queue this step element associated with the current operation. The queue name and the current queue name may not match if the object was delegated or reassigned.
Returns:
The name of the queue class.
Throws:
VWException - The method throws an exception if it cannot get the name of the queue this step element associated with the current operation.
See Also:
getCurrentQueueName()

getOperationName

public java.lang.String getOperationName()
                                  throws VWException
Gets the name of the current operation on the work item.
Returns:
The name of current operation on the work item.
Throws:
VWException - The method throws an exception if it cannot get the name of the current operation on the work item.

getStepName

public java.lang.String getStepName()
                             throws VWException
Gets the String step name.
Overrides:
getStepName in class filenet.vw.api.VWFieldsObject
Returns:
A String containing the step name, or null if the field does not exist.
Throws:
VWException - Thrown if this method cannot get the string step name from an existing step name field.

toString

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

getDeadline

public java.util.Date getDeadline()
                           throws VWException
Gets the date value that represents the date by which the step must be completed.
Returns:
A date value representing the date by which the step is to be completed.
Throws:
VWException - The method throws an exception if the system cannot retrieve the date value of the deadline.

getReminder

public java.util.Date getReminder()
                           throws VWException
Gets the date on which the application issues a reminder for this step.
Returns:
A date value representing the date on which the application issues a reminder for the step.
Throws:
VWException - The method throws an exception if the system cannot retrieve date value for the reminder.

getSubject

public java.lang.String getSubject()
                            throws VWException
Gets the subject of the workflow associated with the current step.
Returns:
The test of the subject for the workflow associated with the step.
Throws:
VWException - The method throws an exception if it cannot get the subject of the workflow associated with the current step.

getWorkflowName

public java.lang.String getWorkflowName()
                                 throws VWException
Gets the name of the workflow associated with the current step.
Returns:
The name of workflow associated with the step.
Throws:
VWException - The method throws an exception if it cannot get the name of the workflow associated with the current step.

setParameters

public void setParameters(VWParameter[] parameters,
                          boolean compareValues)
                   throws VWException
Sets the values for specified parameters in an array. You can modify only those parameters with VWModeType.MODE_TYPE_OUT or VWModeType.MODE_TYPE_IN_OUT modes.
Parameters:
parameters - An array of VWParameter objects containing the new values for the given array of parameters.
compareValues - A boolean value. Specify true to set only changed values; otherwise, specify false to set all values in a field to flag that they are modified.
Throws:
VWException - The method throws an exception if the system cannot set any one of the specified parameters values. Some examples of conditions in the parameters array that cause this method to throw exceptions are:

  • One or more of the parameters names is null.
  • One of the parameters for this method is null.
  • One or more of the VWParameter objects cannot be matched to a parameter contained in this VWStepElement.
  • One or more of the VWParameter objects is assigned mode type IN: this means that the workflow author intended the referenced parameter not to change.


getRosterName

public java.lang.String getRosterName()
                               throws VWException
Gets the name of the roster associated with the work item.
Returns:
The name of the roster associated with the work item.
Throws:
VWException - The method throws an exception if an error occurs while the system attempts to retrieve the roster name.
Since:
VWWS3.10

getWorkFlowNumber

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

Gets 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:
The version of the work item number corresponding to the F_WorkFlowNumber. If the system cannot find the information, the method returns null.
Throws:
VWException - The method throws an exception if it cannot get the string version of the workflow number.

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:
The version of the work item number corresponding to the F_WorkFlowNumber. If the system cannot find the information, the method returns null.
Throws:
VWException - The method throws an exception if it cannot get the string version of the workflow number.

hasParameterName

public boolean hasParameterName(java.lang.String parameterName)
                         throws VWException
Determines whether a specific parameter exists.
Parameters:
parameterName - The name of the parameter to check.
Returns:
A boolean value. The method returns true if the system finds the parameter specified in the parameterName parameter. If the system cannot find the specified parameter, the method returns false.
Throws:
VWException - The method throws an exception if the parameter name specified in the parameterName parameter is null.

getStepDescription

public java.lang.String getStepDescription()
                                    throws VWException
Gets the description of a step.
Returns:
The description of the current step.
Throws:
VWException - The method throws an exception if the system cannot retrieve the description for the step.

getParameterNames

public java.lang.String[] getParameterNames()
Lists system and user step element parameter names.
Returns:
An array containing strings that represent individual system- or user-defined field names.

getParameterValue

public java.lang.Object getParameterValue(java.lang.String parameterName)
                                   throws VWException
Gets the value of a specified parameter. An object and an array of objects must be of one of the following types:

A parameter can have a null value.

Parameters:
parameterName - The name of the parameter for which to retrieve the value.
Returns:
An object that contains the value of the parameter specified in the parameterName parameter. If the specified parameter has an OUT mode, the method returns null.
Throws:
VWException - The method throws an exception if the system does not find the parameter specified in the parameterName parameter.

setParameterValue

public void setParameterValue(java.lang.String parameterName,
                              java.lang.Object parameterValue,
                              boolean compareValue)
                       throws VWException
Sets a value for a specified parameter. You can modify only those parameters with VWModeType.MODE_TYPE_OUT or VWModeType .MODE_TYPE_IN_OUT modes.
Parameters:
parameterName - The name of the parameter for which the value is being set.

parameterValue - An object containing the value of being set in the specified parameter.

compareValue - A boolean value. Specify true to set only the changed values. Specify false if you want all values in a field to flag they are modified.
Throws:
VWException - The method throws an exception if the field name specified in the parameterName parameter does not exist.

getCanReassign

public boolean getCanReassign()
                       throws VWException
Determines whether the work item can be reassigned.
Returns:
A boolean value. The method returns true if the work item associated with the step element can be reassigned; otherwise the method returns false.
Throws:
VWException - The method throws an exception if it cannot determine whether the work item can be reassigned.

getCanReturnToSource

public boolean getCanReturnToSource()
                             throws VWException
Determines whether the work item can be returned to the queue from which the user delegated or reassigned it.
Returns:
A boolean value. The method returns true if the work item associated with this step element can be returned to its original (source) queue.
Throws:
VWException - The method throws an exception if it cannot determine whether the work item can be returned to the queue from which the user delegated or reassigned it.

getCanViewStatus

public boolean getCanViewStatus()
                         throws VWException
Determines whether this step element can be viewed through the tracker application.
Returns:
A boolean value. The method returns true if the step can be viewed through the tracker; otherwise, the method returns false.
Throws:
VWException - The method throws an exception if it cannot determine whether this step element can be viewed through the tracker application.

getCurrentQueueName

public java.lang.String getCurrentQueueName()
                                     throws VWException
Gets the name of the queue on which the work item resides.
Returns:
A String containing the name of the queue in which the work item currently resides.
Throws:
VWException - The method throws an exception if it cannot get the name of the queue on which the work item resides.

getOverdue

public int getOverdue()
               throws VWException
Gets status of the overdue notice.
Returns:
Integer that represents the status, as follows:

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

Throws:
VWException - The method throws an exception if the system cannot retrieve the overdue status.

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML string that represents this VWStepElement object to the buffer specified by the input parameter.
Specified by:
toXML in interface IVWtoXML
Parameters:
theBuffer - A string buffer that this method will append with XML content.
Throws:
VWException -  
See Also:
VWXMLUtil

getIsLaunchStep

public boolean getIsLaunchStep()
Determines whether the current work item is a launch step.
Returns:
a boolean value: 'true' if the work item associated with this step element is a launch step which has not been dispatched; 'false', otherwise.

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 set using the setCallMap method.
Parameters:
mapName - Name of the map to call.
Returns:
A String containing the workflow map name.

getWorkSpaceId

public int getWorkSpaceId()
                   throws VWException
Gets the ID of the work space for this work item.
Returns:
A value that represents the work space id.
Throws:
VWException - if a problem occurs retrieving the work space id.
Since:
eP4.2.2

getWorkClassId

public int getWorkClassId()
                   throws VWException
Gets the ID of the work class for this work item.
Returns:
A value that represents the work class id.
Throws:
VWException - if a problem occurs retrieving the work class id.
Since:
eP4.2.2

getCanViewHistory

public boolean getCanViewHistory()
                          throws VWException
Determines whether this step element's history can be viewed through the step processor.
Returns:
A boolean value. The method returns true if the step history can be viewed through the step processor; otherwise, the method returns false.
Throws:
VWException - The method throws an exception if it cannot determine whether this step element history can be viewed through the step processor.
Since:
eP6.0

getCurrentMapName

public java.lang.String getCurrentMapName()
                                   throws VWException
Gets the name of the map for the step.
Returns:
The name of the current workflow map.
Throws:
VWException - The method throws an exception if it cannot get the name of the map for the step.
Since:
eP6.0

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.