Process API

filenet.vw.api
Class VWStepElement

java.lang.Object
  extended by filenet.vw.api.VWStepElement
All Implemented Interfaces:
IVWtoXML, java.io.Serializable

public final class VWStepElement
extends java.lang.Object
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 can delegate or 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
static java.lang.String _get_FILE_AUTHOR()
          For FileNet internal use only, do not call.
static java.lang.String _get_FILE_DATE()
          For FileNet internal use only, do not call.
static java.lang.String _get_FILE_REVISION()
          For FileNet internal use only, do not call.
 void doAbort()
          Unlocks a work item associated with this instance without updating the fields on the work item.
 void doDispatch()
          Saves changes made to the work object associated with this instance, unlocks the work object, and advances the work object in the workflow.
 void doLock(boolean overrideLock)
          Locks the work item associated with this step.
 void doReassign(java.lang.String participant, boolean delegateFlag, java.lang.String queueName)
          Changes the participant responsible for processing this step.
 void doReassignByDomain(java.lang.String theDomainName, java.lang.String participant, boolean delegateFlag, java.lang.String queueName)
          Changes the participant responsible for processing this step.
 void doRefresh(boolean lock, boolean overrideLock)
          Updates the information for the work item.
 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 instance.
static VWException[] doUnlockMany(VWStepElement[] stepElements, boolean save, boolean dispatch)
          Unlocks an array of step elements.
 VWProcess fetchProcess()
          Retrieves the workflow process containing this instance.
 VWStepProcessorInfo fetchStepProcessorInfo()
          Fetches the step processor information object that contains data that can used to open this instance.
 VWWorkObject fetchWorkObject(boolean lock, boolean overrideLock)
          Retrieves the work object associated with this instance.
 java.lang.String getAuthoredStepName()
          Gets the authored (untranslated) name of this step.
 java.lang.String getCallMap()
          Gets the name of the workflow map associated with this work object.
 boolean getCanReassign()
          Indicates whether the work item can be reassigned.
 boolean getCanReturnToSource()
          Indicates 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()
          Indicates whether this instance can be viewed through the tracker application.
 java.lang.String getComment()
          Gets the comment for this instance.
 java.lang.String getCurrentMapName()
          Gets the name of the map for this work item.
 java.lang.String getCurrentQueueName()
          Gets the name of the queue in which the work item resides.
 java.util.Date getDateReceived()
          Returns the date on which this instance was last saved.
 java.util.Date getDeadline()
          Gets the date value representing the date by which the step must be completed.
 java.lang.String getExceptionDescription()
          Gets the description of the workflow exception associated with this instance.
 java.lang.String getExceptionMap()
          Gets the name of the workflow map for the workflow exception associated with this instance.
 boolean getIsLaunchStep()
          Indicates whether the current work item is a launch step.
 boolean getIsTracker()
          Determines whether this instance is a tracker work item.
 java.util.Date getLaunchDate()
          Gets the date on which the workflow process associated with this instance was started.
 VWParticipant getLockedUserPx()
          Returns the security object (VWParticipant) representing the user who locked the current work object.
 java.lang.String getOperationName()
          Gets the name of the current operation on this work item.
 java.lang.String getOriginator()
          Returns the name of the user who initiated the workflow process containing this instance.
 VWParticipant getOriginatorPx()
          Returns the security object (VWParticipant) representing the user who initiated the workflow process containing this instance.
 int getOverdue()
          Gets status of the overdue notice.
 VWParameter getParameter(java.lang.String name)
          Gets the requested parameter from this step element.
 java.lang.String[] getParameterNames()
          Returns a list of system and user parameter names for this instance.
 VWParameter[] getParameters(int fieldTypeFlag, int fieldCreatorFlag)
          Returns the parameters used in this instance based on the specified parameter type (field type) and creator type.
 java.lang.Object getParameterValue(java.lang.String parameterName)
          Gets the value of a specified parameter for this instance.
 java.lang.String getParticipantName()
          Returns the short name of the participant who is processing this instance.
 VWParticipant getParticipantNamePx()
          Returns the security object (VWParticipant) representing the current participant.
 java.lang.String getQueueName()
          Gets the queue class name for this instance.
 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 this work item.
 java.lang.String getSelectedResponse()
          Gets the response selected by the user for this step.
 int getServerLocation()
          Gets the current server location of the work object.
 java.lang.String getSourceDoc()
          Returns the name of the source document for this instance.
 java.lang.String getStepDescription()
          Gets the description of this instance.
 java.lang.String getStepName()
          Gets the name of this step.
 java.lang.String[] getStepResponses()
          Gets a list of available responses for this instance.
 java.lang.String getSubject()
          Gets the subject of the workflow associated with this instance.
 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 this instance.
 java.lang.String getWorkflowNumber()
          Gets the workflow number associated with this instance.
 java.lang.String getWorkFlowNumber()
          Deprecated. Replaced by getWorkflowNumber() Gets the string version of the workflow number. Use the returned F_WorkFlowNumber as an index key component.
 java.lang.String getWorkObjectName()
          Gets the work item name.
 java.lang.String getWorkObjectNumber()
          Returns the work item number in string format.
 int getWorkOrderId()
          Returns the work order ID.
 int getWorkSpaceId()
          Gets the ID of the work space for this work item.
 boolean hasParameterName(java.lang.String parameterName)
          Indicates whether the specified parameter exists for this instance.
 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 instance.
 void setException(java.lang.String workflowMapName, java.lang.String description)
          Sets an exception condition for the workflow map associated with this instance.
 void setParameters(VWParameter[] parameters, boolean compareValues)
          Sets the values for specified parameters for this instance.
 void setParameterValue(java.lang.String parameterName, java.lang.Object parameterValue, boolean compareValue)
          Sets a value for a specified parameter in this instance.
 void setSelectedResponse(java.lang.String response)
          Specifies a selected response for this step.
 java.lang.String toString()
          Gets the string version of this work item name.
 void toXML(java.lang.StringBuffer theBuffer)
          Appends an XML string representing this instance to the buffer specified.
 
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.

