Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKEventMgmtICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKEventMgmtICM
All Implemented Interfaces:
DKConstant, DKConstantICM, DKMessageId, DKMessageIdICM, java.io.Serializable

public class DKEventMgmtICM
extends java.lang.Object
implements DKMessageIdICM, DKConstantICM, java.io.Serializable

The DKEventMgmtICM class provides event management functionality in Content Manager. It contains all the book-keeping methods for dealing with events including methods for adding, deleting, updating, retrieving and listing event types to and from the persistent store

Since:
Version 8
See Also:
, Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdICM
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantICM
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Constructor Summary
DKEventMgmtICM(dkDatastore ds)
          Constructs an event managment for the specified ICM datastore
 
Method Summary
 void add(DKEventTypeDefICM eventTypeObj)
          Adds the specified event type object to the persitent store
 DKEventTypeDefICM createEventType()
          Creates a new event type definition
 void del(DKEventTypeDefICM eventTypeObj)
          Deletes the specified event type object from the persistent store
 DKEventTypeDefICM getEventType(java.lang.String eventTypeName)
          Retrieves the definition of the event type object for the given name from the in-memory event type definition list
 java.lang.String[] listEventTypeNames()
          Retrieves an array of event type names from the persistent store
 dkCollection listEventTypes()
          Retrieves the list of all event types from the persistent store
 DKEventTypeDefICM retrieveEventType(java.lang.String eventTypeName)
          Retrieves an instance of the event type object corresponding to the specified event type name from the persistent store
 void update(DKEventTypeDefICM eventTypeObj)
          Updates the event type definition corresponding to the specified object in the persistent store
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKEventMgmtICM

public DKEventMgmtICM(dkDatastore ds)
               throws DKException,
                      java.lang.Exception
Constructs an event managment for the specified ICM datastore
Parameters:
ds - datastore object as an instance of DKDatastoreICM
Method Detail

createEventType

public DKEventTypeDefICM createEventType()
Creates a new event type definition
Returns:
New event type definition object as an instance of DKEventTypeDefICM

getEventType

public DKEventTypeDefICM getEventType(java.lang.String eventTypeName)
                               throws DKException,
                                      java.lang.Exception
Retrieves the definition of the event type object for the given name from the in-memory event type definition list
Parameters:
EventTypeName - - name of event type object to be retrieved
Returns:
The event type definition object for the specified name
Throws:
if - the event type does not exist in the memory

listEventTypes

public dkCollection listEventTypes()
                            throws DKException,
                                   java.lang.Exception
Retrieves the list of all event types from the persistent store
Returns:
the collection of event type objects in the persistent store as instances of DKEventTypeDefICM

listEventTypeNames

public java.lang.String[] listEventTypeNames()
                                      throws DKException,
                                             java.lang.Exception
Retrieves an array of event type names from the persistent store
Returns:
an array of event type names as string variable from the persistent store
Throws:
if - an error occurs

retrieveEventType

public DKEventTypeDefICM retrieveEventType(java.lang.String eventTypeName)
                                    throws DKException,
                                           java.lang.Exception
Retrieves an instance of the event type object corresponding to the specified event type name from the persistent store
Parameters:
eventTypeName - name of event type to be retrieved
Returns:
The event type object corresponding to the specified name as an instance of DKEventTypeDefICM
Throws:
DKException - if the event type does not exist in the datastore

add

public void add(DKEventTypeDefICM eventTypeObj)
         throws DKException,
                java.lang.Exception
Adds the specified event type object to the persitent store
Parameters:
eventTypeObj - - event type object to be added to the persistent store.
Throws:
if - an error occurs.

del

public void del(DKEventTypeDefICM eventTypeObj)
         throws DKException,
                java.lang.Exception
Deletes the specified event type object from the persistent store
Parameters:
eventTypeObj - - the event type object to be deleted.
Throws:
if - this event type definition object to be deleted dose not exist in the persistent store

update

public void update(DKEventTypeDefICM eventTypeObj)
            throws DKNotExistException,
                   DKException,
                   java.lang.Exception
Updates the event type definition corresponding to the specified object in the persistent store
Parameters:
eventTypeObj - - the event type object whose defintion to be updated.
Throws:
if - this event type definition object to be updated dose not exist in the persistent store

EIP Java APIs

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