Index

DKWorkFlowNotificationFed

Purpose:

DKWorkFlowNotificationFed is an object-oriented representation of a notification in the workflow server. Hierarchy: DKWorkFlowNotificationFed

Class summary:

class DKWorkFlowNotificationFed 
{
   public:
     DKWorkFlowNotificationFed(DKWorkFlowServiceFed * service,
                             const char * workflo_name,
                             const char * name,
                             long type,
                             const char * owner_name);
     virtual ~DKWorkFlowNotificationFed();
 
     virtual DKString name();
     virtual DKString description();
     virtual long type();
     virtual long state();
     virtual DKString workFlowName();
     virtual long priority();
     virtual DKString owner();
     virtual DKTimestamp* notificationTime();
     virtual DKTimestamp* startTime();
     virtual DKTimestamp* creationTime();
     virtual DKTimestamp* modifiedTime();
     virtual DKTimestamp* receivedTime();
     virtual long receiveReason();
     virtual void retrieve();
     virtual void transfer(const char * user_id);
     virtual void cancel();
};

Members:

Constructors and destructor
The constructor constructs an DKWorkFlowNotificationFed with the specified workflow service with a workflow name, a node name, notification type, and a owner name. The destructor deletes the DKWorkFlowNotificationFed object.
 DKWorkFlowNotificationFed(DKWorkFlowServiceFed * service, const char * workflo_name, const char * name, long type, const char * owner_name);
     ~DKWorkFlowNotificationFed();
  

Member functions

name
Returns the notification name.
DKString name();  

description
Returns the description.
DKString description();        
 

type
Returns the type of the notification. A type can be one of the following:
DK_FED_FMC_IT_NOTSET 
DK_FED_FMC_IT_PROCESSINSTANCENOTIFICATION 
DK_FED_FMC_IT_FIRSTACTIVITYINSTANCENOTIFICATION 
DK_FED_FMC_IT_SECONDACTIVITYINSTANCENOTIFICATION 
     long type();

state
Returns the state of the notification. 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();       

priority
Returns the priority of the notification. However a process notification has no priority assigned.
 long priority();        

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

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

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

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

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

receivedTime
Returns the received time of the notification.
 DKTimestamp* receivedTime();     

receivedTime
Returns the received reason of the notification. The reason can be one of the following:
DK_FED_FMC_IR_NOTSET 
DK_FED_FMC_IR_NORMAL 
DK_FED_FMC_IR_SUBSTITUTE 
DK_FED_FMC_IR_PROCESSADMINISTRATOR 
DK_FED_FMC_IR_SYSTEMADMINISTRATOR 
DK_FED_FMC_IR_BYTRANSFER 
long receiveReason();      

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

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

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

cancel
Cancels the notification.
 void cancel();        

setAdminDomain
Sets domain that this ACL belongs to.
void setAdminDomain(DKAdminDomainDefFed* domain);

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.