Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKLinkTypeDefICM

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

public class DKLinkTypeDefICM
extends java.lang.Object

This class defines methods to manage link type information. Link type indicates the type of relationship. The valid values are: Contains, DKFolder and the other user defined link types defined by system administrator.


Constructor Summary
DKLinkTypeDefICM(dkDatastore ds)
          Constructs the definition of the link type for a given ICM datastore
 
Method Summary
 int add()
          Adds the definition of this link type both to the persistent store and to the memory
 void del()
          Deletes the definition of the link type from both the persistent store and the memory
 int getCode()
          Gets the code of the link type
 java.lang.String getDescription()
          Gets the description of the link type.
 java.lang.String getDescription(java.lang.String langCode)
          Gets the link type description for the specified language.
 java.lang.String getLanguageCode()
          Gets the language code of the link type.
 java.lang.String getName()
          Gets the name of the link type.
 void setDescription(java.lang.String linkTypeDescript)
          Sets the link type's description to a specified description.
 void setDescription(java.lang.String desc, java.lang.String langCode)
          Sets the link type description to a given description for the specified language
 void setLanguageCode(java.lang.String linkTypeLangCode)
          Sets the link type's language code to a specified language code
 void setName(java.lang.String linkTypeName)
          Sets the link type's name to a specified name
 void update()
          Updates the definition of this link type both in the persistent store and in the memory
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKLinkTypeDefICM

public DKLinkTypeDefICM(dkDatastore ds)
Constructs the definition of the link type for a given ICM datastore
Parameters:
ds - datastore which this link object refers to
Method Detail

add

public int add()
        throws DKException,
               java.lang.Exception
Adds the definition of this link type both to the persistent store and to the memory
Throws:
if - an error occurs

del

public void del()
         throws DKException,
                java.lang.Exception
Deletes the definition of the link type from both the persistent store and the memory
Throws:
if - an error occurs

update

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

getCode

public int getCode()
Gets the code of the link type
Returns:
int value of the link type code

getName

public java.lang.String getName()
Gets the name of the link type. This name is independent of the languages defined in the ICM datastore.
Returns:
name of the link type

setName

public void setName(java.lang.String linkTypeName)
Sets the link type's name to a specified name
Parameters:
linkTypeName - link type name to be assigned to this link type. This string can be up to 32 characters long

setLanguageCode

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

getLanguageCode

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

getDescription

public java.lang.String getDescription()
Gets the description of the link type. This description is language dependent and the default language description is returned. To get the description in other languages use getDescription(java.lang.String langCode)
Returns:
Default language description of the link type
See Also:
to retrieve other language description

setDescription

public void setDescription(java.lang.String linkTypeDescript)
Sets the link type's description to a specified description. This is the description for the default language of the ICM datastore. To set the description for other languages use setDescription(java.lang.String desc, java.lang.String langCode)
Parameters:
linkTypeDescript - link type description to be assigned to this link type for the default language of the ICM datastore. The description string can be up to 254 characters long.
See Also:
setDescription(String, String)

getDescription

public java.lang.String getDescription(java.lang.String langCode)
                                throws DKException,
                                       java.lang.Exception
Gets the link type description for the specified language.
Parameters:
langCode - link type language code. e.g. ENU, DEU
Returns:
link type description for the specified language

setDescription

public void setDescription(java.lang.String desc,
                           java.lang.String langCode)
                    throws DKException,
                           java.lang.Exception
Sets the link type description to a given description for the specified language
Parameters:
desc - link type description
langCode - link type language code e.g. ENU, DEU

EIP Java APIs

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