|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWWorkObject
public final class VWWorkObject
Use this class to access all data fields in a work object and fetch instruction element information associated with the work object.
Create an instance of this class with the following methods:
VWProcess.next()
VWRosterQuery.fetchWorkObjects(int)
VWQueueQuery.fetchWorkObjects(int)
VWQueueElement.fetchWorkObject(boolean,boolean)
VWRosterElement.fetchWorkObject(boolean,boolean)
VWInstructionElement.fetchWorkObject(boolean,boolean)
VWStepElement.fetchWorkObject(boolean,boolean)
Field Summary | |
---|---|
static int |
FIELD_SYSTEM_DEFINED
Value of 2. Indicates that the data field was created by the system. |
static int |
FIELD_USER_AND_SYSTEM_DEFINED
Value of 3. Indicates that the data field was created by the system but is being controlled by the user. |
static int |
FIELD_USER_DEFINED
Value of 1. Indicates that the data field was created by the user. |
Method Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
void |
doAbort()
Unlocks this work object without updating its fields. |
void |
doDelete(boolean overrideLock,
boolean force)
Delete this work object. |
static VWException[] |
doDeleteMany(VWWorkObject[] elements,
boolean overrideLock,
boolean force)
Deletes the specified work objects. |
void |
doDispatch()
Saves changes made in this work object, unlocks it, and moves the current step to the next workflow step. |
void |
doLock(boolean overrideLock)
Locks the work object. |
static VWException[] |
doLockMany(VWWorkObject[] wobjs,
boolean overrideLock)
Locks multiple work objects in a single call and refreshes them with current information. |
void |
doReassign(java.lang.String participant,
boolean delegateFlag,
java.lang.String queueName)
Delegates the current step assignment associated with this work object to another participant. |
void |
doReassignByDomain(java.lang.String theDomainName,
java.lang.String participant,
boolean delegateFlag,
java.lang.String queueName)
Changes the participant responsible for processing the current step. |
void |
doRefresh(boolean lock,
boolean overrideLock)
Retrieves an updated version of the work object to get recent data. |
void |
doReturnToSource()
Returns the work object to the queue from which it was originally reassigned or delegated. |
void |
doSave(boolean unlock)
Saves this work object. |
static VWException[] |
doSaveMany(VWWorkObject[] workObjects)
Saves information for an array of work objects. |
void |
doTerminate()
Terminate this work object. |
static VWException[] |
doTerminateMany(VWWorkObject[] elements)
Terminates the specified work objects. |
static VWException[] |
doUnlockMany(VWWorkObject[] workObjects,
boolean save,
boolean dispatch)
Unlocks an array of work objects. |
VWInstructionElement |
fetchInstructionElement(boolean lock,
boolean overrideLock)
Deprecated. Use fetchStepElement instead.
Fetches the instruction element information associated with
this work object. |
int |
fetchLockedStatus()
Retrieves the lock status of the work object. |
VWProcess |
fetchProcess()
Retrieves the workflow process containing this instance. |
VWReturnStackElement[] |
fetchReturnStackElements()
Retrieves work object return stack. |
VWStepElement |
fetchStepElement()
Fetches the current step in the workflow process. |
VWStepProcessorInfo |
fetchStepProcessorInfo()
Fetches the step processor information associated with this instance. |
java.lang.String[] |
getAuthoredFieldNames()
Retrieves the authored (untranslated) names of the data fields this work object supports. |
java.lang.String |
getAuthoredStepName()
Gets the authored (untranslated) step name for this work object. |
java.lang.String |
getCallMap()
Gets the name of the workflow map. |
java.lang.String |
getComment()
Returns the comment for this step. |
java.lang.String |
getCurrentQueueName()
Returns the name of the queue in which this work object resides. |
VWDataField |
getDataField(java.lang.String name)
Gets the requested data field from the log element. |
VWDataField[] |
getDataFields(int fieldTypeFlag,
int fieldCreatorFlag)
Returns a list of all data fields this work object supports. |
java.util.Date |
getDateReceived()
Returns the date on which the work object was last saved. |
java.util.Date |
getDeadline()
Retrieve the date by which the step should be completed. |
java.lang.String |
getExceptionDescription()
Gets the description of the Process Engine exception specified for this work object. |
java.lang.String |
getExceptionInstructionSheet()
Deprecated. Replaced by getExceptionMap |
java.lang.String |
getExceptionMap()
Returns the name of workflow map for the Process Engine exception specified in setException . |
java.lang.String[] |
getFieldNames()
Retrieves the names of the data fields this work object supports. |
java.lang.Object |
getFieldValue(java.lang.String fieldName)
Retrieves the value of a data field. |
java.lang.String |
getInstructionSheetName()
Returns the name of the instruction sheet containing the instruction this work object is currently processing. |
boolean |
getIsAltered()
Determines whether any data field has changed. |
boolean |
getIsTracker()
Determines whether this a tracker work object. |
java.lang.String |
getLastErrorNumber()
Returns the last error number of the return stack frame for this work object. |
java.lang.String |
getLastErrorText()
Returns the last error text of the return stack frame for this work object. |
java.util.Date |
getLaunchDate()
Returns the date on which the workflow process that contains this work object was launched. |
java.lang.String |
getLockedUser()
Returns the name of the user who locked the work object. |
VWParticipant |
getLockedUserPx()
Returns the VWParticipant (security) object that represents the user who locked the current work object. |
java.lang.String |
getOperationName()
Returns the name of the current operation on this work object. |
int |
getOperationType()
Returns the operation type of the current work order. |
java.lang.String |
getOriginator()
Returns the name of the user who initiated the workflow process that contains this work object. |
VWParticipant |
getOriginatorPx()
Returns the VWParticipant (security) object that represents the user who initiated the workflow process containing the current step. |
int |
getOverdue()
Returns the status of the overdue notice. |
java.lang.String |
getParticipantName()
Returns the short name of the participant who is processing this work object. |
VWParticipant |
getParticipantNamePx()
Returns a VWParticipant (security) object that represents the current participant. |
VWProcess |
getProcess()
Deprecated. Replaced by fetchProcess |
java.util.Date |
getReminder()
Returns the date on which a reminder is to be issued for the step. |
java.lang.String |
getRosterName()
Returns the name of the roster for this work object. |
java.lang.String |
getSelectedResponse()
Returns default response (the value in the F_Response system field) for this work object. |
int |
getServerLocation()
Gets the current server location of the work object. |
java.lang.String |
getStepDescription()
Gets the description of the step. |
java.lang.String |
getStepName()
Gets the step label (name) for this work object. |
java.lang.String[] |
getStepResponses()
Returns the list of available responses for this work object. |
java.lang.String |
getSubject()
Returns the subject of the workflow (the value in the F_Subject system field) associated with this work object. |
java.lang.String |
getTag()
Returns a String version of the work object tag. |
java.lang.String[] |
getTrackers()
Deprecated. Replaced by VWWorkObject.getTrackersPx(), which returns an array of VWParticipant objects for the tracker participants associated with this work object. |
VWParticipant[] |
getTrackersPx()
Returns an array of VWParticipant objects for the tracker participants associated with this work object. |
java.lang.String |
getWorkClassName()
Returns the name of the work class from which the application instantiates this work object. |
java.lang.String |
getWorkflowName()
Returns the name of the workflow associated with this step. |
java.lang.String |
getWorkflowNumber()
Gets the workflow number. |
java.lang.String |
getWorkFlowNumber()
Deprecated. Replaced by getWorkflowNumber() |
java.lang.String |
getWorkObjectName()
Returns the name of this work object. |
java.lang.String |
getWorkObjectNumber()
Returns a string version of the work object number. |
int |
getWorkOrderId()
Returns the work order ID associated with this work object; may be null. |
java.lang.String |
getWorkPerformerClassName()
Returns the name of the work performer class associated with the queue on which the work object resides. |
boolean |
hasBeenAltered(java.lang.String fieldName)
Indicates whether the specified field has changed in this work object. |
boolean |
hasFieldName(java.lang.String fieldName)
Indicates whether the specified data field exists in this work object. |
void |
lock(boolean overrideLock)
Deprecated. Replaced by doLock( boolean) |
static VWException[] |
lockMany(VWWorkObject[] wobjs,
boolean overrideLock)
Deprecated. Replaced by doLockMany(VWWorkObject[], boolean) |
void |
refresh(boolean lock,
boolean overrideLock)
Deprecated. Replaced by doRefresh(boolean, boolean) |
void |
save()
Deprecated. Replaced by doSave(boolean) |
static VWException[] |
saveMany(VWWorkObject[] workObjects)
Deprecated. Replaced by doSaveMany(VWWorkObject[]) |
void |
setCallMap(java.lang.String aMapName)
Specifies a map to be called when this work object is dispatched. |
void |
setDataFields(VWDataField[] dataFields,
boolean compareValues)
Changes the values for specified data fields. |
void |
setException(java.lang.String aInstructionSheetName,
java.lang.String aDescription)
Sets a Process Engine exception condition (not a Java exception) for this work object. |
void |
setFieldValue(java.lang.String fieldName,
java.lang.Object fieldValue)
Deprecated. Replaced by setFieldValue(String, Object, boolean) |
void |
setFieldValue(java.lang.String fieldName,
java.lang.Object fieldValue,
boolean compareValue)
Changes the value of a specified data field in this work object. |
void |
setSelectedResponse(java.lang.String response)
Changes the selected (default) response for this work object. |
void |
terminate()
Deprecated. Replaced by doTerminate() |
static VWException[] |
terminateMany(VWWorkObject[] elements)
Deprecated. Replaced by doTerminateMany( VWWorkObject[]) |
java.lang.String |
toString()
Retrieves the string version of the work object name. |
void |
unlock(boolean save,
boolean dispatch)
Deprecated. Replaced by doSave(boolean) |
static VWException[] |
unlockMany(VWWorkObject[] workObjects,
boolean save,
boolean dispatch)
Deprecated. Replaced by doUnlockMany(VWWorkObject[], boolean, boolean) |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int FIELD_USER_DEFINED
public static final int FIELD_SYSTEM_DEFINED
public static final int FIELD_USER_AND_SYSTEM_DEFINED
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public VWInstructionElement fetchInstructionElement(boolean lock, boolean overrideLock) throws VWException
fetchStepElement
instead.
Fetches the instruction element information associated with
this work object.
lock
- Specify true
to lock the work object;
specify false
to leave the work object in its existing state.overrideLock
- Specify true
to override
locks on the work object; specify false
to keep the lock in
place.
VWException
public void refresh(boolean lock, boolean overrideLock) throws VWException
doRefresh(boolean, boolean)
lock
- Specify true
to lock the work
object; specify false
to leave the work object in it existing
state.overrideLock
- Specify true
to override
locks on the work object; specify false
to keep the lock in
place.
VWException
- This method throws an exception when a there
is a change in the current queue contents since the last
refresh. Such a change occurs when a work object is removed
from the current queue or when a work object is fetched from
another queue, in the course of ordinary workflow activity.
The developer should take measures to prevent superfluous error
messages in such situations.public void doRefresh(boolean lock, boolean overrideLock) throws VWException
lock
- Specify true
to lock the work
object; specify false
to leave the work object in its existing
state.overrideLock
- Specify true
to override
locks on the work object; specify false
to keep the lock in place.
VWException
- This method throws an exception when a there
is a change in the current queue contents since the last
refresh. Such a change occurs when a work object is removed
from the current queue or when a work object is fetched from
another queue, in the course of ordinary workflow activity.
The developer should take measures to prevent superfluous error
messages in such situations.public static VWException[] unlockMany(VWWorkObject[] workObjects, boolean save, boolean dispatch) throws VWException
doUnlockMany(VWWorkObject[], boolean, boolean)
workObjects
- An array of work objects to unlock.save
- Specify true
to save the work
object data field values.dispatch
- Specify true
to dispatch the
work objects contained in the array. Work objects must be
saved before being dispatched.
VWException
- Thrown if the method cannot
unlock an array of work objects.public static VWException[] doUnlockMany(VWWorkObject[] workObjects, boolean save, boolean dispatch) throws VWException
workObjects
- An array of work objects to unlock.save
- Specify true
to save the work
object data field values.dispatch
- Specify true
to dispatch the
work objects contained in the array. Work objects must be
saved before being dispatched.
VWException
- Thrown if the method
cannot unlock an array of work objects.public static VWException[] saveMany(VWWorkObject[] workObjects) throws VWException
doSaveMany(VWWorkObject[])
workObjects
- An array of work objects to save.
VWException
- Thrown if the method
cannot save information for an array of work objects.public static VWException[] doSaveMany(VWWorkObject[] workObjects) throws VWException
workObjects
- An array of work objects to save.
VWException
- Thrown if the method cannot
save information for an array of work objects.public void unlock(boolean save, boolean dispatch) throws VWException
doSave(boolean)
save
- Specify true
to save the work
object data field values.dispatch
- Specify true
to dispatch the
work object. Work objects must be saved before being dispatched.
VWException
- Thrown if the
system encounters a problem while attempting to unlock a work
object. For example, this method throws an exception if someone
other than the current user locked the work object.public void setException(java.lang.String aInstructionSheetName, java.lang.String aDescription) throws VWException
Any errors for the specified parameter values are caught only when the application saves or unlocks the work object with dispatch set.
aInstructionSheetName
- A String containing the name of
the instruction sheet that is to be executed when the Process engine exception
is thrown. This defaults to null.
When specifying a value for this parameter, keep the following behavior in mind:
aDescription
- A String containing a description of the Process Engine
exception to be thrown.
VWException
- Thrown if exception condition cannot be set for this work object.getExceptionMap
,
getExceptionDescription
public java.lang.String getExceptionInstructionSheet()
getExceptionMap
setException(String, String)
public java.lang.String getExceptionDescription()
setException
public void save() throws VWException
doSave(boolean)
VWException
- Thrown if the
system encounters a problem while attempting to save the work
object; for example, this method throws an exception if someone
other than the current user locked the work object.public static VWException[] lockMany(VWWorkObject[] wobjs, boolean overrideLock) throws VWException
doLockMany(VWWorkObject[], boolean)
wobjs
- An array of work objects to lock.overrideLock
- Specify true
to override
locks. System locks cannot be overidden.
VWException
- Thrown if a
general system error of some kind occurs, such as a file permission
problem ir database malfunctioning.public static VWException[] doLockMany(VWWorkObject[] wobjs, boolean overrideLock) throws VWException
wobjs
- An array of work objects to lock.overrideLock
- Specify true
to override
locks. System locks cannot be overidden.
VWException
- Thrown if the method cannot
lock multiple work objects in a single call and refresh
them with current information.public void lock(boolean overrideLock) throws VWException
doLock( boolean)
overrideLock
- Specify true
to override
locks. System locks cannot be overridden.
VWException
- Thrown if the method cannot
lock the work object.public void doLock(boolean overrideLock) throws VWException
overrideLock
- Specify true
to override
locks. System locks cannot be overridden.
VWException
- Thrown if the method cannot
lock the work object.public static VWException[] terminateMany(VWWorkObject[] elements) throws VWException
doTerminateMany( VWWorkObject[])
elements
- An array of work objects to terminate.
VWException
- Thrown if the method
cannot terminate the specified work objects.public static VWException[] doTerminateMany(VWWorkObject[] elements) throws VWException
elements
- An array of work objects to terminate.
VWException
- Thrown if the method cannot
terminate the specified work objects.public void terminate() throws VWException
doTerminate()
VWException
- Thrown if the method cannot
terminate the current work object; for example, if someone
other than the caller locked the work object.public void doTerminate() throws VWException
VWException
- Thrown if the method cannot
terminate the current work object; for example, if someone
other than the caller locked the work object.public static VWException[] doDeleteMany(VWWorkObject[] elements, boolean overrideLock, boolean force) throws VWException
elements
- An array of work objects to delete.overrideLock
- Specify true
to delete the work objects regardless of
their locked state.force
- Specify true
to force the work objects to be deleted (use only
for corrupted work objects).
VWException
- Thrown if the method cannot
delete the specified work objects.public void doDelete(boolean overrideLock, boolean force) throws VWException
overrideLock
- Specify true
to delete the work object regardless of
the locked state.force
- Specify true
to force the work object to be deleted (use only
for corrupted work objects).
VWException
- Thrown if the method cannot
delete the current work object.public int fetchLockedStatus() throws VWException
VWException
- Thrown if the method cannot
retrieve the lock status of the work object; for example, if it cannot
execute a network call.VWQueueElement(for status definitions)
public java.lang.String[] getFieldNames()
public java.lang.String[] getAuthoredFieldNames()
public java.lang.Object getFieldValue(java.lang.String fieldName) throws VWException
fieldName
- The name of the data field. If a translation source exists, the
authored field name is translated.
VWException
- Thrown if the
name for the data field does not exist.public void setFieldValue(java.lang.String fieldName, java.lang.Object fieldValue) throws VWException
setFieldValue(String, Object, boolean)
fieldName
- The name of the data field.fieldValue
- An object containing the new value for the
data field.
VWException
- Thrown if the
system cannot find the data field specified in the fieldName
parameter.public void setFieldValue(java.lang.String fieldName, java.lang.Object fieldValue, boolean compareValue) throws VWException
fieldName
- A String containing the name of the data field. If a translation source exists, the
authored field name is translated.fieldValue
- An Object containing the new value for the data field.compareValue
- Specify true to set only the values modified; specify false if you want all
values in a field to indicate that they have been modified.
VWException
- Thrown if the data field specified cannot be found.public boolean hasFieldName(java.lang.String fieldName) throws VWException
fieldName
- A String containing the name of the data field to
check. If a translation source exists, the authored field name is translated.
VWException
- Thrown if the fieldName parameter is null.public boolean getIsAltered()
true
if any data
field values have changed; otherwise, this method returns
false
.public boolean hasBeenAltered(java.lang.String fieldName) throws VWException
fieldName
- A String containing the name of the field. If a translation source exists, the
authored field name is translated.
VWException
- Thrown for various causes, including when the
fieldName parameter is null.public java.lang.String getWorkObjectName() throws VWException
VWException
- Thrown if the work object name cannot be retrieved.public java.lang.String getWorkObjectNumber() throws VWException
VWException
- Thrown if the method cannot
retrieve a string version of the work object number.public java.lang.String getTag() throws VWException
If the F_Tag value is not set, "*" is returned. Refer to the Workflow Designer documentation for information about F_Tag and the use of "*".
VWException
- Thrown if a String version of the work object tag cannot be retrieved.public java.lang.String getWorkClassName() throws VWException
VWException
- Thrown if the name of the work class cannot be retrieved.public java.lang.String getWorkPerformerClassName() throws VWException
VWException
- Thrown if the work performer class name cannot be retrieved.public java.lang.String getOperationName() throws VWException
VWException
- Thrown if the name of the current operation on this work object cannot be
retrieved.public java.lang.String getStepName() throws VWException
VWException
- Thrown if the step label cannot be retrieved.public java.lang.String getAuthoredStepName() throws VWException
VWException
- Thrown if the step name cannot be found for this work object.public java.lang.String toString()
toString
in class java.lang.Object
public void doAbort() throws VWException
VWException
public void doDispatch() throws VWException
VWException
public VWProcess getProcess() throws VWException
fetchProcess
VWException
public VWProcess fetchProcess() throws VWException
The application can use the VWProcess object returned to fetch the VWAttachment parameters and the VWStepElement associated with this work object.
VWException
- Thrown if the workflow process cannot be retrieved.public VWStepElement fetchStepElement() throws VWException
VWException
- Thrown if the step element cannot be retrieved.public java.util.Date getDateReceived() throws VWException
VWException
public java.lang.String getExceptionMap()
setException
. If a
translation source exists, the authored map name is translated.
public VWDataField[] getDataFields(int fieldTypeFlag, int fieldCreatorFlag) throws VWException
fieldTypeflag
- An integer indicating which field types to return (see VWFieldType
.
You can combine field types using a bitwise OR operation.fieldCreatorFlag
- An integer corresponding to any of the
following literal values (use a bitwise OR to combine FIELD_USER_DEFINED and FIELD_SYSTEM_DEFINED):
VWException
public VWDataField getDataField(java.lang.String name) throws VWException
name
- A String containing the name of the data field. If a
translation source exists, the authored field name is translated.
VWException
public java.util.Date getLaunchDate() throws VWException
VWException
public java.lang.String getOriginator() throws VWException
VWException
public VWParticipant getOriginatorPx() throws VWException
null
, if no user name is found.
VWException
public java.lang.String getParticipantName() throws VWException
VWException
public VWParticipant getParticipantNamePx() throws VWException
VWException
public void doReassign(java.lang.String participant, boolean delegateFlag, java.lang.String queueName) throws VWException
participant
- The name of the
participant to whom you reassign this step.
delegateFlag
- Specify true
if you
delegate the assignment and plan to review the completed
assignment.
queueName
- The name of the queue to
which you wish to move the work object. If queueName is
null, the destination queue will default to the current queue
of the work item when the current queue is a user-centric queue.
When the current queue is not a user-centric queue, the
destination queue will default to "Inbox".
VWException
public void doReassignByDomain(java.lang.String theDomainName, java.lang.String participant, boolean delegateFlag, java.lang.String queueName) throws VWException
theDomainName
- The LDAP domain of the new participant being
assigned to process the step.participant
- The name of the new
participant being assigned to process the step.delegateFlag
- true
to
flag the reassignment for later review;
false
, otherwise.queueName
- The queue name to which
the work item is to be moved, or null
.
null
indicates the
current queue of this work item is a user-centric queue, or
"Inbox" if the current queue of this work item is not
a user-centric queue.
VWException
public void doReturnToSource() throws VWException
VWException
- Thrown if the
system encounters an error while attempting to move the work
object.public void doSave(boolean unlock) throws VWException
unlock
- Specify true
to unlock and save
the work object; otherwise, specify false
to maintain the
current lock and save the work object.
VWException
- Thrown for various causes, including when
this method throws an exception if someone
other than the current user locked the work object.public java.lang.String getWorkflowName() throws VWException
VWException
public java.lang.String getLockedUser() throws VWException
null
.
VWException
public VWParticipant getLockedUserPx() throws VWException
VWException
public void setDataFields(VWDataField[] dataFields, boolean compareValues) throws VWException
dataFields
- An array of VWDataField objects that contain
the values to be set in the data fields.compareValues
- Specify true
to set only
the values modified; otherwise, specify false
if you
want all values in a field to flag they are modified.
VWException
- Thrown if the
system cannot set a field specified in the dataFields parameter.public boolean getIsTracker() throws VWException
true
if the work object is a
tracker; otherwise, this method returns false
.
VWException
- Thrown if the
system encounters an error while attempting to the tracker flag.public java.lang.String getRosterName() throws VWException
VWException
- Thrown if an error occurs while attempting to retrieve the
roster name.public java.lang.String getWorkFlowNumber() throws VWException
getWorkflowNumber()
VWException
- Thrown if the method cannot
retrieve the string version of the workflow number, which
corresponds to the F_WorkFlowNumber.public java.lang.String getWorkflowNumber() throws VWException
null
.
null
means the F_WorkFlowNumber field does not exist.
VWException
public java.lang.String[] getTrackers() throws VWException
VWException
public VWParticipant[] getTrackersPx() throws VWException
VWException
public int getWorkOrderId() throws VWException
VWException
public java.util.Date getDeadline() throws VWException
VWException
- Thrown if the
system encounters an error while attempting to retrieve the
dead line date.public java.util.Date getReminder() throws VWException
VWException
- Thrown if the
system encounters an error while attempting to retrieve the
reminder date.public int getOverdue() throws VWException
VWException
public int getOperationType() throws VWException
VWException
public java.lang.String getCurrentQueueName() throws VWException
VWException
public VWStepProcessorInfo fetchStepProcessorInfo() throws VWException
VWException
public java.lang.String getComment() throws VWException
VWException
public java.lang.String getSubject() throws VWException
Note: The subject cannot be translated if it is changed at launch time.
VWException
- Thrown if an error occurs while attempting to retrieve the subject.public java.lang.String getInstructionSheetName() throws VWException
VWException
- Thrown if the name of the instruction sheet for this work object cannot be
found.public java.lang.String[] getStepResponses() throws VWException
VWException
- Thrown if the responses cannote be retrieved.public java.lang.String getSelectedResponse() throws VWException
setSelectedResponse
, null is returned.
VWException
public void setSelectedResponse(java.lang.String response) throws VWException
response
- A String containing the new selected response. If a translation source exists,
this response is translated; otherwise, the authored response is used.
VWException
- Thrown for various causes, including when
no responses are available.public java.lang.String getStepDescription() throws VWException
VWException
- Thrown if the step description cannot be retrieved.public void setCallMap(java.lang.String aMapName) throws VWException
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.
aMapName
- The name of the map to execute when this work object is dispatched.
VWException
- Thrown for various causes, including when
the aMapName parameter is null.getCallMap
public java.lang.String getCallMap()
setCallMap
public VWReturnStackElement[] fetchReturnStackElements() throws VWException
VWException
public java.lang.String getLastErrorNumber() throws VWException
VWException
public java.lang.String getLastErrorText() throws VWException
VWException
public int getServerLocation() throws VWException
VWException
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |