Index

DKWorkItemFed

Purpose:

DKWorkItemFed is an object oriented representation of a workitem in the system. A workitem indicates the current location (i.e., a node) in a workflow when the workitem is retrieved. Hierarchy: DKWorkItemFed

Class summary:

class DKWorkItemFed 
{
   public:
     DKWorkItemFed(DKWorkFlowServiceFed * service,
                        const char * workflow_name,
                        const char * workitem_name,
                        const char * owner_name);
     virtual ~DKWorkItemFed();
 
     virtual DKString name();
     virtual DKString description();
     virtual long state();
     virtual DKString workFlowName();
     virtual DKString workFlowTemplateName();
     virtual long priority();
     virtual DKString owner();
     virtual DKTimestamp* notificationTime();
     virtual DKTimestamp* startTime();
     virtual DKTimestamp* creationTime();
     virtual DKTimestamp* modifiedTime();
     virtual void retrieve();
     virtual void checkIn(DKWorkFlowContainerFed * container);
     virtual void checkOut();
     virtual void transfer(const char * user_id);
     virtual void cancel();
     virtual DKWorkFlowContainerFed* inContainer();
     virtual DKWorkFlowContainerFed* outContainer();
};

Members:

Constructors and destructor
The constructor constructs DKWorkItemFed with the specified workflow service with a workflow name, a workitem name, and a owner name.
DKWorkItemFed(DKWorkFlowServiceFed * service,
                        const char * workflow_name,
                        const char * workitem_name,
                        const char * owner_name);
     ~DKWorkItemFed();  

Member functions

name
Returns the node name.
 DKString name();  

description
Returns the node description.
DKString description();       
 

state
Returns the state of the workitem. The state can be in one of the following:
DK_FED_FMC_IS_NOTSET 
DK_FED_FMC_IS_READY 
DK_FED_FMC_IS_RUNNING 
DK_FED_FMC_IS_FINISHED 
DK_FED_FMC_IS_TERMINATED 
DK_FED_FMC_IS_SUSPENDED 
DK_FED_FMC_IS_DISABLED 
DK_FED_FMC_IS_CKECKEDOUT 
DK_FED_FMC_IS_INERROR 
DK_FED_FMC_IS_EXECUTED 
DK_FED_FMC_IS_PLANNING 
DK_FED_FMC_IS_FORCEFINISHED 
DK_FED_FMC_IS_DELETED 
DK_FED_FMC_IS_TERMINATING 
DK_FED_FMC_IS_SUSPENDING 
     long state();      

workFlowName
Returns the workflow name.
 DKString workFlowName();     

workFlowTemplateName
Returns the workflow template name of the workitem.
DKString workFlowTemplateName();                

priority
Returns the priority of the workitem.
long priority();                

owner
Returns the owner of the worktime.
DKString owner();                

notificationTime
Returns the notification time of the workitem.
DKTimestamp* notificationTime();
 

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

creationTime
Returns the creation time of the workitem.
DKTimestamp* creationTime();      

modifiedTime
Returns the last modified time of the workiteem.
DKTimestamp* modifiedTime();     
  

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

checkIn
Checks in the workitem and informs the workflow server that user processing has finished.
void checkIn(DKWorkFlowContainerFed * container);               

checkOut
Checks out a workitem for user processing and changes the state of workitem to DK_FED_FMC_IS_CHECKEDOUT.
void checkOut();
      

transfer
Transfers the workitem to the specified user ID.
void transfer(const char * user_id);     
  

cancel
Cancels the workitem. The state of the workitem will be DK_FED_FMC_IS_DELETED.
void cancel();   

inContainer
Returns an input container.
DKWorkFlowContainerFed* inContainer();               

outContainer
Returns an output container.
DKWorkFlowContainerFed* outContainer();      

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