|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.DKWorkFlowContainerFed
An object oriented representation of a container used in a workflow or a workitem.
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantFed |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdFed |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKWorkFlowContainerFed(dkWorkFlowServiceFed service,
DKHandle container_handle)
Constructs a DKWorkFlowContainer object that contains the data for a workflow or a workitem. |
Method Summary | |
java.lang.String |
getActionList()
Returns the action list. |
java.lang.String |
getActionPerformed()
Returns the action performed. |
java.lang.String |
getActivityName()
Returns the activity name. |
java.lang.String |
getActivityNode()
Returns the activity node. |
java.lang.String |
getPersistentID()
Gets the persistent ID. |
int |
getPriority()
Returns the priority. |
int |
getSemanticClassification()
Gets the semantic classification. |
java.lang.String |
getShowUserVariableDialog()
Gets the flag of ShowUserVariableDiaglog. |
java.lang.String |
getUserVariableName(int index)
Gets the user variable name that identified by an integer ranging from 0 to 4. |
java.lang.String |
getUserVariablePrompt(int index)
Gets the user variable prompt that identified by an integer ranging from 0 to 4. |
java.lang.String |
getUserVariableShowUser(int index)
Gets the user variable show user flag that identified by an integer ranging from 0 to 4. |
java.lang.String |
getUserVariableValue(int index)
Gets the user variable value that identified by an integer ranging from 0 to 4. |
DKHandle |
handle()
Returns a DKHandle object which references to the container object in the system. |
void |
retrieve()
Retrieves and refreshes the container data. |
void |
setActionList(java.lang.String action_list)
Sets the action list. |
void |
setActionPerformed(java.lang.String action_performed)
Sets the action performed. |
void |
setPersistentID(java.lang.String pid_string)
Sets the persistent ID. |
void |
setPriority(int priority)
Set the priority. |
void |
setSemanticClassification(int semantic_classification)
Sets the semantic_classification. |
void |
setShowUserVariableDialog(java.lang.String show_user_variable_dialog)
Sets the flag of ShowUserVariableDialog. |
void |
setUserVariableName(java.lang.String user_variable_name,
int index)
Sets the user variable name. |
void |
setUserVariablePrompt(java.lang.String user_variable_prompt,
int index)
Sets the user variable prompt. |
void |
setUserVariableValue(java.lang.String user_variable_value,
int index)
Sets the user variable value. |
void |
update()
Updates the container data. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKWorkFlowContainerFed(dkWorkFlowServiceFed service, DKHandle container_handle) throws DKException, java.lang.Exception
service
- DKWorkFlowSerivce object.container_handle
- DKhandle of a container handle.Method Detail |
public void setPriority(int priority) throws DKException, java.lang.Exception
priority
- a priority value.public void setActionList(java.lang.String action_list) throws DKException, java.lang.Exception
action_list
- name of an action list.public void setActionPerformed(java.lang.String action_performed) throws DKException, java.lang.Exception
action_performed
- name of the action performed.public void setUserVariablePrompt(java.lang.String user_variable_prompt, int index) throws DKException, java.lang.Exception
user_variable_prompt
- user variable prompt.index
- index to indicate a specific prompt.public void setUserVariableName(java.lang.String user_variable_name, int index) throws DKException, java.lang.Exception
user_variable_name
- user variable name.index
- index to indicate a specific name.public void setUserVariableValue(java.lang.String user_variable_value, int index) throws DKException, java.lang.Exception
user_variable_value
- user variable value.index
- index to indicate a specific value.public int getPriority() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowContainerFed object is not retrieved.public java.lang.String getActivityNode() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowContainerFed object is not retrieved.public java.lang.String getActivityName() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowContainerFed object is not retrieved.public java.lang.String getActionList() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowContainerFed object is not retrieved.public java.lang.String getActionPerformed() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowContainerFed object is not retrieved.public java.lang.String getUserVariablePrompt(int index) throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowContainerFed object is not retrieved.public java.lang.String getUserVariableName(int index) throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowContainerFed object is not retrieved.public java.lang.String getUserVariableValue(int index) throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowContainerFed object is not retrieved.public java.lang.String getUserVariableShowUser(int index) throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowContainerFed object is not retrieved.public java.lang.String getPersistentID() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowContainerFed object is not retrieved.public int getSemanticClassification() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowContainerFed object is not retrieved.public java.lang.String getShowUserVariableDialog() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowContainerFed object is not retrieved.public void setPersistentID(java.lang.String pid_string) throws DKException, java.lang.Exception
pid_string
- a persistent ID string.public void setSemanticClassification(int semantic_classification) throws DKException, java.lang.Exception
semantic_classification
- a semantic classification.public void setShowUserVariableDialog(java.lang.String show_user_variable_dialog) throws DKException, java.lang.Exception
show_user_variable_dialog
- a flag of ShowUserVariableDialog.public DKHandle handle() throws DKException, java.lang.Exception
public void retrieve() throws DKException, java.lang.Exception
The retrieve method is called after a DKWorkFlowContainerFed object is returned from either a DKWorkFlowFed object or a DKWorkItemFed object. The following code assumes WI is a retrieved DKWorkItemFed object. The retrieve method retireves the data of the container.
DKWorkFlowContainerFed con = WI.inContainer(); con.retrieve();
DKUsageError
- if the DKWorkFlowContainerFed object cannot be retrieved.public void update() throws DKException, java.lang.Exception
The retrieve method is called after a DKWorkFlowContainerFed object is returned from either a DKWorkFlowFed object or a DKWorkItemFed object. The following code assumes WI is a retrieved DKWorkItemFed object. The priority in the container is set to 200. The update method modifies the data of the container.
DKWorkFlowContainerFed con = WI.outContainer(); con.retrieve(); con.setPriority(200); con.update();
DKUsageError
- if the DKWorkFlowContainerFed object is not retrieved.
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |