|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWStepElement
public final class VWStepElement
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.
VWQueueElement
,
VWQueueQuery
,
VWWorkObject
,
Serialized FormField 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 |
---|
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 void doAbort() throws VWException
VWException
- Thrown if the system cannot unlock the work item.public void doDispatch() throws VWException
VWException
- Thrown when the work object is unlocked or invalid.public VWWorkObject fetchWorkObject(boolean lock, boolean overrideLock) throws VWException
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.
VWException
- Thrown if the work object cannot be retrieved.public VWProcess fetchProcess() throws VWException
VWException
- Thrown if the workflow process cannot be retrieved.public boolean getIsTracker() throws VWException
VWException
- Thrown if it cannot be determined whether this instance is a tracker work item.public VWParameter[] getParameters(int fieldTypeFlag, int fieldCreatorFlag) throws VWException
VWFieldType
fields.
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:
VWException
- Thrown if an error occurs while attempting to return the parameters.VWParameter
public VWParameter getParameter(java.lang.String name) throws VWException
name
- A String containing the name of the parameter.. If a translation source
exists, the authored parameter name is translated.
VWException
public java.lang.String getComment() throws VWException
VWException
- Thrown if the comment cannot be found.public void setComment(java.lang.String comment) throws VWException
comment
- A String containing the comment for this instance.
VWException
- Thrown if the comment for this instance could not be set.public java.util.Date getDateReceived() throws VWException
VWException
- Thrown if the step is new (so a save operation has not yet occurred).public java.lang.String getExceptionDescription()
getException
public java.lang.String getExceptionMap()
setException
public void setException(java.lang.String workflowMapName, java.lang.String description) throws VWException
Note: The exception condition can occur only upon saving, dispatching, or terminating this step.
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.
VWException
- Thrown if the exception condition cannot be set for the specified workflow map.public java.util.Date getLaunchDate() throws VWException
VWException
- Thrown if the step is new (so a start date cannot yet be determined), or when a date format
error occurs.public java.lang.String getOriginator() throws VWException
VWException
- Thrown if a problem occurs while attempting to retrieve the user name.public VWParticipant getOriginatorPx() throws VWException
VWException
- Thrown if a problem occurs while attempting to retrieve the VWParticipant object.public java.lang.String getParticipantName() throws VWException
VWException
- Thrown if a problem occurs while attempting to retrieve the user name.public VWParticipant getParticipantNamePx() throws VWException
VWException
- Thrown if a problem occurs while attempting to retrieve the VWParticipant object.public java.lang.String[] getStepResponses() throws VWException
VWException
- Thrown if the available responses cannot be retrieved.public java.lang.String getSelectedResponse() throws VWException
VWException
- Thrown if the selected response cannot be retrieved.setSelectedResponse
public void setSelectedResponse(java.lang.String response) throws VWException
response
- A String containing the response being selected for the step.
If a translation source exists, the authored response is translated.
VWException
- Thrown if no responses are available.getSelectedResponse
public void doLock(boolean overrideLock) throws VWException
overrideLock
- A boolean value of true to override the lock; otherwise, specify false. This method cannot
override a system lock.
VWException
- Thrown if the step is new. A new step has not yet been dispatched, so no work item
is yet associated.public void doReturnToSource() throws VWException
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.public void doRefresh(boolean lock, boolean overrideLock) throws VWException
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.
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.public void doReassign(java.lang.String participant, boolean delegateFlag, java.lang.String queueName) throws VWException
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:
VWException
- Thrown if the step is new. A new step has not yet been dispatched, and cannot be reassigned.public void doReassignByDomain(java.lang.String theDomainName, java.lang.String participant, boolean delegateFlag, java.lang.String queueName) throws VWException
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:
VWException
- Thrown if the step is new. A new step has not yet been dispatched, and cannot be reassigned.public void doSave(boolean unlock) throws VWException
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.
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).public static VWException[] doUnlockMany(VWStepElement[] stepElements, boolean save, boolean dispatch) throws VWException
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.
VWException
- Thrown if a step element in the array is null, or not from the same query source as the
other step elements.public java.lang.String getWorkObjectNumber() throws VWException
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).public java.lang.String getWorkObjectName() throws VWException
VWException
- Thrown if the work item name cannot be retrieved.public java.lang.String getTag() throws VWException
VWException
- Thrown if the work item 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 getQueueName() throws VWException
The queue name and the current queue name may not match if the work object was delegated or reassigned.
VWException
- Thrown if the name of the queue for this step cannot be retrieved.getCurrentQueueName()
public java.lang.String getOperationName() throws VWException
VWException
- Thrown if the name of the current operation cannot be retrieved.public java.lang.String getStepName() throws VWException
VWException
- Thrown if this method cannot retrieve the step name.public java.lang.String getAuthoredStepName() throws VWException
VWException
- Thrown if this method cannot retrieve the step name.public java.lang.String toString()
toString
in class java.lang.Object
public java.util.Date getDeadline() throws VWException
VWException
- Thrown if the date value of the deadline cannot be retrieved.public java.util.Date getReminder() throws VWException
VWException
- Thrown if the date value for the reminder cannot be retrieved.public java.lang.String getSubject() throws VWException
VWException
- Thrown if the subject of the workflow cannot be retrieved.public java.lang.String getWorkflowName() throws VWException
VWException
- Thrown if name of the workflow cannot be retrieved.public void setParameters(VWParameter[] parameters, boolean compareValues) throws VWException
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.
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:
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()
Gets the string version of the workflow number. Use the
returned F_WorkFlowNumber as an index key component.
VWException
- Thrown if the string version of the workflow number cannot be retrieved.public java.lang.String getWorkflowNumber() throws VWException
VWException
- Thrown under the following conditions:
public boolean hasParameterName(java.lang.String parameterName) throws VWException
parameterName
- A String containing the name of the parameter. If a translation source
exists, the authored parameter name is translated.
VWException
- Thrown if the specified parameter name is null.public java.lang.String getStepDescription() throws VWException
VWException
- Thrown if the step description cannot be retrieved.public java.lang.String[] getParameterNames()
public java.lang.Object getParameterValue(java.lang.String parameterName) throws VWException
VWFieldType
fields.
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.
VWException
- Thrown if the parameter name specified cannot be found.public void setParameterValue(java.lang.String parameterName, java.lang.Object parameterValue, boolean compareValue) throws VWException
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.
VWException
- Thrown under the following conditions:
public boolean getCanReassign() throws VWException
VWException
- Thrown if it cannot be determined whether the work item can be reassigned.public boolean getCanReturnToSource() throws VWException
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.public boolean getCanViewStatus() throws VWException
VWException
- Thrown if it cannot be determined whether this step element can be viewed through
the tracker application.public java.lang.String getCurrentQueueName() throws VWException
VWException
- Thrown if the name of the queue cannot be retrieved.public int getOverdue() throws VWException
VWException
- Thrown if the overdue status cannot be retrieved.public int getWorkOrderId() throws VWException
VWException
- Thrown if the work order ID cannot be retrieved.public java.lang.String getSourceDoc() throws VWException
VWException
- Thrown if the name of the source document cannot be retrieved.public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
toXML
in interface IVWtoXML
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public boolean getIsLaunchStep()
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
- A String containing the name of the map to execute when the system dispatch is called.
VWException
- Thrown if the specified map cannot be set to be called.getCallMap
public java.lang.String getCallMap()
setCallMap
public int getWorkSpaceId() throws VWException
VWException
- Thrown if a problem occurs retrieving the work space ID.public int getWorkClassId() throws VWException
VWException
- Thrown if a problem occurs retrieving the work class ID.public boolean getCanViewHistory() throws VWException
VWException
- Thrown if it cannot be determined whether this step element history can be viewed through
the step processor.public java.lang.String getCurrentMapName() throws VWException
VWException
- Thrown if the name of the map cannot be retrieved.public VWParticipant getLockedUserPx() throws VWException
VWException
- Thrown if the VWParticipant object cannot be retrieved.public VWStepProcessorInfo fetchStepProcessorInfo() 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 |