Index

DKWorkFlowFed

Purpose:

DKWorkFlowFed is an object oriented representation of the workflow in the workflow engine. Hierarchy: DKWorkFlowFed

Class summary:

class DKWorkFlowFed
{
   public:
     DKWorkFlowFed(DKWorkFlowServiceFed * service);
     DKWorkFlowFed(DKWorkFlowServiceFed * service,
                                  const char * name);
     virtual ~DKWorkFlowFed();
          
     virtual DKString getName();
     virtual void setName(const char * name);
     virtual DKString getDescription();
     virtual void setDescription(const char * description);
     virtual DKString workFlowTemplateName();
     virtual DKTimestamp* notificationTime();
     virtual DKTimestamp* modifiedTime();
     virtual DKTimestamp* stateChangeTime();
     virtual DKTimestamp* startTime();
     virtual DKTimestamp* endTime();
     virtual DKTimestamp* suspensionTime();
     virtual long state();    
     virtual DKWorkFlowContainerFed* inContainer();
     virtual void start(DKWorkFlowContainerFed* container);
     virtual void terminate();
     virtual void suspend(DKTimestamp* suspension_time);
     virtual void suspendDeep(DKTimestamp* suspension_time);
     virtual void resume();
     virtual void resumeDeep();
     virtual void add(const char *  workflow_template); 
     virtual void update();
     virtual void del();
     virtual void retrieve(); 
};  

Members:

Constructors and destructor
The first constructor constructs a DKWorkFlowFed object with the specified workflow service. The second constructor constructs a DKWorkFlowFed object with the specified workflow service and a workflow name. The destructor deletes the DKWorkFlowFed object.
DKWorkFlowFed(DKWorkFlowServiceFed * service);
     DKWorkFlowFed(DKWorkFlowServiceFed * service,
                   const char * name);
     ~DKWorkFlowFed();          
 

Member functions

getName
Returns the name the workflow.
DKString getName();  

setName
Sets the name of the workflow.
void setName(const char * name);        
 

getDescription
Returns the description of the workflow.
DKString getDescription();     

setDescription
Sets the description of the workflow.
void setDescription(const char * description);             

workFlowTemplateName
Returns the name of the workflow template that is associated with the workflow.
DKString workFlowTemplateName();       

notificationTime
Returns the notification time.
virtual DKTimestamp* notificationTime();    

modifiedTime
Returns the last modification time of the workflow.
virtual DKTimestamp* modifiedTime();     

stateChangeTime
Returns the state change time of the workflow.
DKTimestamp* stateChangeTime();                

startTime
Returns the start time of the workflow.
DKTimestamp* startTime();

endTime
Returns the end time of the workflow.
DKTimestamp* endTime();     

suspensionTime
Returns the suspension time of the workflow.
DKTimestamp* suspensionTime();     

state
Returns the state of the workflow. The state can be in one of the following:
 DK_FED_FMC_PS_NOTSET 
DK_FED_FMC_PS_READY 
DK_FED_FMC_PS_RUNNING 
DK_FED_FMC_PS_FINISHED 
DK_FED_FMC_PS_TERMINATED 
DK_FED_FMC_PS_SUSPENDED 
DK_FED_FMC_PS_TERMINATING 
DK_FED_FMC_PS_SUSPENDING 
DK_FED_FMC_PS_DELETED 
     long state();

inContainer
Returns the input container associated with the workflow.
DKWorkFlowContainerFed* inContainer();    

start
Starts the workflow with an input container.
 void start(DKWorkFlowContainerFed* container);

terminate
Terminates the workflow.
void terminate();         

suspend
Suspends the workflow with a specified time. A NULL DKTimestamp means to suspend the workflow indefinitely.
void suspend(DKTimestamp* suspension_time);        

suspendDeep
Suspends the workflow and its sub-workflows with a specified time. A NULL DKTimestamp means to suspend the workflow indefinitely.
void suspendDeep(DKTimestamp* suspension_time);        

resume
Resuems the suspended workflow.
void resume();              

resumeDeep
Resuems the suspended workflow and its sub-workflows.
void resumeDeep();           

add
Adds a workflow in the system. A workflow is created with the speficied workflow template.
void add(const char *  workflow_template); 

update
Updates the workflow.
void update(); 

del
Deletes the workflow.
void del();

retrieve
Retrieves and refreshes the information of the workflow.
  void retrieve();

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