Index

DKDatastoreAdminICM

Purpose:

This class represents and processes datastore administration functions. This class provides methods to access various management classes and process NLS languages. See Also: DKAuthorizationMgmtICM, DKUserMgmtICM, DKConfigurationMgmtICM, DKWorkFlowMgmtFed, DKAdminDomainsMgmtICM, DKEventMgmtICM, DKMimeTypeMgmtICM

Since: Version 8

Class summary:

class DKEXPORT DKDatastoreAdminICM : public dkDatastoreAdmin
{
 public:
                                        DKDatastoreAdminICM(dkDatastore* ds);
    virtual                            ~DKDatastoreAdminICM();
    virtual     dkUserManagement*      userManagement();
    virtual     dkAuthorizationMgmt*   authorizationMgmt();
    virtual     dkConfigurationMgmt*   configurationManagement();
                DKEventMgmtICM*        eventManagement();
                DKMimeTypeMgmtICM*     mimeTypeMgmt();
    virtual     void                   addNLSLanguage(const char* langCode, const char* langName);
    virtual     void                   updateNLSLanguage(const char* langCode, const char* langName);
    virtual     void                   deleteNLSLanguage(const char* langCode);
    virtual     DKString                retrieveNLSLanguage(const char* langCode);
    virtual     dkCollection*          listNLSLanguages();
    virtual     void                   addNLSKeywordDesc(const char* langCode, short sKeywordClass, long lKeywordCode,const char* szKeywordDesc);
    virtual     void                      updateNLSKeywordDesc(const char* langCode, short sKeywordClass, long lKeywordCode, const char* szKeywordDesc);
    virtual     void                    deleteNLSKeywordDesc(const char* langCode, short sKeywordClass, long lKeywordCode);
    virtual     DKString                retrieveNLSKeywordDesc(const char* langCode, short sKeywordClass, long lKeywordCode);
    virtual     DKString                getDefaultLanguageCode();
 };

Members:

Constructors and destructor
DKDatastoreAdminICM(dkDatastore* ds);

Constructs a datastore administration class associated with a given datastore.

Parameters: ds - a reference to the datastore object Destructor

virtual ~DKDatastoreAdminICM()

Destructor for this object.

Member functions

userManagement
Gets the reference to the user management object.

Overrides: userManagement() in class dkDatastoreAdmin

Returns: the user management object. This user management object can be used to manage users and user groups.

Throws: DKException - if an error occurs

See Also: DKUserMgmgICM

virtual dkUserManagement*   userManagement();

authorizationMgmt
Gets the reference to the authorization management object.

Overrides: authorizationMgmt() in class dkDatastoreAdmin

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 - if an error occurs

See Also: DKAuthorizationMgmtICM

virtual dkAuthorizationMgmt*    authorizationMgmt();

configurationManagement
Gets the reference to the configuration management object.

Overrides: configurationManagement() in class dkDatastoreAdmin

Returns: the configuration management object. This configuration management object can be used to manage the library server and resource manager configuration

Throws: DKException - if an error occurs

See Also: DKConfigurationMgmtICM

virtual dkConfigurationMgmt*    configurationManagement();

eventManagement
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 - if an error occurs

See Also: DKEventMgmtICM

DKEventMgmtICM* eventManagement();

mimeTypeMgmt
Gets the reference to the MIME type management object.

Returns: the MIME type management 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 - if an error occurs

See Also: DKMimeTypeMgmtICM

DKMimeTypeMgmtICM* mimeTypeMgmt();

addNLSLanguage
Adds an 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 - if an 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.

virtual void addNLSLanguage(const char* langCode, const char* langName);

updateNLSLanguage
Updates an NLS language name in the datastore.

Parameters:

  • langCode - the language code of the NLS language to be updated. The language code cannot be updated.
  • langName - the language name to be updated to a new language name.

Throws: DKException - when the language is not found

virtual void updateNLSLanguage(const char* langCode, const char* langName);

deleteNLSLanguage
Deletes an 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

virtual void deleteNLSLanguage(const char* langCode);

retrieveNLSLanguage
Retrieves an NLS language from the 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

virtual DKString               retrieveNLSLanguage(const char* langCode);

listNLSLanguages
Lists all NLS languages defined in the datastore.

Returns: a collection of all NLS language objects 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 - if an error occurs

virtual dkCollection*           listNLSLanguages();

addNLSKeywordDesc
Adds the NLS key word description of an object to the datastore.

Parameters: langCode - the language code of the NLS language to be retrieved

Returns: the language name

virtual void addNLSKeywordDesc(const char* langCode, short sKeywordClass, long lKeywordCode, const char* szKeywordDesc);

updateNLSKeywordDesc
Updates the NLS key word description.

Parameters:

  • langCode - the language code of the NLS language being updated
  • sKeywordClass - the keyword class of the object for which the descriptions is being updated
  • lKeywordCode - the keyword code of the object for which the description is being updated
  • szKeywordDesc - keyword description of the object that will replace the old one

Throws: DKException - if an error occurs

virtual void                    updateNLSKeywordDesc(const char* langCode, short sKeywordClass, long lKeywordCode, const char* szKeywordDesc);

deleteNLSKeywordDesc
Ddeletes the NLS keyword 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 deleted
  • lKeywordCode - the keyword code of the object for which the description is to be deleted

Throws: DKException - if an error occurs

virtual void                    deleteNLSKeywordDesc(const char* langCode, short sKeywordClass, long lKeywordCode);

retrieveNLSKeywordDesc
Rretrieves the NLS key word description of an object from the datastore.

Parameters:

  • langCode - the language code of the NLS language for which the keyword description is to be retrieved
  • sKeywordClass - the keyword class of the object for which the descriptions is being retrieved
  • lKeywordCode - the keyword code of the object for which the description is to be retrieved

Throws: DKException - if an error occurs

virtual DKString                retrieveNLSKeywordDesc(const char* langCode, short sKeywordClass, long lKeywordCode);

getDefaultLanguageCode
Gets the language code of the default language from the datastore.

Returns: the language code of the default language name

Throws: DKException - if an error occurs

See Also: DKLSCfgDefICM class. (The default language is set using the setLanguageCode method in this class.)

virtual DKString                getDefaultLanguageCode();

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