Index

DKWorkFlowContainerFed

Purpose:

DKWorkFlowContainerFed is an object oriented representation of a container used in a workflow or a workitem. Hierarchy:

DKWorkFlowContainerFed 

Class summary:

class DKWorkFlowContainerFed 
{
   public:
     DKWorkFlowContainerFed(DKWorkFlowServiceFed* service, DKHandle* container_handle);
     ~DKWorkFlowContainerFed();
     void setPriority(int priority);
     void setActionList(const char * action_list);
     void setActionPerformed(const char * action_performed);
     void setUserVariablePrompt(const char * user_variable_prompt, int index);
     void setUserVariableName(const char * user_variable_name, int index);
     void setUserVariableValue(const char * user_variable_value, int index);
     void setPersistentID(const char * pid_string);
     void setSemanticClassification(int semantic_classification);
     void setShowUserVariableDialog(const char * show_user_variable_dialog);
     int getPriority();
     DKString getActivityNode();
     DKString getActivityName();
     DKString getActivityDescription();
     DKString getActionList();
     DKString getActionPerformed();
     DKString getUserVariablePrompt(int index);
     DKString getUserVariableName(int index);
     DKString getUserVariableValue(int index);
     DKString getUserVariableShowUser(int index);
     DKString getPersistentID();
     int getSemanticClassification();
     DKString getShowUserVariableDialog();
     DKHandle* handle();
     void retrieve();
     void update();
};

Members:

Constructors and destructor
The constructor constructs a DKWorkFlowContainerFed object that contains the data for a workflow or a workitem. The destructor deletes the DKWorkFlowContainerFed object.
 DKWorkFlowContainerFed(DKWorkFlowServiceFed* service, DKHandle* container_handle); ~DKWorkFlowContainerFed();  

Member functions

setPriority
Set the priority.
void setPriority(int priority);   

setActionList
Sets the action list.
void setActionList(const char * action_list);        
 

setActionPerformed
Sets the action performed.
void setActionPerformed(const char * action_performed);

setUserVariablePrompt
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.
void setUserVariablePrompt(const char * user_variable_prompt, int index);             

setUserVariableName
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.
void setUserVariableName(const char * user_variable_name, int index);        

setUserVariableValue
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.
void setUserVariableValue(const char * user_variable_value, int index);        

setPersistentID
Sets Persistent ID.
void setPersistentID(const char * pid_string);

setSemanticClassification
Sets Semantic Classification.
void setSemanticClassification(int semantic_classification);        

setShowUserVariableDialog
Sets the flag of ShowUserVariableDialog.
void setShowUserVariableDialog(const char* show_user_variable_dialog);

getPriority
Returns the priority.
int getPriority();

getActivityNode
Returns the activity node.
DKString getActivityNode();       

getActivityName
Returns the activity name.
 DKString getActivityName();

getActivityDescription
Returns the activity description.
DKString getActivityDescription();     

getActionList
Returns the action list.
DKString getActionList();

getActionPerformed
Returns the action performed.
DKString getActionPerformed();         

getUserVariablePrompt
Gets the user variable prompt that identified by an integer ranging from 0 to 4.
DKString getUserVariablePrompt(int index);        

DKString getUserVariableName
Gets the user variable name that identified by an integer ranging from 0 to 4.
DKString getUserVariableName(int index);        

getUserVariableValue
Gets the user variable value that identified by an integer ranging from 0 to 4.
DKString getUserVariableValue(int index);              

getUserVariableShowUser
Gets the user variable show user flag that identified by an integer ranging from 0 to 4.
DKString getUserVariableShowUser(int index);

getPersistentID
Gets the persistent ID.
DKString getPersistentID(); 

getSemanticClassification
Gets the semantic classification.
int getSemanticClassification();

getShowUserVariableDialog
Gets the flag of ShowUserVariableDiaglog.
DKString getShowUserVariableDialog();

handle
Returns a DKHandle object which references to the container object in the system.
DKHandle* handle();

retrieve
Retrieves and refreshes the container data.
void retrieve();

update
Updates the container data.
void update();         

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