Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKDatastoreAdminICM

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

public class DKDatastoreAdminICM
extends dkAbstractDatastoreAdmin
implements DKConstantICM, DKMessageIdICM

DKDatastoreAdminICM : This class represents and processes datastore administration functions.

This class provides methods to access various management classes, process NLS languages and client exit functions.

See Also:
DKAuthorizationMgmtICM, DKUserMgmtICM, DKConfigurationMgmtICM, DKWorkFlowMgmtFed, DKAdminDomainsMgmtICM, DKEventMgmtICM, DKMimeTypeMgmtICM, Serialized Form

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
 
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
 
Constructor Summary
DKDatastoreAdminICM(dkDatastore ds)
          Constructs a datastore administration class associated with a given datastore
 
Method Summary
 void addClientExit(DKClientExitDefICM exitObj)
          Adds a client exit object to the datastore
 void addNLSKeywordDesc(java.lang.String langCode, short sKeywordClass, long lKeywordCode, java.lang.String szKeywordDesc)
          Adds the NLS key word description of an object to the datastore
 void addNLSLanguage(java.lang.String langCode, java.lang.String langName)
          Adds a NLS language to the datastore
 dkAdminDomainsMgmt adminDomainsMgmt()
          Gets the reference to the admininistrative domains management object.
 dkAuthorizationMgmt authorizationMgmt()
          Gets the reference to the authorization management object.
 dkConfigurationMgmt configurationManagement()
          Gets the reference to the configuration management object.
 void delClientExit(DKClientExitDefICM exitObj)
          Deletes a client exit object from the datastore
 void deleteNLSKeywordDesc(java.lang.String langCode, short sKeywordClass, long lKeywordCode)
          Deletes the NLS key word description of the object from the datastore.
 void deleteNLSLanguage(java.lang.String langCode)
          Deletes a NLS language from the datastore
 DKEventMgmtICM eventManagement()
          Gets the reference to the event management object.
 java.lang.String getDefaultLanguageCode()
          Gets the language code of the default language from the datastore.
 java.lang.String[] listClientExitNames()
          Lists the names of the client exits from the datastore.
 dkCollection listClientExits()
          Lists all client exit objects from the datastore
 dkCollection listClientExitsForItemType(int itemTypeID)
          Lists the client exit objects of an item type with a given name from the datastore.
 dkCollection listClientExitsForItemType(java.lang.String itemTypeName)
          Lists the client exit objects of an item type with a given name from the datastore
 dkCollection listClientExitsForItemTypeView(int itemTypeViewID)
          Lists the client exit objects of an item type view with a given item type view ID from the datastore
 dkCollection listClientExitsForItemTypeView(java.lang.String itemTypeViewName)
          Lists the client exit objects of an item type view with a given name from the datastore.
 java.util.Vector listNLSKeywordDesc(java.lang.String langCode, short sKeywordClass)
          Lists the NLS key word descriptions of objects belonging to a given keyword class in the datastore.
 dkCollection listNLSLanguages()
          Lists all NLS Languages defined in the datastore
 DKMimeTypeMgmtICM mimeTypeMgmt()
          Gets the reference to the MIME type management object
 DKClientExitDefICM retrieveClientExit(java.lang.String exitName)
          Retrieves a client exit object with a given name from the datastore.
 java.lang.String retrieveNLSKeywordDesc(java.lang.String langCode, short sKeywordClass, long lKeywordCode)
          Retrieves the NLS key word description of an object from the datastore
 java.lang.String retrieveNLSLanguage(java.lang.String langCode)
          Retrieves a NLS language from a datastore
 void updateClientExit(DKClientExitDefICM exitObj)
          Updates a client exit object in the datastore.
 void updateNLSKeywordDesc(java.lang.String langCode, short sKeywordClass, long lKeywordCode, java.lang.String szKeywordDesc)
          Replaces the old keyword description with the new keyword description.
 void updateNLSLanguage(java.lang.String langCode, java.lang.String langName)
          Updates a NLS language name in the datastore
 dkUserManagement userManagement()
          Gets the reference to the user management object
 dkWorkFlowMgmt workFlowManagement()
          Gets the reference to the workflow management object.
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractDatastoreAdmin
accessControl, clearCache, getDatastore, setDatastore
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKDatastoreAdminICM

public DKDatastoreAdminICM(dkDatastore ds)
Constructs a datastore administration class associated with a given datastore
Parameters:
ds - a reference to the datastore object. Note: Should the connection to the datastore be already established
Method Detail

authorizationMgmt

public dkAuthorizationMgmt authorizationMgmt()
                                      throws DKException,
                                             java.lang.Exception
Gets the reference to the authorization management object.
Overrides:
authorizationMgmt in class dkAbstractDatastoreAdmin
Returns:
the authorization management object. This authorization management object can be used to manage the authorization related entities such as Privileges and ACLs.
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs
See Also:
DKAuthorizationMgmtICM

userManagement

public dkUserManagement userManagement()
                                throws DKException,
                                       java.lang.Exception
Gets the reference to the user management object
Overrides:
userManagement in class dkAbstractDatastoreAdmin
Returns:
the the user management object. This user management object can be used to manage users and user groups.
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs
See Also:
DKUserMgmtICM

configurationManagement

public dkConfigurationMgmt configurationManagement()
                                            throws DKException,
                                                   java.lang.Exception
Gets the reference to the configuration management object.
Overrides:
configurationManagement in class dkAbstractDatastoreAdmin
Returns:
the the configuration management object. This configuration management object can be used to manage the library server and resource manager configuration object
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs
See Also:
DKConfigurationMgmtICM

workFlowManagement

public dkWorkFlowMgmt workFlowManagement()
                                  throws DKException,
                                         java.lang.Exception
Gets the reference to the workflow management object.
Overrides:
workFlowManagement in class dkAbstractDatastoreAdmin
Returns:
the workflow manaegment object. This workflow management object can be used to manage the workflow process.
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs
See Also:
DKWorkFlowMgmtFed

adminDomainsMgmt

public dkAdminDomainsMgmt adminDomainsMgmt()
                                    throws DKException,
                                           java.lang.Exception
Gets the reference to the admininistrative domains management object.
Overrides:
adminDomainsMgmt in class dkAbstractDatastoreAdmin
Returns:
the administrative domain object. This administrative domain object can be used to manage the administrative domain such as adding, removing users, user groups ACLs.
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs
See Also:
DKAdminDomainsMgmtICM

eventManagement

public DKEventMgmtICM eventManagement()
                               throws DKException,
                                      java.lang.Exception
Gets the reference to the event management object.
Returns:
the event management object. This event management object can be used to manage event types in the datastore.
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs
See Also:
DKEventMgmtICM

mimeTypeMgmt

public DKMimeTypeMgmtICM mimeTypeMgmt()
                               throws DKException,
                                      java.lang.Exception
Gets the reference to the MIME type management object
Returns:
the mime type managementDKMimeTypeMgmtICM object. This object can be used to manage the mime types available in the datastore such as getting a list, adding, updating mime types.
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs
See Also:
DKMimeTypeMgmtICM

addNLSLanguage

public void addNLSLanguage(java.lang.String langCode,
                           java.lang.String langName)
                    throws DKException,
                           java.lang.Exception
Adds a NLS language to the datastore
Parameters:
langCode - -the language code of the NLS language to be added. The language code can be up to 3 characters.
langName - - the language name of the NLS language to be added The language name can be up to 32 characters long. Longer strings will be truncated.
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs Note: When a new language is added to the system, the library server will replicate the description of the library server entities from the default language. An asterisk (*) will be prepended to the description strings. The user can update the description for the new language if they wish.

updateNLSLanguage

public void updateNLSLanguage(java.lang.String langCode,
                              java.lang.String langName)
                       throws DKException,
                              java.lang.Exception
Updates a NLS language name in the datastore
Parameters:
langCode - - the language code of the NLS language to be updated.
langName - - updated new language name.
Throws:
DKException - when language is not found
java.lang.Exception - when error occurs

deleteNLSLanguage

public void deleteNLSLanguage(java.lang.String langCode)
                       throws DKException,
                              java.lang.Exception
Deletes a NLS language from the datastore
Parameters:
langCode - -- the language code of the NLS language to be deleted.
Throws:
DKException - when the language is not found
java.lang.Exception - when error occurs

retrieveNLSLanguage

public java.lang.String retrieveNLSLanguage(java.lang.String langCode)
                                     throws DKException,
                                            java.lang.Exception
Retrieves a NLS language from a datastore
Parameters:
langCode - - the language code of the NLS language to be retrieved
Returns:
the language name
Throws:
DKException - when the language is not found
java.lang.Exception - when error occurs

listNLSLanguages

public dkCollection listNLSLanguages()
                              throws DKException,
                                     java.lang.Exception
Lists all NLS Languages defined in the datastore
Returns:
a collection of all NLS language objectss such that each object is represented by an array of String containing the language code and the language name of each NLS language in order.
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs

addNLSKeywordDesc

public void addNLSKeywordDesc(java.lang.String langCode,
                              short sKeywordClass,
                              long lKeywordCode,
                              java.lang.String szKeywordDesc)
                       throws DKException,
                              java.rmi.RemoteException,
                              java.lang.Exception
Adds the NLS key word description of an object to the datastore
Parameters:
langCode - -- the language code of the NLS language.
sKeywordClass - -- the keyword class of the object for which the descriptions is being added. NOTE: We should list the valid keyword classes here AND in other methods which has keywordClass as the parameter.
lKeywordCode - -- the keyword code of the object for which the description is being added
szKeywordDesc - -- the keyword description of the object.
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs
java.rmi.RemoteException - when error occurs

updateNLSKeywordDesc

public void updateNLSKeywordDesc(java.lang.String langCode,
                                 short sKeywordClass,
                                 long lKeywordCode,
                                 java.lang.String szKeywordDesc)
                          throws DKException,
                                 java.rmi.RemoteException,
                                 java.lang.Exception
Replaces the old keyword description with the new keyword description.
Parameters:
langCode - -the language code of the NLS language for which the keyword description is to be updated.
sKeywordClass - - the keyword class of the object for which the descriptions .
lKeywordCode - - the keyword code of the object for which the description is being added. the keyword code
szKeywordDesc - - the key word descriptionthe new keyword description of the object that will replace the old one.
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs
java.rmi.RemoteException - when error occurs

deleteNLSKeywordDesc

public void deleteNLSKeywordDesc(java.lang.String langCode,
                                 short sKeywordClass,
                                 long lKeywordCode)
                          throws DKException,
                                 java.rmi.RemoteException,
                                 java.lang.Exception
Deletes the NLS key word description of the object from the datastore. Note: Care must be taken when deleting the description. Some ICM applications may use the description strings to represent the keyword to the end user.
Parameters:
langCode - - the language code of the NLS language for which the keyword description is to be deleted
sKeywordClass - - the keyword class of the object for which the descriptions is being added. NOTE: We should list the valid keyword classes here AND in other methods which has keywordClass as the parameter.
lKeywordCode - - the keyword code of the object for which the description is to be deleted
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs
java.rmi.RemoteException - when error occurs

retrieveNLSKeywordDesc

public java.lang.String retrieveNLSKeywordDesc(java.lang.String langCode,
                                               short sKeywordClass,
                                               long lKeywordCode)
                                        throws DKException,
                                               java.rmi.RemoteException,
                                               java.lang.Exception
Retrieves the NLS key word description of an object from the datastore
Parameters:
langCode - -- the language code of the NLS language
sKeywordClass - -- the keyword class class that the object is belonging to
lKeywordCode - -- the keyword code of the object.
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs
java.rmi.RemoteException - when error occurs

listNLSKeywordDesc

public java.util.Vector listNLSKeywordDesc(java.lang.String langCode,
                                           short sKeywordClass)
                                    throws DKException,
                                           java.rmi.RemoteException,
                                           java.lang.Exception
Lists the NLS key word descriptions of objects belonging to a given keyword class in the datastore.
Parameters:
langCode - -- the language code of the NLS language
sKeywordClass - -- the keyword class
Returns:
a vector containing the list of NLS key word descriptions such that each element of the vector is an array of String that represents the name and the description of the object in order.
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs
java.rmi.RemoteException - when error occurs

getDefaultLanguageCode

public java.lang.String getDefaultLanguageCode()
                                        throws DKException,
                                               java.rmi.RemoteException,
                                               java.lang.Exception
Gets the language code of the default language from the datastore.
Returns:
the language code of the default language name
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs
java.rmi.RemoteException - when error occurs
See Also:
class .

listClientExitNames

public java.lang.String[] listClientExitNames()
                                       throws DKException,
                                              java.lang.Exception
Lists the names of the client exits from the datastore.
Returns:
a string array of the names of the client exits
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs

listClientExits

public dkCollection listClientExits()
                             throws DKException,
                                    java.rmi.RemoteException,
                                    java.lang.Exception