See Also:
Constant Field Values

FIELD_SYSTEM_DEFINED

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

See Also:
Constant Field Values

FIELD_USER_AND_SYSTEM_DEFINED

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

See Also:
Constant Field Values
Method Detail

_get_FILE_DATE

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

Returns:
the file date

_get_FILE_AUTHOR

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

Returns:
the file author

_get_FILE_REVISION

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

Returns:
the file revision

doAbort

public void doAbort()
             throws VWException
Unlocks a work item associated with this instance without updating the fields on the work item.

Throws:
VWException - Thrown if the system cannot unlock the work item.

doDispatch

public void doDispatch()
                throws VWException
Saves changes made to the work object associated with this instance, unlocks the work object, and advances the work object in the workflow.

Throws:
VWException - Thrown when the work object is unlocked or invalid.

fetchWorkObject

public VWWorkObject fetchWorkObject(boolean lock,
                                    boolean overrideLock)
                             throws VWException
Retrieves the work object associated with this instance. If a translation source exists, the authored work object name is translated.

Parameters:
lock - A boolean value of true to unlock the work object; otherwise, false.
overrideLock - A boolean value of true to override the lock on the work object; otherwise, false.
Returns:
A VWWorkObject object representing the work object associated with this instance. If a translation source exists, the translated work object name is returned; otherwise, the authored name is returned.
Throws:
VWException - Thrown if the work object cannot be retrieved.

fetchProcess

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

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

getIsTracker

public boolean getIsTracker()
                     throws VWException
Determines whether this instance is a tracker work item.

Returns:
A boolean value of true if the work item associated with this instance is a tracker.
Throws:
VWException - Thrown if it cannot be determined whether this instance is a tracker work item.

getParameters

public VWParameter[] getParameters(int fieldTypeFlag,
                                   int fieldCreatorFlag)
                            throws VWException
Returns the parameters used in this instance based on the specified parameter type (field type) and creator type. The possible parameter types are defined in the VWFieldType fields.

Parameters:
fieldTypeFlag - An integer specifying the parameter type or types as defined in VWFieldType.

You can combine the flag types that will be returned by using a bitwise OR operation to set the value for this parameter.

fieldCreatorFlag - An integer specifying one of the following field creator types:
  • 1: User (FIELD_USER_DEFINED)
  • 2: System (FIELD_SYSTEM_DEFINED)
  • 3: User and System (FIELD_USER_AND_SYSTEM_DEFINED)
Returns:
An array of VWParameter objects representing the parameters for this step, or null if no parameters exist or cannot be found.
Throws:
VWException - Thrown if an error occurs while attempting to return the parameters.
See Also:
VWParameter

getParameter

public VWParameter getParameter(java.lang.String name)
                         throws VWException
Gets the requested parameter from this step element.

Parameters:
name - A String containing the name of the parameter.. If a translation source exists, the authored parameter name is translated.
Returns:
A VWParameter object for the parameter. If a translation source exists, the translated parameter name is returned; otherwise, the authored name is returned.
Throws:
VWException
Since:
P8 4.0

getComment

public java.lang.String getComment()
                            throws VWException
Gets the comment for this instance.

Returns:
A String containing the comment entered for this instance. Unless setComment() is called prior to calling this method, the string can contain a null value.
Throws:
VWException - Thrown if the comment cannot be found.

setComment

public void setComment(java.lang.String comment)
                throws VWException
Sets the comment for this instance.

Parameters:
comment - A String containing the comment for this instance.
Throws:
VWException - Thrown if the comment for this instance could not be set.

getDateReceived

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

Returns:
A Date value indicating the date on which the step was last saved.
Throws:
VWException - Thrown if the step is new (so a save operation has not yet occurred).

getExceptionDescription

public java.lang.String getExceptionDescription()
Gets the description of the workflow exception associated with this instance.

Returns:
A String containing the description of the defined workflow exception, or null if an exception condition is not set. This is an exception condition defined for the workflow application, not a Java exception.
See Also:
getException

getExceptionMap

public java.lang.String getExceptionMap()
Gets the name of the workflow map for the workflow exception associated with this instance. If a translation source exists, the authored map name is translated.

Returns:
A String containing the translated map name of the workflow exception that is thrown if a workflow error or exception occurs. If a translation source does not exist, the authored map name is returned. This is the map for an exception condition defined for the workflow application, not a Java exception.
See Also:
setException

setException

public void setException(java.lang.String workflowMapName,
                         java.lang.String description)
                  throws VWException
Sets an exception condition for the workflow map associated with this instance. The specified parameters define a workflow exception condition that can occur when the application saves, dispatches, or terminates a step. This is an exception specific to the workflow application, not a Java exception.

Note: The exception condition can occur only upon saving, dispatching, or terminating this step.

Parameters:
workflowMapName - A String containing the name of the workflow map for the specified exception, or null (the default) if no exception is to occur.
description - A String containing the description of the exception.
Throws:
VWException - Thrown if the exception condition cannot be set for the specified workflow map.

getLaunchDate

public java.util.Date getLaunchDate()
                             throws VWException
Gets the date on which the workflow process associated with this instance was started.

Returns:
A Date value representing the date on which the workflow process associated with the step began, or null if this cannot be determined.
Throws:
VWException - Thrown if the step is new (so a start date cannot yet be determined), or when a date format error occurs.

getOriginator

public java.lang.String getOriginator()
                               throws VWException
Returns the name of the user who initiated the workflow process containing this instance.

Returns:
A String containing the name of the user who started the workflow process containing this instance, or null if the user name cannot be found.
Throws:
VWException - Thrown if a problem occurs while attempting to retrieve the user name.

getOriginatorPx

public VWParticipant getOriginatorPx()
                              throws VWException
Returns the security object (VWParticipant) representing the user who initiated the workflow process containing this instance.

Returns:
The VWParticipant object for the user initiating the workflow process containing this instance, or null if the user name cannot be found.
Throws:
VWException - Thrown if a problem occurs while attempting to retrieve the VWParticipant object.

getParticipantName

public java.lang.String getParticipantName()
                                    throws VWException
Returns the short name of the participant who is processing this instance. If the participant name is a user queue, this is the name of the user of the work item associated with this step.

Returns:
A String containing the short name of the participant currently processing the step, or null if the name cannot be determined.
Throws:
VWException - Thrown if a problem occurs while attempting to retrieve the user name.

getParticipantNamePx

public VWParticipant getParticipantNamePx()
                                   throws VWException
Returns the security object (VWParticipant) representing the current participant.

Returns:
A VWParticipant object representing the current participant.
Throws:
VWException - Thrown if a problem occurs while attempting to retrieve the VWParticipant object.

getStepResponses

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

Returns:
A String array containing the available responses for this step. If a translation source exists, the translated responses are returned; otherwise, the authored responses are returned. If no responses exist, the method returns null.
Throws:
VWException - Thrown if the available responses cannot be retrieved.

getSelectedResponse

public java.lang.String getSelectedResponse()
                                     throws VWException
Gets the response selected by the user for this step. If a translation source exists, the authored response is translated.

Returns:
A String containing the translated response, if a translation source exists; otherwise the authored response is returned. If setSelectedResponse has not been called previously, the method returns null.
Throws:
VWException - Thrown if the selected response cannot be retrieved.
See Also:
setSelectedResponse

setSelectedResponse

public void setSelectedResponse(java.lang.String response)
                         throws VWException
Specifies a selected response for this step.

Parameters:
response - A String containing the response being selected for the step. If a translation source exists, the authored response is translated.
Throws:
VWException - Thrown if no responses are available.
See Also:
getSelectedResponse

doLock

public void doLock(boolean overrideLock)
            throws VWException
Locks the work item associated with this step.

Parameters:
overrideLock - A boolean value of true to override the lock; otherwise, specify false. This method cannot override a system lock.
Throws:
VWException - Thrown if the step is new. A new step has not yet been dispatched, so no work item is yet associated.

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 - Thrown if this step is new, or if the work item cannot be returned to the source queue. A new step has not yet been dispatched, so no work item is yet associated.

doRefresh

public void doRefresh(boolean lock,
                      boolean overrideLock)
               throws VWException
Updates the information for the work item.

Parameters:
lock - A boolean value of true to lock the work item; otherwise, specify false.
overrideLock - A boolean value of true to override any lock on the work item except a system lock; otherwise, specify false.
Throws:
VWException - Thrown if an updated version of the work item cannot be retrieved. Additionally, if a work object is removed from the current queue or retrieved from another queue since the last refresh, a (superfluous) exception is thrown. These changes are benign, and you should prevent the exception from affecting processing.

doReassign

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

Parameters:
participant - A String containing the name of the new participant being assigned to process the step.
delegateFlag - A boolean value of true to flag the reassignment for later review; otherwise, false.
queueName - A String containing one of the following:
  • The queue name to which the work item is to be moved.
  • Null. This indicates the current queue of this work item is a user-centric queue.
  • The literal "Inbox" if the current queue of this work item is not a user-centric queue.
Throws:
VWException - Thrown if the step is new. A new step has not yet been dispatched, and cannot be reassigned.

doReassignByDomain

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

Parameters:
theDomainName - A String containing the LDAP domain of the new participant being assigned to process the step.
participant - A String containing the name of the new participant being assigned to process the step.
delegateFlag - A boolean value of true to flag the reassignment for later review; otherwise, false.
queueName - A String containing one of the following:
  • The queue name to which the work item is to be moved.
  • Null. This indicates the current queue of this work item is a user-centric queue.
  • The literal "Inbox" if the current queue of this work item is not a user-centric queue.
Throws:
VWException - Thrown if the step is new. A new step has not yet been dispatched, and cannot be reassigned.

doSave

public void doSave(boolean unlock)
            throws VWException
Saves the work item associated with this instance.

Parameters:
unlock - A boolean value of true to save and unlock the work item, or false to maintain the current lock and save the work item.
Throws:
VWException - Thrown if an error occurs while attempting to save the work item, or if the current user does not have permission to unlock the work item (the work item was locked by another user).

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 (from the same VWQueueQuery or VWRosterQuery object).

Parameters:
stepElements - An array of VWStepElement object representing the step elements to unlock.
save - A boolean value of true to save data field values of the step elements; otherwise, specify false.
dispatch - A boolean value of true to dispatch the step elements. You must save step element data before dispatching the step. Specify false if you do not want to dispatch the step elements.
Returns:
An array VWException objects representing the step elements, or an array of null values if the step elements cannot be unlocked.
Throws:
VWException - Thrown if a step element in the array is null, or not from the same query source as the other step elements.

getWorkObjectNumber

public java.lang.String getWorkObjectNumber()
                                     throws VWException
Returns the work item number in string format. The returned value is useful to compare to a queue index key component containing F_WobNum.

Returns:
A String containing the work item number (corresponds to the F_WobNum queue field).
Throws:
VWException - Thrown when a new step element is referenced. It will not have a work object number until it is dispatched (becomes a work object).

getWorkObjectName

public java.lang.String getWorkObjectName()
                                   throws VWException
Gets the work item name. If a translation source exists, the authored work item name is translated.

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

getTag

public java.lang.String getTag()
                        throws VWException
Gets the work item tag. A work item name is normalized and saved as a tag in the database. Normalizing ensures correct sorting of work items.

Returns:
A String containing the tag of the work item.
Throws:
VWException - Thrown if the work item tag cannot be retrieved.

getWorkClassName

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

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

getQueueName

public java.lang.String getQueueName()
                              throws VWException
Gets the queue class name for this instance. If a translation source exists, the authored queue name is translated.

The queue name and the current queue name may not match if the work object was delegated or reassigned.

Returns:
A String containing the translated name of the queue class, if a translation source exists; otherwise the authored name is returned.
Throws:
VWException - Thrown if the name of the queue for this step cannot be retrieved.
See Also:
getCurrentQueueName()

getOperationName

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

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

getStepName

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

Returns:
A String containing the translated step name, if a translation source exists; otherwise, the authored name is returned. If a step having the specified name does not exist, null is returned.
Throws:
VWException - Thrown if this method cannot retrieve the step name.

getAuthoredStepName

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

Returns:
A String containing the authored step name, or null if the name does not exist.
Throws:
VWException - Thrown if this method cannot retrieve the step name.
Since:
P8 4.0

toString

public java.lang.String toString()
Gets the string version of this work item name.

Overrides:
toString in class java.lang.Object
Returns:
A String containing the name of the work item.

getDeadline

public java.util.Date getDeadline()
                           throws VWException
Gets the date value representing 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 - Thrown if the date value of the deadline cannot be retrieved.

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 - Thrown if the date value for the reminder cannot be retrieved.

getSubject

public java.lang.String getSubject()
                            throws VWException
Gets the subject of the workflow associated with this instance. If a translation source exists, the authored subject is translated.

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

getWorkflowName

public java.lang.String getWorkflowName()
                                 throws VWException
Gets the name of the workflow associated with this instance. If a translation source exists, the authored workflow name is translated.

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

setParameters

public void setParameters(VWParameter[] parameters,
                          boolean compareValues)
                   throws VWException
Sets the values for specified parameters for this instance. 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 specifying the parameter values. If a translation source exists, the authored parameter names are translated.
compareValues - A boolean value of true to set only changed values; false to set all values in a field to indicate that they have been modified.
Throws:
VWException - Thrown if any of the specified parameters values cannot be set. Some of the reasons that a parameter value could not be set 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 step.
  • One or more of the VWParameter objects is assigned VWModeType.MODE_TYPE_IN. This indicates the workflow author did not intend for the referenced parameter to change.

getRosterName

public java.lang.String getRosterName()
                               throws VWException
Gets the name of the roster associated with this work item. If a translation source exists, the authored roster name is translated.

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

getWorkFlowNumber

public java.lang.String getWorkFlowNumber()
                                   throws VWException
Deprecated. Replaced by getWorkflowNumber() Gets the string version of the workflow number. Use the returned F_WorkFlowNumber as an index key component.

Gets the workflow number. Use the returned F_WorkFlowNumber value 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 - Thrown if the string version of the workflow number cannot be retrieved.

getWorkflowNumber

public java.lang.String getWorkflowNumber()
                                   throws VWException
Gets the workflow number associated with this instance. Use the returned F_WorkFlowNumber value as an index key component.

Returns:
A String containing the workflow object number (corresponds to the F_WorkFlowNumber value); or null if the the workflow number does not exist.
Throws:
VWException - Thrown under the following conditions:
  • There is no workflow number currently assigned. This may be because the object has not yet been dispatched (has not yet become a work object).
  • The workflow number is null.

hasParameterName

public boolean hasParameterName(java.lang.String parameterName)
                         throws VWException
Indicates whether the specified parameter exists for this instance.

Parameters:
parameterName - A String containing the name of the parameter. If a translation source exists, the authored parameter name is translated.
Returns:
A boolean value of true if the specified parameter exists; otherwise, false.
Throws:
VWException - Thrown if the specified parameter name is null.

getStepDescription

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

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

getParameterNames

public java.lang.String[] getParameterNames()
Returns a list of system and user parameter names for this instance. If a translation source exists, the authored names are translated.

Returns:
A String array containing the system or user-defined parameter names. If a translation source exists, the translated parameter names are returned; otherwise, the authored parameter names are returned.

getParameterValue

public java.lang.Object getParameterValue(java.lang.String parameterName)
                                   throws VWException
Gets the value of a specified parameter for this instance. The value is returned in an object or an array of objects (Participant objects cannot be returned in an array). The supported object types are defined in the VWFieldType fields.

Parameters:
parameterName - A String containing the name of the parameter for the value to retrieve. The parameter can have a null value. If a translation source exists, the authored parameter name is translated.
Returns:
An Object instance or array of objects containing the value of the parameter specified in parameterName, or null if the specified parameter has a VWModeType.MODE_TYPE_OUT mode.
Throws:
VWException - Thrown if the parameter name specified cannot be found.

setParameterValue

public void setParameterValue(java.lang.String parameterName,
                              java.lang.Object parameterValue,
                              boolean compareValue)
                       throws VWException
Sets a value for a specified parameter in this instance. You can modify only those parameters with VWModeType.MODE_TYPE_OUT or VWModeType.MODE_TYPE_IN_OUT modes.

Parameters:
parameterName - A String containing the name of the parameter for which the value is being set. If a translation source exists, the authored parameter name is translated.
parameterValue - An Object containing the value being set in the specified parameter. The supported object types are defined in the VWFieldType fields.
compareValue - A boolean value of true to set only the changed values, or false to indicate that all values in a field are to be modified.
Throws:
VWException - Thrown under the following conditions:
  • Parameter cannot be found
  • Parameter cannot be modified because it is VWModeType.MODE_TYPE_IN
  • Parameter cannot be found because it is VWModeType.MODE_IN
  • Parameter type is undefined
  • Parameter value is null

