Index

DKEventMgmtICM

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:

createEventType
Creates a new event type definition.

Returns:new event type definition object as an instance of DKEventTypeDefICM

DKEventTypeDefICM*      createEventType();

getEventType
Retrieves the definition of the event type object for the given name from the in-memory event type definition list.

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);

listEventTypes
List EventType Type from the persistent store.

Returns:the collection of event type objects in the persistent store as instances of DKEventTypeDefICM.

dkCollection*           listEventTypes();

listEventTypeNames
Retrieves an array of event type names from the persistent store.

Returns:an array Sring of event type names as string variables from the persistent store

Throws:DKException

DKString* listEventTypeNames(long& arraySize);

retrieveEventType
Retrieves an instance of the event type object corresponding to the specified event type name from the persistent store.

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);

add
Adds the specified event type object to the persistent store.

Parameters:eventTypeObj - event type object to be added to the persistent store

Throws:DKException

void add(DKEventTypeDefICM* eventTypeObj);

del
Deletes the specified event type object from the persistent store.

Parameters:eventTypeObj - the event type object to be deleted

Throws:DKException

void del(DKEventTypeDefICM* eventTypeObj);

update
Updates the given event type definition corresponding to the specified object in the persistent store.

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.