Lists all client exit objects from the datastore
Returns:
a collection of the DKClientExitDefICM objects that represent the client exit objects
Throws:
DKException - when error occurs
java.rmi.RemoteException - when error occurs
java.lang.Exception - when error occurs
See Also:
DKClientExitDefICM

listClientExitsForItemType

public dkCollection listClientExitsForItemType(java.lang.String itemTypeName)
                                        throws DKException,
                                               java.rmi.RemoteException,
                                               java.lang.Exception
Lists the client exit objects of an item type with a given name from the datastore
Parameters:
itemTypeName - the name of the item type for which the client exits are to be listed
Returns:
a collection of the DKClientExitDefICM objects that represent the client exit objects
Throws:
DKException - when error occurs
java.rmi.RemoteException - when error occurs
java.lang.Exception - when error occurs
See Also:
DKClientExitDefICM

listClientExitsForItemType

public dkCollection listClientExitsForItemType(int itemTypeID)
                                        throws DKException,
                                               java.rmi.RemoteException,
                                               java.lang.Exception
Lists the client exit objects of an item type with a given name from the datastore.
Parameters:
itemTypeID - the id of the item type for which the client exits are to be listed
Returns:
a collection of the DKClientExitDefICM objects that represent the client exit objects
Throws:
DKException - when error occurs
java.rmi.RemoteException - when error occurs
java.lang.Exception - when error occurs
See Also:
DKClientExitDefICM

listClientExitsForItemTypeView

public dkCollection listClientExitsForItemTypeView(java.lang.String itemTypeViewName)
                                            throws DKException,
                                                   java.rmi.RemoteException,
                                                   java.lang.Exception
Lists the client exit objects of an item type view with a given name from the datastore.
Parameters:
itemTypeViewName - the name of the item type view for which the client exits are to be listed
Returns:
a collection of the DKClientExitDefICM objects that represent theclient exit objects.
Throws:
DKException - when error occurs
java.rmi.RemoteException - when error occurs
java.lang.Exception - when error occurs
See Also:
DKClientExitDefICM

listClientExitsForItemTypeView

public dkCollection listClientExitsForItemTypeView(int itemTypeViewID)
                                            throws DKException,
                                                   java.rmi.RemoteException,
                                                   java.lang.Exception
Lists the client exit objects of an item type view with a given item type view ID from the datastore
Parameters:
itemTypeID - the id of the item type view for which the client exits are to be listed
Returns:
a collection of the DKClientExitDefICM objects that represent the client exit objects
Throws:
DKException - when error occurs
java.rmi.RemoteException - when error occurs
java.lang.Exception - when error occurs

retrieveClientExit

public DKClientExitDefICM retrieveClientExit(java.lang.String exitName)
                                      throws DKException,
                                             java.rmi.RemoteException,
                                             java.lang.Exception
Retrieves a client exit object with a given name from the datastore.
Parameters:
exitName - the name of the client exit object for which the client exits object is to be retrieved
Returns:
a client exit object
Throws:
DKException - when error occurs
java.rmi.RemoteException - when error occurs
java.lang.Exception - when error occurs
See Also:
DKClientExitDefICM

addClientExit

public void addClientExit(DKClientExitDefICM exitObj)
                   throws DKException,
                          java.rmi.RemoteException,
                          java.lang.Exception
Adds a client exit object to the datastore
Parameters:
exitObj - the given client exit object
Throws:
DKException - when error occurs
java.rmi.RemoteException - when error occurs
java.lang.Exception - when error occurs
See Also:
DKClientExitDefICM

updateClientExit

public void updateClientExit(DKClientExitDefICM exitObj)
                      throws DKException,
                             java.rmi.RemoteException,
                             java.lang.Exception
Updates a client exit object in the datastore.
Parameters:
exitObj - the given client exit object
Throws:
DKException - when error occurs
java.rmi.RemoteException - when error occurs
java.lang.Exception - when error occurs
See Also:
DKClientExitDefICM

delClientExit

public void delClientExit(DKClientExitDefICM exitObj)
                   throws DKException,
                          java.rmi.RemoteException,
                          java.lang.Exception
Deletes a client exit object from the datastore
Parameters:
exitObj - the given client exit object.
Throws:
DKException - when error occurs
java.rmi.RemoteException - when error occurs
java.lang.Exception - when error occurs

EIP Java APIs

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