Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKNLSKeywordDefICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKNLSKeywordDefICM
All Implemented Interfaces:
java.io.Serializable

public class DKNLSKeywordDefICM
extends java.lang.Object
implements java.io.Serializable

Use this class to represent a national language string for ICM datastore entities such as Attribute Groups, Item Types, Component Types, Privileges, ACLs etc. An ICM datastore entity such as Attribute can have a name and different display names in different languages. Use this class to define the description name for languages defined in the datastore.

See Also:
Form DKdatastoreAdminICM, Serialized Form

Constructor Summary
DKNLSKeywordDefICM(dkDatastore ds)
          Constructs a NLS keyword object and initializes it with an ICM datastore object.
 
Method Summary
 int getCode()
          Gets the internal keyword identifier by which the ICM datastore identifies the keyword.
 java.lang.String getDescription()
          Gets the description of the keyword.
 short getKeywordClass()
          Gets the type or class of the keyword that this object is referencing.
 java.lang.String getLanguageCode()
          Gets the language code that this keyword description represents.
 java.lang.String getName()
          Gets the name of keyword.
 void setDescription(java.lang.String keywordDescript)
          Sets the keyword description for this keyword.
 void setKeywordClass(short keywordClass)
          Sets the type or class of the keyword that this object represents.
 void setLanguageCode(java.lang.String languageCode)
          Sets the keyword language code for this keyword description.
 void setName(java.lang.String keywordName)
          Sets the keyword name.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKNLSKeywordDefICM

public DKNLSKeywordDefICM(dkDatastore ds)
Constructs a NLS keyword object and initializes it with an ICM datastore object.
Parameters:
ds - datastore where the keywords are managed.
Method Detail

getCode

public int getCode()
Gets the internal keyword identifier by which the ICM datastore identifies the keyword.
Returns:
internal keyword identifier of the keyword.

getKeywordClass

public short getKeywordClass()
Gets the type or class of the keyword that this object is referencing. The value returned is one of the following:
Returns:
type or class of the keyword that this object represents.

setKeywordClass

public void setKeywordClass(short keywordClass)
Sets the type or class of the keyword that this object represents. The class can be one of the following:
Parameters:
keywordCode - keyword class value to be assigned to this keyword

getLanguageCode

public java.lang.String getLanguageCode()
Gets 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:
language code that this keyword description represents.

setLanguageCode

public void setLanguageCode(java.lang.String languageCode)
Sets the keyword language code for this keyword description. The string can be up to 3 characters long. 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.
Parameters:
languageCode - keyword language code to be assigned to this keyword

getName

public java.lang.String getName()
Gets the name of keyword. This is the language independent name for the keyword.
Returns:
name of the keyword type

setName

public void setName(java.lang.String keywordName)
Sets the keyword name. This is the language independent name for the keyword. This string can be up to 32 characters.
Parameters:
keywordName - keyword name to be assigned to this keyword

getDescription

public java.lang.String getDescription()
Gets the description of the keyword. This string may be language independent for a given keyword name.
Returns:
the description of the keyword for a given language.

setDescription

public void setDescription(java.lang.String keywordDescript)
Sets the keyword description for this keyword. This is a language dependent description for the keyword. This string can be up to 254 characters.
Parameters:
keywordDescript - keyword description to be assigned to this keyword for a given language.

EIP Java APIs

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