Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKWorkFlowContainerFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKWorkFlowContainerFed
All Implemented Interfaces:
DKConstant, DKConstantFed, DKMessageId, DKMessageIdFed, java.io.Serializable

public class DKWorkFlowContainerFed
extends java.lang.Object
implements java.io.Serializable, DKConstantFed, DKMessageIdFed

An object oriented representation of a container used in a workflow or a workitem.

See Also:
Serialized Form

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

DKWorkFlowContainerFed

public DKWorkFlowContainerFed(dkWorkFlowServiceFed service,
                              DKHandle container_handle)
                       throws DKException,
                              java.lang.Exception
Constructs a DKWorkFlowContainer object that contains the data for a workflow or a workitem.
Parameters:
service - DKWorkFlowSerivce object.
container_handle - DKhandle of a container handle.
Method Detail

setPriority

public void setPriority(int priority)
                 throws DKException,
                        java.lang.Exception
Set the priority. The priority is an integer number ranging from 0 to 999.
Parameters:
priority - a priority value.

setActionList

public void setActionList(java.lang.String action_list)
                   throws DKException,
                          java.lang.Exception
Sets the action list.
Parameters:
action_list - name of an action list.

setActionPerformed

public void setActionPerformed(java.lang.String action_performed)
                        throws DKException,
                               java.lang.Exception
Sets the action performed.
Parameters:
action_performed - name of the action performed.

setUserVariablePrompt

public void setUserVariablePrompt(java.lang.String user_variable_prompt,
                                  int index)
                           throws DKException,
                                  java.lang.Exception
Sets the user variable prompt. You are allowed to specify up to 5 prompts. The index is used to indicate a specific prompt that is identified by an integer ranging from 0 to 4.
Parameters:
user_variable_prompt - user variable prompt.
index - index to indicate a specific prompt.

setUserVariableName

public void setUserVariableName(java.lang.String user_variable_name,
                                int index)
                         throws DKException,
                                java.lang.Exception
Sets the user variable name. You are allowed to specify up to 5 names. The index is used to indicate a specific name that is identified by an integer ranging from 0 to 4.
Parameters:
user_variable_name - user variable name.
index - index to indicate a specific name.

setUserVariableValue

public void setUserVariableValue(java.lang.String user_variable_value,
                                 int index)
                          throws DKException,
                                 java.lang.Exception
Sets the user variable value. You are allowed to specify up to 5 values. The index is used to indicate a specific value that is identified by an integer ranging from 0 to 4.
Parameters:
user_variable_value - user variable value.
index - index to indicate a specific value.

getPriority

public int getPriority()
                throws DKException,
                       java.lang.Exception
Returns the priority.
Returns:
a priority.
Throws:
DKUsageError - if the DKWorkFlowContainerFed object is not retrieved.

getActivityNode

public java.lang.String getActivityNode()
                                 throws DKException,
                                        java.lang.Exception
Returns the activity node.
Returns:
name of the activity node.
Throws:
DKUsageError - if the DKWorkFlowContainerFed object is not retrieved.

getActivityName

public java.lang.String getActivityName()
                                 throws DKException,
                                        java.lang.Exception
Returns the activity name.
Returns:
name of the activity.
Throws:
DKUsageError - if the DKWorkFlowContainerFed object is not retrieved.

getActionList

public java.lang.String getActionList()
                               throws DKException,
                                      java.lang.Exception
Returns the action list.
Returns:
name of the action list.
Throws:
DKUsageError - if the DKWorkFlowContainerFed object is not retrieved.

getActionPerformed

public java.lang.String getActionPerformed()
                                    throws DKException,
                                           java.lang.Exception
Returns the action performed.
Returns:
name of the action performed.
Throws:
DKUsageError - if the DKWorkFlowContainerFed object is not retrieved.

getUserVariablePrompt

public java.lang.String getUserVariablePrompt(int index)
                                       throws DKException,
                                              java.lang.Exception
Gets the user variable prompt that identified by an integer ranging from 0 to 4.
Returns:
a user variable prompt.
Throws:
DKUsageError - if the DKWorkFlowContainerFed object is not retrieved.

getUserVariableName

public java.lang.String getUserVariableName(int index)
                                     throws DKException,
                                            java.lang.Exception
Gets the user variable name that identified by an integer ranging from 0 to 4.
Returns:
a user variable name.
Throws:
DKUsageError - if the DKWorkFlowContainerFed object is not retrieved.

getUserVariableValue

public java.lang.String getUserVariableValue(int index)
                                      throws DKException,
                                             java.lang.Exception
Gets the user variable value that identified by an integer ranging from 0 to 4.
Returns:
a user variable value.
Throws:
DKUsageError - if the DKWorkFlowContainerFed object is not retrieved.

getUserVariableShowUser

public java.lang.String getUserVariableShowUser(int index)
                                         throws DKException,
                                                java.lang.Exception
Gets the user variable show user flag that identified by an integer ranging from 0 to 4.
Returns:
a user variable show user flag.
Throws:
DKUsageError - if the DKWorkFlowContainerFed object is not retrieved.

getPersistentID

public java.lang.String getPersistentID()
                                 throws DKException,
                                        java.lang.Exception
Gets the persistent ID.
Returns:
a persistent ID.
Throws:
DKUsageError - if the DKWorkFlowContainerFed object is not retrieved.

getSemanticClassification

public int getSemanticClassification()
                              throws DKException,
                                     java.lang.Exception
Gets the semantic classification.
Returns:
a semantic classification.
Throws:
DKUsageError - if the DKWorkFlowContainerFed object is not retrieved.

getShowUserVariableDialog

public java.lang.String getShowUserVariableDialog()
                                           throws DKException,
                                                  java.lang.Exception
Gets the flag of ShowUserVariableDiaglog.
Returns:
the flag of ShowUserVariableDiaglog.
Throws:
DKUsageError - if the DKWorkFlowContainerFed object is not retrieved.

setPersistentID

public void setPersistentID(java.lang.String pid_string)
                     throws DKException,
                            java.lang.Exception
Sets the persistent ID.
Parameters:
pid_string - a persistent ID string.

setSemanticClassification

public void setSemanticClassification(int semantic_classification)
                               throws DKException,
                                      java.lang.Exception
Sets the semantic_classification.
Parameters:
semantic_classification - a semantic classification.

setShowUserVariableDialog

public void setShowUserVariableDialog(java.lang.String show_user_variable_dialog)
                               throws DKException,
                                      java.lang.Exception
Sets the flag of ShowUserVariableDialog.
Parameters:
show_user_variable_dialog - a flag of ShowUserVariableDialog.

handle

public DKHandle handle()
                throws DKException,
                       java.lang.Exception
Returns a DKHandle object which references to the container object in the system.
Returns:
a DKHandle object.

retrieve

public void retrieve()
              throws DKException,
                     java.lang.Exception
Retrieves and refreshes the container data.

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();
 
Throws:
DKUsageError - if the DKWorkFlowContainerFed object cannot be retrieved.

update

public void update()
            throws DKException,
                   java.lang.Exception
Updates the container data.

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();
 
Throws:
DKUsageError - if the DKWorkFlowContainerFed object is not retrieved.

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.