Index

DKLinkTypeDefICM

Purpose:

This class defines methods to manage link type information. Link type indicates the type of relationship among items. The valid values are contain, DKFolder and any user-defined link types defined by the system administrator.

Since: Version 8

Class summary:

 class DKEXPORT DKLinkTypeDefICM
 {
   public:
     DKLinkTypeDefICM(dkDatastore* ds);
     DKLinkTypeDefICM(const DKLinkTypeDefICM& lnk);
     virtual ~DKLinkTypeDefICM();
     long add();
     void del();
     void update();
     long getCode();
     void setCode(long linkTypeCode);
     DKString getName();
     void setName(const char* linkTypeName);
     DKString getDescription();
     void setDescription(const char* linkTypeDescript );
     DKString getDescription(const char* langCode);
     void setDescription(const char* desc, const char* langCode);
   };
 

Members:

Constructors and destructor
DKLinkTypeDefICM(dkDatastore* ds);

Constructs an instance of link type definition class for a given ICM datastore. Parameters: ds - datastore object as an instance of Datastore ICM.

DKLinkTypeDefICM(const DKLinkTypeDefICM& lnk);

A copy constructor for link type definition for ICM datastore. Parameters: eventObj - an event type definition object.

virtual ~DKLinkTypeDefICM();

Destructor for this object.

Member functions

add
Adds the definition of this link type both to the persistent store and memory. When a link type is added, the ICM datastore will automatically provide a default description for this link type in all the languages defined in the datastore. This default description string for languages other than the default language is the same description for the default language with an asterisk pre pended. The description for other languages can be updated using the addNLSKeywordDesc method. Throws: DKException - if error occurs.
long add();

del
Deletes the definition of the link type from both the persistent store and memory. Throws: DKException - if error occurs.
void del();

update
Updates the definition of this link type both in the persistent store and in the memory. Throws: DKException - if error occurs.
void update();

getCode
Gets the datastore assigned numeric indentifier of the link type. Returns: The integer identifier assigned to this link by the datastore.
long  getCode(); 

setCode
Sets the link type code to a datastore assigned value. Parameters: linkTypeCode - link type code of this link type.
void setCode(long linkTypeCode);

getName
Gets the name of the link type. This name is independent of the langauges defined in the ICM datastore. Returns: name of the link type.
DKString getName();

setName
Sets the link type's name to a specified name. Parameters: linkTypeName - link type name to be assigned to this link type. This string can be up to 32 characters long.
void setName(const char* linkTypeName); 

getDescription
Gets the description of the link type. This description is language dependent and the default language description is returned. To get the description in other languages use getDescription( const char* langCode). Returns: Default language description of the link type

DKString getDescription();

setDescription
Sets the link type's description to a specified description. This is the description for the default language of the ICM datastore. To set the description for other languages use setDescription(const char* desc, const char* langCode);. Parameters: linkTypeDescript - link type description to be assigned to this link type for the default language of the ICM datastore. The description string can be up to 254 characaters long.
void setDescription(const char* linkTypeDescript); 

getDescription
Gets the link type description for the specified language. Parameters: langCode - link type language code. e.g. ENU, DEU Returns: link type description for the specified language.
DKString getDescription();

setDescription
Sets the link type description to a given description for the specified language. Parameters:
  • desc - link type description.
  • langCode - link type language code e.g. ENU, DEU

void setDescription(const char* linkTypeDescript); 

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