|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.DKSemanticTypeDefICM
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 |
public DKSemanticTypeDefICM(dkDatastore ds)
ds
- datastore object as an instance of DKDatastoreICMMethod Detail |
public int add() throws DKException, java.lang.Exception
if
- an error occurspublic void del() throws DKException, java.lang.Exception
if
- an error occurspublic void update() throws DKException, java.lang.Exception
if
- an error occurspublic int getCode()
public java.lang.String getName()
public void setName(java.lang.String semanticTypeName)
semanticTypeName
- name to be assigned to this semantic typepublic void setLanguageCode(java.lang.String semanticTypeLangCode)
semanticTypeLangCode
- semantic type language code to be assigned to this semantic type.public java.lang.String getLanguageCode()
public java.lang.String getDescription()
public void setDescription(java.lang.String semanticTypeDescript)
semanticTypeDescript
- the description to be assigned to
this semantic typepublic java.lang.String getDescription(java.lang.String langCode) throws DKException, java.lang.Exception
langCode
- symantic type language code. e.g. ENUpublic void setDescription(java.lang.String desc, java.lang.String langCode) throws DKException, java.lang.Exception
desc
- semantic type descriptionlangCode
- semantic type language code e.g. ENU
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |