Purpose:
The DKEventMgmtICM class provides event management functionality in Content Manager. It contains all the book keeping methods for dealing with events including methods for adding, deleting, updating, retrieving and listing event types to and from the persistent store.
See Also: DKEventTypeDefICM, DKEventDefICM
Since: Version 8
Class summary:
class DKEXPORT DKEventMgmtICM { public: DKEventMgmtICM(dkDatastore* ds); ~DKEventMgmtICM(); DKEventTypeDefICM* createEventType(); DKEventTypeDefICM* getEventType(const char* eventTypeName); dkCollection* listEventTypes(); DKString* listEventTypeNames(long& arraySize); DKEventTypeDefICM* retrieveEventType(const char* eventTypeName); void add(DKEventTypeDefICM* eventTypeObj); void del(DKEventTypeDefICM* eventTypeObj); void update(DKEventTypeDefICM* eventTypeObj); };
Members:
Returns:new event type definition object as an instance of DKEventTypeDefICM
DKEventTypeDefICM* createEventType();
Parameters:EventTypeName - name of the event type object to be retrieved
Returns:The event type definition object for the specified name
Throws:DKException - if the event type doesnot exist in the datastore
DKEventTypeDefICM* getEventType(const char* eventTypeName);
Returns:the collection of event type objects in the persistent store as instances of DKEventTypeDefICM.
dkCollection* listEventTypes();
Returns:an array Sring of event type names as string variables from the persistent store
Throws:DKException
DKString* listEventTypeNames(long& arraySize);
Parameters:eventTypeName - name of the event type object to be retrieved
Returns:the event type object corresponding to the specified name as an instance of DKEventTypeDefICM
Throws:DKException - if the event type does not exist in the datastore
DKEventTypeDefICM* retrieveEventType(const char* eventTypeName);
Parameters:eventTypeObj - event type object to be added to the persistent store
Throws:DKException
void add(DKEventTypeDefICM* eventTypeObj);
Parameters:eventTypeObj - the event type object to be deleted
Throws:DKException
void del(DKEventTypeDefICM* eventTypeObj);
Parameters:EventTypeObj - the event type object whose definition is to be updated
Throws:DKException
void update(DKEventTypeDefICM* eventTypeObj);
(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.