Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKEventTypeDefICM

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

public class DKEventTypeDefICM
extends java.lang.Object

The DKEventTypeDefICM class represents an event type definition in Content Manager. It provides methods needed to access and update event type information

Since:
Version 8
See Also:

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

Constructor Detail

DKEventTypeDefICM

public DKEventTypeDefICM(dkDatastore ds)
Constructs the definition of the event type for the specified ICM datastore
Parameters:
ds - - datastore object as an instance of DKDatastoreICM
Method Detail

add

public void add()
         throws DKException,
                java.lang.Exception
Adds the defintion of this event type to the persistent store.
Throws:
if - an error occurs on the server

del

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

update

public void update()
            throws DKException,
                   java.lang.Exception
Updates the definition of this event type in the persistent store. Only description field can be updated
Throws:
if - an error occurs on the server

getCode

public int getCode()
Retrieves the code for this event type object
Returns:
code for this event type object

getName

public java.lang.String getName()
Retrieves the name for this event type object
Returns:
name for the event type object to the specified value

setName

public void setName(java.lang.String eventTypeName)
Sets the name for this event type object to the specified value
Parameters:
eventTypeName - name to be assigned to this event type object

setLanguageCode

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

getLanguageCode

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

getDescription

public java.lang.String getDescription()
Retrieves the description for this event type
Returns:
the description of this event type object

setDescription

public void setDescription(java.lang.String eventTypeDescription)
Sets the description of the event type to a specified description. This is the description for the default language of the ICM datastore. To set the description for other language use setDescription(String desc, String langCode)
Parameters:
eventTypeDescription - event type description to be assigned to this event type object
See Also:
setDescription(String desc, String langCode)

getDescription

public java.lang.String getDescription(java.lang.String langCode)
                                throws DKException,
                                       java.lang.Exception
Retrieves the description of this event type for the specified language code
Parameters:
langCode - - language code for which the description of this event type object is to be retrieved. A sample value for the language code is "ENU" for US English
Returns:
the description of this event type for the specified language code

setDescription

public void setDescription(java.lang.String desc,
                           java.lang.String langCode)
                    throws DKException,
                           java.lang.Exception
Sets the description of this event type object for the specified language code to the specified value
Parameters:
eventTypeDescription - - description to be assigned to this event object
langCode - language code for which the description is to be set. A sample value for the language code is "ENU" for US English
Throws:
if - an error occurs

EIP Java APIs

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