Index
Purpose:
The DKNLSKeywordDefICM class represents a national language string for
Content Manager datastore entities such as attributes, attribute groups, item
types, component types, privileges, ACLs etc. A Content Manager
datastore entity such as an attribute can have a name and different display
names in different languages. This class is used to define the
description and name for languages defined in the datastore.
Since: Version 8
Class summary:
class DKEXPORT DKNLSKeywordDefICM
{
public:
DKNLSKeywordDefICM (dkDatastore* ds);
virtual ~DKNLSKeywordDefICM();
long getCode();
void setCode( long keywordCode );
short getClass();
void setClass( short keywordClass );
DKString getLanguageCode();
void setLanguageCode(const char* languageCode );
DKString getName();
void setName( const char* keywordName );
DKString getDescription();
void setDescription( const char* keywordDescript );
};
Members:
-
-
- Constructors and destructor
-
DKNLSKeywordDefICM (dkDatastore* ds)
Constructs a NLS keyword object and initializes it with a datastore
object.Parameters:ds - pointer to a datastore
object. The datastore object pointed to is an instance of
DKDatastoreICM virtual ~DKNLSKeywordDefICM() Destructor for this
object.
- Member functions
-
- getcode
- Retrieves the internal keyword identifier by which the persistent store
identifies the NLS keyword.
Returns:identifier for the NLS keyword
long getCode();
- setcode
- Sets the NLS keyword code to the given value.
Parameters:keywordCode - NLS keyword code to be
assigned to this keyword
Returns:identifier for the NLS keyword
void setCode( long keywordCode );
- getClass
- Retrieves the type or class of the keyword that this object is
referencing. value returned is one of the following:
- ICM_NLS_ATTR_CLASS keyword class = attribute
- ICM_NLS_ITEMTYPE_CLASS keyword class = item type
- ICM_NLS_COMPVIEW_CLASS keyword class = component type view
- ICM_NLS_LINKTYPE_CLASS keyword class = link type
- ICM_NLS_COMPTYPE_CLASS keyword class = component type
- ICM_NLS_ATTRGRP_CLASS keyword class = attribute group
- ICM_NLS_ITCLASSIFICATION_CLASS keyword class = item type classification
- ICM_NLS_LSID_CLASS keyword class = library server
- ICM_NLS_LIBRRY_CLASS keyword class = library
- ICM_NLS_PRIVILEGE_CLASS keyword class = privilege
- ICM_NLS_PRIVILEGESET_CLASS keyword class = privilege set
- ICM_NLS_PRIVILEGEGRP_CLASS keyword class = privilege group
- ICM_NLS_ACL_CLASS keyword class = ACL access control list
- ICM_NLS_SEMANTICTYPE_CLASS keyword class = semantic type
- ICM_NLS_RM_ACCESS_CLASS keyword class = resource manager access
- ICM_NLS_EVENTTYPE_CLASS keyword class = event type
- ICM_NLS_ADMIN_DOMAIN_CLASS keyword class = admin domain
- ICM_NLS_ITEMTYPE_VIEW_CLASS keyword class = item type view
short getClass();
- setClass
- Sets the type or class of the NLS keyword that this object represents The
class can be one of the following:
- ICM_NLS_ATTR_CLASS keyword class = attribute
- ICM_NLS_ITEMTYPE_CLASS keyword class = item type
- ICM_NLS_COMPVIEW_CLASS keyword class = component type view
- ICM_NLS_LINKTYPE_CLASS keyword class = link type
- ICM_NLS_COMPTYPE_CLASS keyword class = component type
- ICM_NLS_ATTRGRP_CLASS keyword class = attribute group
- ICM_NLS_ITCLASSIFICATION_CLASS keyword class = item type classification
- ICM_NLS_LSID_CLASS keyword class = library server
- ICM_NLS_LIBRRY_CLASS keyword class = library
- ICM_NLS_PRIVILEGE_CLASS keyword class = privilege
- ICM_NLS_PRIVILEGESET_CLASS keyword class = privilege set
- ICM_NLS_PRIVILEGEGRP_CLASS keyword class = privilege group
- ICM_NLS_ACL_CLASS keyword class = ACL access control list
- ICM_NLS_SEMANTICTYPE_CLASS keyword class = semantic type
- ICM_NLS_RM_ACCESS_CLASS keyword class = resource manager access
- ICM_NLS_EVENTTYPE_CLASS keyword class = event type
- ICM_NLS_ADMIN_DOMAIN_CLASS keyword class = admin domain
- ICM_NLS_ITEMTYPE_VIEW_CLASS keyword class = item type view
void setClass( short keywordClass );
- getLanguageCode
- Retrieves the language code that this keyword description
represents. Note: The language code returned is the 3 character
IBM language code. Also note that this should be one of the languages
that is defined in the ICM datastore.
Returns:3 character IBM language code (e.g.
"ENU" for US English)
DKString getLanguageCode();
- setLanguageCode
- Sets the NLS keyword language code for this keyword.This string can
be up to 3 characters long.
Parameters:languageCode - language code to set
for this NLS keyword object. Note: The language code set should
be one of the 3 character IBM language code. For example, the code for
US English is "ENU"
void setLanguageCode(const char* languageCode );
- getName
- Gets the language-independent name for this NLS keyword object.
Returns:language-independent name as a DKString variable
DKString getName();
- setName
- Sets the language-independent name for this keyword object.
Parameters:keywordName - language-independent
name of up to 32 characters
void setName( const char* keywordName );
- getDescription
- Retrieves the description for this NLS keyword. The description may
be language-specific for a given NLS keyword.
Returns:description for this keyword object as a DKString
variable
DKString getDescription();
- setDescription
- Sets the NLS keyword description for this NLS keyword object. The
value is a language dependent description for the keyword.
Parameters:keywordDescript - description for
this keyword object. The value can be up to 254 characters long.
void setDescription( const char* keywordDescript );
(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.