getCanReassign

public boolean getCanReassign()
                       throws VWException
Indicates whether the work item can be reassigned.

Returns:
A boolean value of true if the work item associated with this step can be reassigned; otherwise, false.
Throws:
VWException - Thrown if it cannot be determined whether the work item can be reassigned.

getCanReturnToSource

public boolean getCanReturnToSource()
                             throws VWException
Indicates whether the work item can be returned to the queue from which the user delegated or reassigned it.

Returns:
A boolean value of true if the work item associated with this step can be returned to its original (source) queue; otherwise, false.
Throws:
VWException - Thrown if it cannot be determined whether the work item can be returned to the queue from which the user delegated or reassigned it.

getCanViewStatus

public boolean getCanViewStatus()
                         throws VWException
Indicates whether this instance can be viewed through the tracker application.

Returns:
A boolean value of true if the step can be viewed through the tracker; otherwise, false.
Throws:
VWException - Thrown if it cannot be determined 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 in which the work item resides. If a translation source exists, the authored queue name is translated.

Returns:
A String containing the translated name of the queue in which the work item currently resides, if a translation source exists; otherwise, the authored name is returned.
Throws:
VWException - Thrown if the name of the queue cannot be retrieved.

getOverdue

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

Returns:
An integer identifying the status, as follows:
  • 0: Not overdue
  • 1: Reminder date has arrived
  • 2: Deadline has arrived
Throws:
VWException - Thrown if the overdue status cannot be retrieved.

getWorkOrderId

public int getWorkOrderId()
                   throws VWException
Returns the work order ID. This may be null.

Returns:
An integer identifying the work order ID, or null if the ID is not found.
Throws:
VWException - Thrown if the work order ID cannot be retrieved.

getSourceDoc

public java.lang.String getSourceDoc()
                              throws VWException
Returns the name of the source document for this instance. This may be null.

Returns:
Name of the source document for this step, or null if the source document name is not found.
Throws:
VWException - Thrown if the name of the source document cannot be retrieved.

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML string representing this instance to the buffer specified.

Warning: This XML string is nonextensible, and cannot be modified in any way.

Specified by:
toXML in interface IVWtoXML
Parameters:
theBuffer - A StringBuffer that will be appended with the XML content.
Throws:
VWException - Thrown if the specified buffer is null.
See Also:
VWXMLUtil

getIsLaunchStep

public boolean getIsLaunchStep()
Indicates whether the current work item is a launch step.

Returns:
A boolean value of 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) can 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 - A String containing the name of the map to execute when the system dispatch is called.
Throws:
VWException - Thrown if the specified map cannot be set to be called.
See Also:
getCallMap

getCallMap

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

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

getWorkSpaceId

public int getWorkSpaceId()
                   throws VWException
Gets the ID of the work space for this work item.

Returns:
An integer identifying the work space ID.
Throws:
VWException - Thrown 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:
An integer identifying the work class ID.
Throws:
VWException - Thrown 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 of true if the step history can be viewed through the step processor; otherwise, false.
Throws:
VWException - Thrown if it cannot be determined 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 this work item. If a translation source exists, the authored map name is translated.

Returns:
A String containing the translated name of the current workflow map, if a translation source exists; otherwise, the authored name is returned.
Throws:
VWException - Thrown if the name of the map cannot be retrieved.
Since:
eP6.0

getLockedUserPx

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

Returns:
The VWParticipant object representing the user who locked this instance, or null if the work object is unlocked, or locked by the system.
Throws:
VWException - Thrown if the VWParticipant object cannot be retrieved.
Since:
BPM3.5

fetchStepProcessorInfo

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

Returns:
The VWStepProcessorInfo object for the step processor assigned to this step. If a translation source exists, the translated step processor information is returned; otherwise, the authored information is returned.
Throws:
VWException
Since:
VWWS3.10

getServerLocation

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

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

Process API

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