Index

DKSemanticTypeDefICM

Purpose:

The semantic type of an item describes its basic classification. It can be used to indicate the kind of real-world object the item is, such as folder, document, resource, memo, picture etc. In essence, it conveys the "meaning" of the information in the item type.

DKSemanticTypeDefICM represents semantic type information in Content Manager. This class defines methods required to access semantic type information.

Since: Version 8

Class summary:

class DKEXPORT DKSemanticTypeDefICM  
 {
 public :    
     DKSemanticTypeDefICM (dkDatastore* ds);
     DKSemanticTypeDefICM(const DKSemanticTypeDefICM& semantic);
     ~DKSemanticTypeDefICM();
     long  add();
     void  del();
     void  update();
     long getCode();
     void setCode( long semanticTypeCode );
     DKString getName();
     void setName( const char* semanticTypeCode );
     DKString getDescription();
     void setDescription(const char* semanticTypeDescript);
     DKString getDescription(const char* langCode);
     void setDescription(const char* desc, const char* langCode);
 };

Members:

Constructors and destructor
DKSemanticTypeDefICM (dkDatastore* ds);

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

DKSemanticTypeDefICM(const DKSemanticTypeDefICM& semantic);

A copy constructor for semantic type definition for ICM datastore. Parameters: semantic - an semantic type definition object.

~DKSemanticTypeDefICM();

Destructor for this object.

Member functions

add
Adds this semantic type object to the persistent store. Returns: the code for this semantic type object. Throws: DKException - if error occurs
long add();

del
Deletes the definition of this semantic type object from the persistent store. Throws: DKException - if error occurs.
void del();

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

getCode
Retrieve the code for this semantic-type definition. Returns: integer value of the code for this semantic type definition
long getCode();

setCode
Sets the semantic type code to the given value. Parameters: semanticTypeCode - semantic type code value to be assigned to this semantic type
void setCode(long semanticTypeCode);

getName
Retrieves the name of this semantic type. Returns: name of the semantic type
DKString getName(); 

setName
Sets the name of this semantic type to the given value. Parameters: semanticTypeName - name to be assigned to this semantic type
void setName(const char* semanticTypeName); 

getDescription
Retrieves the description of this semantic type. Returns: string value of this semantic type's description
DKString getDescription();

setDescription
Sets the semantic type description to the given value. Parameters: semanticTypeDescript - the description to be assigned to this semantic type
void setDescription(const char* semanticTypeDescript); 

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

setDescription
Sets the semantic type description to a given description for the specified language. Parameters: desc - semantic type description langCode - semantic type language code e.g. ENU, DEU
void setDescription(const char* semanticTypeDescript); 

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