|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.dkAbstractDatastoreAdmin | +--com.ibm.mm.sdk.common.DKDatastoreAdminICM
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.
DKAuthorizationMgmtICM
,
DKUserMgmtICM
,
DKConfigurationMgmtICM
,
DKWorkFlowMgmtFed
,
DKAdminDomainsMgmtICM
,
DKEventMgmtICM
,
DKMimeTypeMgmtICM
, Serialized FormFields 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 |
public DKDatastoreAdminICM(dkDatastore ds)
ds
- a reference to the datastore object.
Note: Should the connection to the datastore be already establishedMethod Detail |
public dkAuthorizationMgmt authorizationMgmt() throws DKException, java.lang.Exception
authorizationMgmt
in class dkAbstractDatastoreAdmin
DKException
- when error occursjava.lang.Exception
- when error occursDKAuthorizationMgmtICM
public dkUserManagement userManagement() throws DKException, java.lang.Exception
userManagement
in class dkAbstractDatastoreAdmin
DKException
- when error occursjava.lang.Exception
- when error occursDKUserMgmtICM
public dkConfigurationMgmt configurationManagement() throws DKException, java.lang.Exception
configurationManagement
in class dkAbstractDatastoreAdmin
DKException
- when error occursjava.lang.Exception
- when error occursDKConfigurationMgmtICM
public dkWorkFlowMgmt workFlowManagement() throws DKException, java.lang.Exception
workFlowManagement
in class dkAbstractDatastoreAdmin
DKException
- when error occursjava.lang.Exception
- when error occursDKWorkFlowMgmtFed
public dkAdminDomainsMgmt adminDomainsMgmt() throws DKException, java.lang.Exception
adminDomainsMgmt
in class dkAbstractDatastoreAdmin
DKException
- when error occursjava.lang.Exception
- when error occursDKAdminDomainsMgmtICM
public DKEventMgmtICM eventManagement() throws DKException, java.lang.Exception
DKException
- when error occursjava.lang.Exception
- when error occursDKEventMgmtICM
public DKMimeTypeMgmtICM mimeTypeMgmt() throws DKException, java.lang.Exception
DKException
- when error occursjava.lang.Exception
- when error occursDKMimeTypeMgmtICM
public void addNLSLanguage(java.lang.String langCode, java.lang.String langName) throws DKException, java.lang.Exception
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.DKException
- when error occursjava.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.public void updateNLSLanguage(java.lang.String langCode, java.lang.String langName) throws DKException, java.lang.Exception
langCode
- - the language code of the NLS language to be updated.langName
- - updated new language name.DKException
- when language is not foundjava.lang.Exception
- when error occurspublic void deleteNLSLanguage(java.lang.String langCode) throws DKException, java.lang.Exception
langCode
- -- the language code of the NLS language to be deleted.DKException
- when the language is not foundjava.lang.Exception
- when error occurspublic java.lang.String retrieveNLSLanguage(java.lang.String langCode) throws DKException, java.lang.Exception
langCode
- - the language code of the NLS language to be retrievedDKException
- when the language is not foundjava.lang.Exception
- when error occurspublic dkCollection listNLSLanguages() throws DKException, java.lang.Exception
DKException
- when error occursjava.lang.Exception
- when error occurspublic void addNLSKeywordDesc(java.lang.String langCode, short sKeywordClass, long lKeywordCode, java.lang.String szKeywordDesc) throws DKException, java.rmi.RemoteException, java.lang.Exception
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 addedszKeywordDesc
- -- the keyword description of the object.DKException
- when error occursjava.lang.Exception
- when error occursjava.rmi.RemoteException
- when error occurspublic void updateNLSKeywordDesc(java.lang.String langCode, short sKeywordClass, long lKeywordCode, java.lang.String szKeywordDesc) throws DKException, java.rmi.RemoteException, java.lang.Exception
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 codeszKeywordDesc
- - the key word descriptionthe new keyword description of the object
that will replace the old one.DKException
- when error occursjava.lang.Exception
- when error occursjava.rmi.RemoteException
- when error occurspublic void deleteNLSKeywordDesc(java.lang.String langCode, short sKeywordClass, long lKeywordCode) throws DKException, java.rmi.RemoteException, java.lang.Exception
langCode
- - the language code of the NLS language for which the keyword description is to be deletedsKeywordClass
- - 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 deletedDKException
- when error occursjava.lang.Exception
- when error occursjava.rmi.RemoteException
- when error occurspublic java.lang.String retrieveNLSKeywordDesc(java.lang.String langCode, short sKeywordClass, long lKeywordCode) throws DKException, java.rmi.RemoteException, java.lang.Exception
langCode
- -- the language code of the NLS languagesKeywordClass
- -- the keyword class class that the object is belonging tolKeywordCode
- -- the keyword code of the object.DKException
- when error occursjava.lang.Exception
- when error occursjava.rmi.RemoteException
- when error occurspublic java.util.Vector listNLSKeywordDesc(java.lang.String langCode, short sKeywordClass) throws DKException, java.rmi.RemoteException, java.lang.Exception
langCode
- -- the language code of the NLS languagesKeywordClass
- -- the keyword classDKException
- when error occursjava.lang.Exception
- when error occursjava.rmi.RemoteException
- when error occurspublic java.lang.String getDefaultLanguageCode() throws DKException, java.rmi.RemoteException, java.lang.Exception
DKException
- when error occursjava.lang.Exception
- when error occursjava.rmi.RemoteException
- when error occursclass .
public java.lang.String[] listClientExitNames() throws DKException, java.lang.Exception
DKException
- when error occursjava.lang.Exception
- when error occurspublic dkCollection listClientExits() throws DKException, java.rmi.RemoteException, java.lang.Exception
DKException
- when error occursjava.rmi.RemoteException
- when error occursjava.lang.Exception
- when error occursDKClientExitDefICM
public dkCollection listClientExitsForItemType(java.lang.String itemTypeName) throws DKException, java.rmi.RemoteException, java.lang.Exception
itemTypeName
- the name of the item type for which the client exits are to be listedDKException
- when error occursjava.rmi.RemoteException
- when error occursjava.lang.Exception
- when error occursDKClientExitDefICM
public dkCollection listClientExitsForItemType(int itemTypeID) throws DKException, java.rmi.RemoteException, java.lang.Exception
itemTypeID
- the id of the item type for which the client exits are to be listedDKException
- when error occursjava.rmi.RemoteException
- when error occursjava.lang.Exception
- when error occursDKClientExitDefICM
public dkCollection listClientExitsForItemTypeView(java.lang.String itemTypeViewName) throws DKException, java.rmi.RemoteException, java.lang.Exception
itemTypeViewName
- the name of the item type view for which the client exits are to be listedDKException
- when error occursjava.rmi.RemoteException
- when error occursjava.lang.Exception
- when error occursDKClientExitDefICM
public dkCollection listClientExitsForItemTypeView(int itemTypeViewID) throws DKException, java.rmi.RemoteException, java.lang.Exception
itemTypeID
- the id of the item type view for which the client exits are to be listedDKException
- when error occursjava.rmi.RemoteException
- when error occursjava.lang.Exception
- when error occurspublic DKClientExitDefICM retrieveClientExit(java.lang.String exitName) throws DKException, java.rmi.RemoteException, java.lang.Exception
exitName
- the name of the client exit object for which the client exits object is to be retrievedDKException
- when error occursjava.rmi.RemoteException
- when error occursjava.lang.Exception
- when error occursDKClientExitDefICM
public void addClientExit(DKClientExitDefICM exitObj) throws DKException, java.rmi.RemoteException, java.lang.Exception
exitObj
- the given client exit objectDKException
- when error occursjava.rmi.RemoteException
- when error occursjava.lang.Exception
- when error occursDKClientExitDefICM
public void updateClientExit(DKClientExitDefICM exitObj) throws DKException, java.rmi.RemoteException, java.lang.Exception
exitObj
- the given client exit objectDKException
- when error occursjava.rmi.RemoteException
- when error occursjava.lang.Exception
- when error occursDKClientExitDefICM
public void delClientExit(DKClientExitDefICM exitObj) throws DKException, java.rmi.RemoteException, java.lang.Exception
exitObj
- the given client exit object.DKException
- when error occursjava.rmi.RemoteException
- when error occursjava.lang.Exception
- when error occurs
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |