Index

DKEventTypeDefICM

Purpose:

The DKEventTypeDefICM class represents an event type definition in Content Manager. It provides methods needed to access and update event type information.

Since: Version 8

Class summary:

class DKEXPORT DKEventTypeDefICM  
{
 public:
                        DKEventTypeDefICM(dkDatastore* ds);
                        DKEventTypeDefICM(const DKEventTypeDefICM&  eventObj);
                        ~DKEventTypeDefICM();
        void            add();
        void            del();
        void            update();
        long            getCode();
        void            setCode( long eventTypeCode );
        DKString        getName();
        void            setName(const char* eventTypeName );
        DKString        getDescription();
        void            setDescription(const char* eventTypeDescription ); 
        DKString       getDescription(const char* langCode);
        void           setDescription(const char* desc, const char* langCode);   
 };

Members:

Constructors and destructor
DKEventTypeDefICM(dkDatastore* ds);

Constructs an instance of event type definition class for a given ICM datastore.

Parameters:ds - datastore object as an instance of Datastore ICM Copy Constructor

DKEventTypeDefICM(const DKEventTypeDefICM& eventObj)

A copy constructor for event type definition for ICM datastore.

Parameters:eventObj - an event type definition object Destructor

virtual ~DKEventTypeDefICM()

Destructor for this object.

Member functions

add
Adds the definition of this event type to the persistent store.

Throws: DKException

void add();

del
Deletes the definition of this event type from the persistent store.

Throws: DKException

void del();

update
Updates the definition of this event type from the persistent store.

Throws: DKException

void update();

getCode
Retrieves the code offor this event type object.

Returns: code for this event type object

long getCode();

setCode
Sets the code for this event type object to the specified value.

Parameters: eventTypeCode - event type code to be assigned to this event type

void setCode( long eventTypeCode );

getName
Retrieves the name for this event type object.

Returns: name for the event type as a string variable

DKString getName();

setName
Sets the name for this event type object to the specified value.

Parameters: eventTypeName - event type name to be assigned to this event type object

void setName(const char* eventTypeName );

getDescription
Retrieves the description for this event type.

Returns: the description of this event type object

DKString getDescription();

setDescription
Sets the description of this event type object to the specified value.

Parameters: eventTypeDescription - event type description to be assigned to this event type object

void setDescription(const char* eventTypeDescription );

getDescription
GetsRetrieves the description of theis event type for the specifieda given language code.

Parameters: langCode - language code for which the description is to be retrieved. A sample value for the language code is "ENU" for US English.

Returns: the description of theis event type for thea specified language code.

DKString getDescription(const char* langCode);

setDescription
Sets the description of theis event type object for the specified language code to the specified value .

Parameters: desc - description to be assigned to this event type object.langCode - language code for which the description is to be set. A sample value for the language code is "ENU" for US English

void setDescription(const char* desc, const char* langCode);

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