Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKSemanticTypeDefICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKSemanticTypeDefICM

public class DKSemanticTypeDefICM
extends java.lang.Object

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. The DKSemanticTypeDefICM represents semantic type information in the Content Manager. This class defines methods required to access semantic type information


Constructor Summary
DKSemanticTypeDefICM(dkDatastore ds)
          Constructs the definition of the semantic type for the given ICM datastore
 
Method Summary
 int add()
          Adds this semantic type object to the persistent store
 void del()
          Deletes the definition of this semantic type object from the persistent store
 int getCode()
          Retrieve the code for this semantic-type definition
 java.lang.String getDescription()
          Retrieves the description of this semantic type
 java.lang.String getDescription(java.lang.String langCode)
          Gets the semantic type description.
 java.lang.String getLanguageCode()
          Gets the language code of the semantic type.
 java.lang.String getName()
          Retrieves the name of this semantic type
 void setDescription(java.lang.String semanticTypeDescript)
          Sets the semantic type description to the given value
 void setDescription(java.lang.String desc, java.lang.String langCode)
          Sets the semantic type description.
 void setLanguageCode(java.lang.String semanticTypeLangCode)
          Sets the semantic type's language code to a specified language code
 void setName(java.lang.String semanticTypeName)
          Sets the name of this semantic type to the given value
 void update()
          Updates the definition of this semantic type in the persistent store
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKSemanticTypeDefICM

public DKSemanticTypeDefICM(dkDatastore ds)
Constructs the definition of the semantic type for the given ICM datastore
Parameters:
ds - datastore object as an instance of DKDatastoreICM
Method Detail

add

public int add()
        throws DKException,
               java.lang.Exception
Adds this semantic type object to the persistent store
Returns:
the code for this semantic type object
Throws:
if - an error occurs

del

public void del()
         throws DKException,
                java.lang.Exception
Deletes the definition of this semantic type object from the persistent store
Throws:
if - an error occurs

update

public void update()
            throws DKException,
                   java.lang.Exception
Updates the definition of this semantic type in the persistent store
Throws:
if - an error occurs

getCode

public int getCode()
Retrieve the code for this semantic-type definition
Returns:
integer value of the code for this semantic type definition

getName

public java.lang.String getName()
Retrieves the name of this semantic type
Returns:
name of the semantic type

setName

public void setName(java.lang.String semanticTypeName)
Sets the name of this semantic type to the given value
Parameters:
semanticTypeName - name to be assigned to this semantic type

setLanguageCode

public void setLanguageCode(java.lang.String semanticTypeLangCode)
Sets the semantic type's language code to a specified language code
Parameters:
semanticTypeLangCode - semantic type language code to be assigned to this semantic type.

getLanguageCode

public java.lang.String getLanguageCode()
Gets the language code of the semantic type.
Returns:
the language code for this semantic type

getDescription

public java.lang.String getDescription()
Retrieves the description of this semantic type
Returns:
string value of this semantic type's description

setDescription

public void setDescription(java.lang.String semanticTypeDescript)
Sets the semantic type description to the given value
Parameters:
semanticTypeDescript - the description to be assigned to this semantic type

getDescription

public java.lang.String getDescription(java.lang.String langCode)
                                throws DKException,
                                       java.lang.Exception
Gets the semantic type description.
Parameters:
langCode - symantic type language code. e.g. ENU
Returns:
semantic type description for a given language

setDescription

public void setDescription(java.lang.String desc,
                           java.lang.String langCode)
                    throws DKException,
                           java.lang.Exception
Sets the semantic type description.
Parameters:
desc - semantic type description
langCode - semantic type language code e.g. ENU

EIP Java APIs

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