|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--filenet.vw.api.VWFieldsObject | +--filenet.vw.api.VWWorkElement | +--filenet.vw.api.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 may delegate/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 | |
void |
doAbort()
Unlocks a work item associated with this step without updating the fields on the work item. |
void |
doDispatch()
Saves changes made to the work object associated with this step element, unlocks the work object, and moves the current step to the next workflow step. |
void |
doLock(boolean overrideLock)
Locks the work item associated with this step element. |
void |
doReassign(java.lang.String participant,
boolean delegateFlag,
java.lang.String queueName)
Changes the participant responsible for processing the current step. |
void |
doRefresh(boolean lock,
boolean overrideLock)
Fetches an updated version of the instruction to get the latest information. |
void |
doReturnToSource()
Returns the work item to the queue from which a user originally reassigned or delegated the work item. |
void |
doSave(boolean unlock)
Saves the work item associated with this step element. |
static VWException[] |
doUnlockMany(VWStepElement[] stepElements,
boolean save,
boolean dispatch)
Unlocks an array of step elements. |
VWProcess |
fetchProcess()
Retrieves the workflow process that contains this step element object. |
VWWorkObject |
fetchWorkObject(boolean lock,
boolean overrideLock)
Fetches the work item associated with this step element. |
java.lang.String |
getCallMap()
Gets the name of the workflow map you set using the setCallMap method. |
boolean |
getCanReassign()
Determines whether the work item can be reassigned. |
boolean |
getCanReturnToSource()
Determines whether the work item can be returned to the queue from which the user delegated or reassigned it. |
boolean |
getCanViewHistory()
Determines whether this step element's history can be viewed through the step processor. |
boolean |
getCanViewStatus()
Determines whether this step element can be viewed through the tracker application. |
java.lang.String |
getComment()
Gets the comment for this step. |
java.lang.String |
getCurrentMapName()
Gets the name of the map for the step. |
java.lang.String |
getCurrentQueueName()
Gets the name of the queue on which the work item resides. |
java.util.Date |
getDateReceived()
Gets the date on which the user received this step. |
java.util.Date |
getDeadline()
Gets the date value that represents the date by which the step must be completed. |
java.lang.String |
getExceptionDescription()
Gets the value the workflow author set for description of the workflow exception. |
java.lang.String |
getExceptionMap()
Gets the name of the workflow exception that corresponds to the workflow map. |
boolean |
getIsLaunchStep()
Determines whether the current work item is a launch step. |
boolean |
getIsTracker()
Determines whether the current work item is a tracker work item. |
java.util.Date |
getLaunchDate()
Gets the date on which the workflow process associated with this step started. |
java.lang.String |
getOperationName()
Gets the name of the current operation on the work item. |
java.lang.String |
getOriginator()
Gets the name of the user who initiated the workflow process containing this step. |
int |
getOverdue()
Gets status of the overdue notice. |
java.lang.String[] |
getParameterNames()
Lists system and user step element parameter names. |
VWParameter[] |
getParameters(int fieldTypeFlag,
int fieldCreatorFlag)
Gets the system or user (or both) parameters in this step, given their specific types. |
java.lang.Object |
getParameterValue(java.lang.String parameterName)
Gets the value of a specified parameter. |
java.lang.String |
getParticipantName()
Gets the name of the participant who is processing the current step. |
java.lang.String |
getQueueName()
Gets the name of the queue this step element associated with the current operation. |
java.util.Date |
getReminder()
Gets the date on which the application issues a reminder for this step. |
java.lang.String |
getRosterName()
Gets the name of the roster associated with the work item. |
java.lang.String |
getSelectedResponse()
Gets the response selected by the user for the current step. |
int |
getServerLocation()
Gets the current server location of the work object. |
java.lang.String |
getStepDescription()
Gets the description of a step. |
java.lang.String |
getStepName()
Gets the String step name. |
java.lang.String[] |
getStepResponses()
Gets a list of available responses for the current step. |
java.lang.String |
getSubject()
Gets the subject of the workflow associated with the current step. |
java.lang.String |
getTag()
Gets the work item tag. |
int |
getWorkClassId()
Gets the ID of the work class for this work item. |
java.lang.String |
getWorkClassName()
Gets the name of the work class from which the application instantiates the work item. |
java.lang.String |
getWorkflowName()
Gets the name of the workflow associated with the current step. |
java.lang.String |
getWorkflowNumber()
Gets the string version of the workflow number. |
java.lang.String |
getWorkFlowNumber()
Deprecated. Replaced by getWorkflowNumber() |
java.lang.String |
getWorkObjectName()
Gets the work item name. |
java.lang.String |
getWorkObjectNumber()
Gets the work item number, in string format. |
int |
getWorkSpaceId()
Gets the ID of the work space for this work item. |
boolean |
hasParameterName(java.lang.String parameterName)
Determines whether a specific parameter exists. |
void |
setCallMap(java.lang.String aMapName)
Specifies a map to be called when the system dispatches this work object. |
void |
setComment(java.lang.String comment)
Sets the comment for this step. |
void |
setException(java.lang.String workflowMapName,
java.lang.String description)
Sets an exception condition for the work item that corresponds to the workflow map associated with this step element. |
void |
setParameters(VWParameter[] parameters,
boolean compareValues)
Sets the values for specified parameters in an array. |
void |
setParameterValue(java.lang.String parameterName,
java.lang.Object parameterValue,
boolean compareValue)
Sets a value for a specified parameter. |
void |
setSelectedResponse(java.lang.String response)
Sets a selected response for this step. |
java.lang.String |
toString()
Gets the string version of the work item name. |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string that represents this VWStepElement object to the buffer specified by the input parameter. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
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 void doAbort() throws VWException
VWException
- The method throws an exception if the
system cannot unlock the work item.public void doDispatch() throws VWException
VWException
- Thrown if the
system encounters an error while attempting to save the
current step or move the step to the next workflow step.public VWWorkObject fetchWorkObject(boolean lock, boolean overrideLock) throws VWException
lock
- A boolean value. Specify true to lock the work item;
otherwise, specify false.overrideLock
- A boolean value. Specify true to override
the lock on the work item.VWException
- The method throws an exception if the system cannot
fetch the work item.public VWProcess fetchProcess() throws VWException
VWException
- Thrown if the
system cannot fetch the workflow process.public boolean getIsTracker() throws VWException
VWException
- The method throws an exception if it cannot
determine whether the current work item is a tracker work item.public VWParameter[] getParameters(int fieldTypeFlag, int fieldCreatorFlag) throws VWException
fieldTypeflag
- An integer value specifying the parameter
type.
You can logically OR or AND the VWFieldType values to enter a value for this parameter.
fieldCreatorFlag
- An integer value specifying the field
type (user, system, or both).
Valid values are as follows:
You can logically OR or AND these values.
VWException
- The method throws an exception if an error while
the system attempts to return the parameters.VWParameter
public java.lang.String getComment() throws VWException
VWException
- The method throws an exception if it cannot
get the comment for this step.public void setComment(java.lang.String comment) throws VWException
comment
- A String containing the new comment for this step.VWException
- This method returns an exception if it cannot
set the comment for this step.public java.util.Date getDateReceived() throws VWException
VWException
- The method throws an exception if it cannot
get the date on which the user received this step.public java.lang.String getExceptionDescription()
setException(java.lang.String, java.lang.String)
public java.lang.String getExceptionMap()
public void setException(java.lang.String workflowMapName, java.lang.String description) throws VWException
The system catches a parameter value error only upon saving, dispatching, or terminating this step element.
workflowMapName
- A String containing the name of the
workflow map the Process workflow executes when the system raises
the exception:
description
- A String containing the description of the
exception to be raised.VWException
- The method throws an exception if it cannot
set an exception condition for the work item that corresponds
to the workflow map associated with this step element.public java.util.Date getLaunchDate() throws VWException
VWException
- The method throws an exception if it cannot
get the date on which the workflow process associated with
this step started.public java.lang.String getOriginator() throws VWException
VWException
- The method throws an exception if it cannot
retrieve the name of the originator
of the workflow process.public java.lang.String getParticipantName() throws VWException
VWException
- The method throws an exception if it cannot
retrieve the name of the
participant currently processing the step.public java.lang.String[] getStepResponses() throws VWException
VWException
- The method throws an exception if it cannot
retrieve the available responses for the current step.public java.lang.String getSelectedResponse() throws VWException
VWException
- The method throws an exception if it cannot
retrieve the selected response.public void setSelectedResponse(java.lang.String response) throws VWException
response
- The response being
selected for the step.VWException
- The method throws an exception if it
cannot set the selected response.public void doLock(boolean overrideLock) throws VWException
overrideLock
- A boolean value. Specify true to override
the lock; otherwise, specify false. This method cannot
override a system lock.VWException
- The method throws an exception if a problem occurs
while the system attempts to lock the work item.public void doReturnToSource() throws VWException
VWException
- The method throws an exception if a
problem occurs while the system attempts to return the work
item to the source queue.public void doRefresh(boolean lock, boolean overrideLock) throws VWException
lock
- A boolean value. Specify true to lock the work ite
m; otherwise, specify false.overrideLock
- A boolean value. Specify true to override
any lock on the work item except a system lock; otherwise,
specify false.VWException
- The method throws an exception if it cannot
fetch an updated version of the instruction to get the
latest information.
A benign change in the current queue contents since the last refresh results in an exception being thrown when this API is invoked. Such a change occurs when a work object is removed from the current queue or fetched from another queue in the course of ordinary workflow activity. The developer is responsible for preventing superfluous error messages in such situations.
public void doReassign(java.lang.String participant, boolean delegateFlag, java.lang.String queueName) throws VWException
participant
- The name of the new
participant being assigned to process the step.delegateFlag
- A boolean value. Specify true if you
delegate the assignment and plan to review the completed
assignment; otherwise specify false.queueName
- The queue name to which
the work item is to be moved.
If the queueName parameter value is null the queueName will default to the current queue of the work item when the current queue is a user-centric queue. When the current queue is not a user-centric queue, the queueName will default to "Inbox".
VWException
- The method throws an exception if the
system cannot reassign this step to the other participant.public void doSave(boolean unlock) throws VWException
unlock
- A boolean value. Specify true to save and unlock
the work item; specify false to maintain the current lock and
save the work item.VWException
- The method throws an exception if an
error occurs while the system attempts to save the work item,
or if someone other than you locked the work item.public static VWException[] doUnlockMany(VWStepElement[] stepElements, boolean save, boolean dispatch) throws VWException
workObjects
- An array of VWStepElement object that
represent the step elements to unlock.
save
- A boolean value. Specify true to save data field
values of the step elements; otherwise, specify false.
dispatch
- A boolean value. Specify true to dispatch the
step elements. You must save step element data before
dispatching the step.VWException
- The method throws an exception if it cannot
unlock an array of step elements.public java.lang.String getWorkObjectNumber() throws VWException
VWException
- public java.lang.String getWorkObjectName() throws VWException
VWException
- The method throws an exception if it cannot
get the work item name.public java.lang.String getTag() throws VWException
VWException
- The method throws an exception if it cannot
get the work item tag.public java.lang.String getWorkClassName() throws VWException
VWException
- The method throws an exception if it cannot
get the name of the work class from which the application
instantiates the work item.public java.lang.String getQueueName() throws VWException
VWException
- The method throws an exception if it cannot
get the name of the queue this step element associated with the
current operation.getCurrentQueueName()
public java.lang.String getOperationName() throws VWException
VWException
- The method throws an exception if it cannot
get the name of the current operation on the work item.public java.lang.String getStepName() throws VWException
getStepName
in class filenet.vw.api.VWFieldsObject
VWException
- Thrown if this method cannot
get the string step name from an existing step name field.public java.lang.String toString()
toString
in class java.lang.Object
public java.util.Date getDeadline() throws VWException
VWException
- The method throws an exception if the
system cannot retrieve the date value of the deadline.public java.util.Date getReminder() throws VWException
VWException
- The method throws an exception if the
system cannot retrieve date value for the reminder.public java.lang.String getSubject() throws VWException
VWException
- The method throws an exception if it cannot
get the subject of the workflow associated with the current step.public java.lang.String getWorkflowName() throws VWException
VWException
- The method throws an exception if it cannot
get the name of the workflow associated with the current step.public void setParameters(VWParameter[] parameters, boolean compareValues) throws VWException
parameters
- An array of VWParameter objects containing
the new values for the given array of parameters.compareValues
- A boolean value. Specify true to set
only changed values; otherwise, specify false to set all
values in a field to flag that they are modified.VWException
- The method throws an exception if the
system cannot set any one of the specified parameters values.
Some examples of conditions in the parameters
array that cause this method to throw exceptions are:
public java.lang.String getRosterName() throws VWException
VWException
- The method throws an exception if an
error occurs while the system attempts to retrieve the roster
name.public java.lang.String getWorkFlowNumber() throws VWException
getWorkflowNumber()
getWorkFlowNumber
in class filenet.vw.api.VWFieldsObject
VWException
- The method throws an exception if it cannot
get the string version of the workflow number.public java.lang.String getWorkflowNumber() throws VWException
VWException
- The method throws an exception if it cannot
get the string version of the workflow number.public boolean hasParameterName(java.lang.String parameterName) throws VWException
parameterName
- The name of the
parameter to check.VWException
- The method throws an exception if the
parameter name specified in the parameterName parameter is null.public java.lang.String getStepDescription() throws VWException
VWException
- The method throws an exception if the
system cannot retrieve the description for the step.public java.lang.String[] getParameterNames()
public java.lang.Object getParameterValue(java.lang.String parameterName) throws VWException
A parameter can have a null value.
parameterName
- The name of the
parameter for which to retrieve the value.VWException
- The method throws an exception if the
system does not find the parameter specified in the
parameterName parameter.public void setParameterValue(java.lang.String parameterName, java.lang.Object parameterValue, boolean compareValue) throws VWException
parameterName
- The name of the
parameter for which the value is being set.
parameterValue
- An object containing the value of being
set in the specified parameter.
compareValue
- A boolean value. Specify true to set only
the changed values. Specify false if you want all values in a
field to flag they are modified.VWException
- The method throws an exception if the
field name specified in the parameterName parameter does not
exist. public boolean getCanReassign() throws VWException
VWException
- The method throws an exception if it cannot
determine whether the work item can be reassigned.public boolean getCanReturnToSource() throws VWException
VWException
- The method throws an exception if it cannot
determine whether the work item can be returned to the queue from which
the user delegated or reassigned it.public boolean getCanViewStatus() throws VWException
VWException
- The method throws an exception if it cannot
determine whether this step element can be viewed through
the tracker application.public java.lang.String getCurrentQueueName() throws VWException
VWException
- The method throws an exception if it cannot
get the name of the queue on which the work item resides.public int getOverdue() throws VWException
VWException
- The method throws an exception if the
system cannot retrieve the overdue status.public void toXML(java.lang.StringBuffer theBuffer) throws VWException
toXML
in interface IVWtoXML
theBuffer
- A string buffer that this method will append with
XML content.VWException
- 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
- The name of
the map to execute when the system dispatch is called.VWException
- Thrown if it
cannot set a map to be called
when the system dispatches this work object.public java.lang.String getCallMap()
mapName
- Name of the map to call.public int getWorkSpaceId() throws VWException
VWException
- if a problem occurs retrieving
the work space id.public int getWorkClassId() throws VWException
VWException
- if a problem occurs retrieving
the work class id.public boolean getCanViewHistory() throws VWException
VWException
- The method throws an exception if it cannot
determine whether this step element history can be viewed through
the step processor.public java.lang.String getCurrentMapName() throws VWException
VWException
- The method throws an exception if it cannot
get the name of the map for the step.public int getServerLocation() throws VWException
VWException
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |