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:
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.
Throws: DKException
void add();
Throws: DKException
void del();
Throws: DKException
void update();
Returns: code for this event type object
long getCode();
Parameters: eventTypeCode - event type code to be assigned to this event type
void setCode( long eventTypeCode );
Returns: name for the event type as a string variable
DKString getName();
Parameters: eventTypeName - event type name to be assigned to this event type object
void setName(const char* eventTypeName );
Returns: the description of this event type object
DKString getDescription();
Parameters: eventTypeDescription - event type description to be assigned to this event type object
void setDescription(const char* eventTypeDescription );
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);
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.