|
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.beans.CMBDataManagement
The CMBDataManagement bean provides EIP data manipulation functions. This includes creating, retrieving, updating, and deleting document and folder contents, as well as associated annotations. It also includes checkin/checkout/unlock functions on data items.
To use this Bean:
setDataObject
. This method requires
an instance of CMBItem, which can be obtained from other beans such as CMBSearchResults,
or created from scratch (in the case of a create function).
CMBDataExitEvents are also issued before and after each data update.
Summary of properties and events:
imported properties traceEnabled, defaulting off, will not veto exported properties none standalone properties none interested in events CMBSConnectionReplyEvent - to get connection handle CMBDataRequestEvent - to perform functions PropertyChangeEvent - to import traceEnabled source of events CMBDataReplyEvent - to reply the request CMBDataExitEvent - to be implemented +++ CMBExceptionEvent - to post exception CMBTraceEvent - to let logger trace
CMBConnection
,
CMBSearchResults
,
CMBDataExitEvent
, Serialized FormConstructor Summary | |
CMBDataManagement()
Default constructor. |
Method Summary | |
void |
addAnnotation(CMBAnnotation obj)
Adds a new annotation to current item at the end of annotation list. |
void |
addCMBDataExitListener(CMBDataExitListener listener)
CMBDataExitEvent registration method. |
void |
addCMBDataReplyListener(CMBDataReplyListener listener)
CMBDataReplyEvent registration method. |
void |
addCMBExceptionListener(CMBExceptionListener listener)
CMBExceptionEvent registration method. |
void |
addCMBTraceListener(CMBTraceListener listener)
CMBTraceEvent registration method. |
void |
addContent(CMBObject obj)
Adds a new content part to the current document at the end of the parts list. |
void |
addLink(CMBItem item,
java.lang.String linkType)
for ICM only add a out bound link, and the linked to item to the current item optionally create the link if there is not one. |
void |
addNoteLog(CMBObject obj)
Adds a new note log object to current document. |
void |
addViewData(CMBViewData viewDataObj)
Adds new view data object to current document; for OnDemand documents only. |
void |
checkIn()
Checks the current document back into the content server. |
void |
checkOut()
Checks the current document out from depository source in the content server. |
void |
createItem(java.lang.String entityName)
Creates a new item and puts it in the given entity name on the server. |
void |
createResourceItem(java.lang.String className,
java.lang.String entityName)
Creates a new resource item and puts it in the given entity name on the server. |
void |
deleteAnnotation(int index)
Deletes the annotation at the specified location. |
void |
deleteContent(int index)
Deletes the part at the specified location. |
void |
deleteItem()
Deletes this item from the server. |
void |
deleteNoteLog(int index)
Deletes the noteLog at the specified location. |
void |
deleteViewData(int index)
Deletes a view data object at given index. |
CMBItem[] |
getAllVersions()
Gets all versions of the current item. |
CMBAnnotation[] |
getAnnotation()
Deprecated. Use getAnnotations instead |
CMBAnnotation |
getAnnotation(int index)
Gets a specific annotation from the current item by index. |
int |
getAnnotationCount()
Gets thre number of annotations in the current document. |
CMBAnnotation[] |
getAnnotations()
Gets all the annotations from the current item. |
CMBConnection |
getConnection()
Gets the connection bean reference. |
CMBObject[] |
getContent()
Gets all the content objects from the current item. |
CMBObject |
getContent(int index)
Gets the specified content object from the current item. |
CMBObject |
getContentById(java.lang.String contentID)
Gets CMBObject for the given content PID string |
CMBObject |
getContentByUniqueName(java.lang.String contentName)
Gets CMBObject for the given content PID string. |
int |
getContentCount()
Gets number of content parts for this given document. |
java.lang.String |
getContentID(int index)
Gets content ID at given index |
CMBDataExitEvent |
getDataExitEvent()
Returns the data exit event. |
CMBItem |
getDataObject()
Gets the data object. |
CMBDataReplyEvent |
getDataReplyEvent()
Returns the data reply event. |
CMBExceptionEvent |
getExceptionEvent()
Returns the exception event. |
CMBFixedViewData |
getFixedViewData()
Gets a reference to CMBFixedViewData object; for OnDemand documents only. |
CMBItem[] |
getInboundLinks(java.lang.String linkType)
ICM only must call dataitem.setRetrieved(false); and dataBean.setRetrieveLinks(true); before calling this method. |
java.lang.String |
getItemMimeType()
Gets the mime content type for the item. |
short |
getItemType()
Gets the item type for the current item. |
CMBItem[] |
getLinks(java.lang.String linkType)
ICM only must call dataitem.setRetrieved(false); and dataBean.setRetrieveLinks(true); before calling this method. |
java.lang.String |
getLockedBy()
Gets the user ID that has checked out the current document from the content server. |
CMBObject |
getNoteLog(int index)
Gets a CMBObject for the note log for a particular item. |
int |
getNoteLogCount()
Gets the number of note logs for the current item. |
CMBObject[] |
getNoteLogs()
Gets an array of CMBObjects for note logs on the current item. |
CMBPrivilege |
getPrivilege()
Gets the privileges for current document. |
CMBResources |
getResources()
Gets reference to CMBResources object; for OnDemand documents only. |
CMBTraceEvent |
getTraceEvent()
Returns the trace event. |
CMBItem |
getUnMappedItem(CMBItem mappedItem)
Gets an unmapped item from the given mapped item. |
CMBViewData[] |
getViewData()
Gets reference to CMBViewData object; for OnDemand documents only. |
CMBViewData |
getViewData(int index)
Gets a particular logical view data by index. |
boolean |
isCheckedOut()
Checks if current document is checked out from the content server. |
boolean |
isRetrieveAttributes()
Returns whether retrieval of item attributes has been enabled. |
boolean |
isRetrieveChildren()
Returns whether retrieval of item children has been enabled. |
boolean |
isRetrieveInBoundLinks()
Returns whether retrieval of items has been enabled. |
boolean |
isRetrieveItemTree()
Returns whether retrieval of the whole item tree hierarchy, including retrieving the children and their contents, has been enabled. |
boolean |
isRetrieveLinks()
Returns whether retrieval of out bound linked items has been enabled. |
boolean |
isSupported(java.lang.String methodName)
Checks to see if the method is supported by the content server. |
boolean |
isSupported(java.lang.String methodName,
java.lang.String serverName,
java.lang.String serverType)
Checks to see if the method is supported by the content server. |
boolean |
isTraceEnabled()
Returns whether trace is enabled. |
void |
onCMBConnectionReply(CMBConnectionReplyEvent evt)
Implementation of connection reply service method: update the connection handle accordingly. |
void |
onCMBDataRequest(CMBDataRequestEvent evt)
Implementation of Data request service method: perform the requested function. |
void |
propertyChange(java.beans.PropertyChangeEvent evt)
On a property change, imports the traceEnabled property value. |
void |
reindexItem()
Moves this item from current entity to a new entity. |
void |
reindexItem(java.lang.String newEntityName)
Moves this item from current entity to a new entity. |
void |
removeCMBDataExitListener(CMBDataExitListener listener)
CMBDataExitEvent unregistration method. |
void |
removeCMBDataReplyListener(CMBDataReplyListener listener)
CMBDataReplyEvent unregistration method. |
void |
removeCMBExceptionListener(CMBExceptionListener listener)
CMBExceptionEvent unregistration method. |
void |
removeCMBTraceListener(CMBTraceListener listener)
CMBTraceEvent unregistration method. |
void |
removeLink(CMBItem item,
java.lang.String linkType)
ICM only |
void |
retrieveItem()
Retrieves the latest version of the current item from the server. |
void |
retrieveItem(int version)
Retrieves the current item from the server. |
void |
setConnection(CMBConnection conn)
Sets the reference of connection bean. |
void |
setDataObject(CMBItem dataObject)
Sets the data object. |
void |
setEntityName(java.lang.String entityName)
Sets the new entityName for the current item. |
void |
setRetrieveAttributes(boolean newValue)
Sets whether retrieval of item attributes is enabled. |
void |
setRetrieveChildren(boolean newValue)
Sets whether retrieval of item children is enabled. |
void |
setRetrieveInBoundLinks(boolean newValue)
Sets whether retrieval of item links is enabled. |
void |
setRetrieveItemTree(boolean newValue)
Sets whether retrieval of the whole item tree hierarchy, including retrieving the children and their contents, is enabled. |
void |
setRetrieveLinks(boolean newValue)
Sets whether retrieval of outbound item links is enabled. |
void |
setTraceEnabled(boolean newValue)
Sets whether trace is enabled or not. |
void |
unindexItem()
Removes this item from current entity but do not delete it. |
void |
unlock()
Unlocks the current document from the previous checkout. |
void |
updateAnnotation(int index,
CMBAnnotation obj)
Updates the specified annotation for the current item. |
void |
updateContent(int index,
CMBObject obj)
Updates the specified content for the current item. |
void |
updateItem()
Updates the attribute values of the current item. |
void |
updateItem(int version)
Updates the attribute values of the current item. |
void |
updateNoteLog(int index,
CMBObject obj)
Updates the specified notelog for the current item. |
void |
updateViewData(int index,
CMBViewData viewDataObj)
Updates the given index view data object; for OnDemand documents only. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public CMBDataManagement()
Method Detail |
public void onCMBConnectionReply(CMBConnectionReplyEvent evt)
onCMBConnectionReply
in interface CMBConnectionReplyListener
evt
- a CMBConnectionReplyEventpublic void onCMBDataRequest(CMBDataRequestEvent evt)
onCMBDataRequest
in interface CMBDataRequestListener
evt
- a CMBDataRequestEventpublic void propertyChange(java.beans.PropertyChangeEvent evt)
propertyChange
in interface java.beans.PropertyChangeListener
evt
- a property changed eventpublic void addCMBExceptionListener(CMBExceptionListener listener)
listener
- listener to be registeredpublic void removeCMBExceptionListener(CMBExceptionListener listener)
listener
- listener to be unregisteredpublic void addCMBTraceListener(CMBTraceListener listener)
listener
- listener to be registeredpublic void removeCMBTraceListener(CMBTraceListener listener)
listener
- listener to be unregisteredpublic void addCMBDataReplyListener(CMBDataReplyListener listener)
listener
- listener to be registeredpublic void removeCMBDataReplyListener(CMBDataReplyListener listener)
listener
- listener to be unregisteredpublic void addCMBDataExitListener(CMBDataExitListener listener)
listener
- listener to be registeredpublic void removeCMBDataExitListener(CMBDataExitListener listener)
listener
- listener to be unregisteredpublic boolean isTraceEnabled()
public void setTraceEnabled(boolean newValue)
newValue
- new traceEnabled property valuepublic boolean isRetrieveAttributes()
public void setRetrieveAttributes(boolean newValue)
newValue
- new retrieveAttributes property valuepublic boolean isRetrieveChildren()
public void setRetrieveChildren(boolean newValue)
newValue
- new retrieveChildren property valuepublic boolean isRetrieveInBoundLinks()
public void setRetrieveInBoundLinks(boolean newValue)
newValue
- new retrieveLinks propertyvaluepublic boolean isRetrieveLinks()
public void setRetrieveLinks(boolean newValue)
newValue
- new retrieveLinks propertyvaluepublic boolean isRetrieveItemTree()
public void setRetrieveItemTree(boolean newValue)
newValue
- new retrieveLinks propertyvaluepublic void setConnection(CMBConnection conn)
conn
- reference of connection beanpublic CMBConnection getConnection()
public short getItemType() throws CMBItemNotSetException, CMBNoConnectionException, CMBException
public void setDataObject(CMBItem dataObject)
dataObject
- reference to CMBItem objectpublic CMBItem getDataObject()
public void createItem(java.lang.String entityName) throws CMBItemNotSetException, CMBNoConnectionException, CMBException
entityName
- entity name. For Fed, this is of the form FedEntityName;ServerName;NativeEntityNameCMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void createResourceItem(java.lang.String className, java.lang.String entityName) throws CMBItemNotSetException, CMBNoConnectionException, CMBException
className
- The class name of the resource item class. This is a subclass of
DKLobICM.entityName
- entity nameCMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void updateItem() throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in updating the item on the content server.
Call CMBException.getErrorData() to get the original exception object.public void updateItem(int version) throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBException
version
- May be one of the following:
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in updating the item on the content server.
Call CMBException.getErrorData() to get the original exception object.public void reindexItem() throws CMBItemNotSetException, CMBNoConnectionException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void reindexItem(java.lang.String newEntityName) throws CMBItemNotSetException, CMBNoConnectionException, CMBException
newEntityName
- name of the new entity this item will be moved toCMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void unindexItem() throws CMBItemNotSetException, CMBNoConnectionException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void deleteItem() throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void retrieveItem() throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBServerAccessErrorException, CMBConnectFailedException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if:
CMBConnectFailedException
- if
CMBServerAccessErrorException
- if unable to get access to the server.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void retrieveItem(int version) throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBServerAccessErrorException, CMBConnectFailedException, CMBException
int
- version The version of the item to retrieveCMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if:
CMBConnectFailedException
- if
CMBServerAccessErrorException
- if unable to get access to the server.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void setEntityName(java.lang.String entityName)
entityName
- new entity namepublic CMBObject[] getContent() throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public CMBObject getContent(int index) throws CMBItemNotSetException, CMBItemNotExistException, java.lang.ArrayIndexOutOfBoundsException, CMBNoConnectionException, CMBException
index
- content indexCMBItemNotSetException
- if the data object is not setCMBItemNotExistException
- if the item does not exist on the content server.java.lang.ArrayIndexOutOfBoundsException
- if index is invalidCMBNoConnectionException
- if CMBConnection bean is not set.
You need to call setConnection() before calling this method.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public java.lang.String getContentID(int index) throws CMBItemNotSetException, CMBItemNotExistException, java.lang.ArrayIndexOutOfBoundsException, CMBNoConnectionException, CMBException
index
- content indexjava.lang.ArrayIndexOutOfBoundsException
- if index is invalidCMBItemNotSetException
- if there is not an item currently set.
Call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set.
Call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public CMBObject getContentById(java.lang.String contentID) throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBException
contentID
- content PID stringCMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public int getContentCount() throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public CMBObject getContentByUniqueName(java.lang.String contentName) throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBException
contentName
- content unique nameCMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void deleteContent(int index) throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, java.lang.ArrayIndexOutOfBoundsException, CMBException
index
- part locationjava.lang.ArrayIndexOutOfBoundsException
- if index is invalid.CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void updateContent(int index, CMBObject obj) throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBException
index
- content locationobj
- updated content objectjava.lang.ArrayIndexOutOfBoundsException
- if index is invalid.CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void addContent(CMBObject obj) throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBException
createItem()
call is performed.obj
- CMBObject for new content partCMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public CMBAnnotation[] getAnnotation() throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBException
public CMBAnnotation[] getAnnotations() throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public java.lang.String getItemMimeType() throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public CMBAnnotation getAnnotation(int index) throws CMBItemNotSetException, CMBItemNotExistException, java.lang.ArrayIndexOutOfBoundsException, CMBNoConnectionException, CMBException
index
- annotation indexjava.lang.ArrayIndexOutOfBoundsException
- if index is invalid.CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public int getAnnotationCount() throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void addAnnotation(CMBAnnotation obj) throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBException
obj
- new annotation objectCMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void updateAnnotation(int index, CMBAnnotation obj) throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBException
index
- annotation locationobj
- annotation object to be updatedjava.lang.ArrayIndexOutOfBoundsException
- if index is invalid.CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void deleteAnnotation(int index) throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, java.lang.ArrayIndexOutOfBoundsException, CMBException
index
- annotation locationjava.lang.ArrayIndexOutOfBoundsException
- if index is invalid.CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public CMBObject[] getNoteLogs() throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public CMBObject getNoteLog(int index) throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, java.lang.ArrayIndexOutOfBoundsException, CMBException
index
- the item indexCMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.java.lang.ArrayIndexOutOfBoundsException
- if the index parameter is out of the array bounds.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public int getNoteLogCount() throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBException
If there are no notes or if notes are not supported on the platform, the method returns 0.
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void updateNoteLog(int index, CMBObject obj) throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBException
index
- notelog locationobj
- updated notelog objectjava.lang.ArrayIndexOutOfBoundsException
- if index is invalid.CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void deleteNoteLog(int index) throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, java.lang.ArrayIndexOutOfBoundsException, CMBException
index
- noteLog locationjava.lang.ArrayIndexOutOfBoundsException
- if index is invalid.CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void addNoteLog(CMBObject obj) throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public CMBResources getResources() throws CMBItemNotSetException, CMBItemNotExistException, CMBMethodNotSupportedException, CMBNoConnectionException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBMethodNotSupportedException
- if current item is not an OnDemand document.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public CMBFixedViewData getFixedViewData() throws CMBItemNotSetException, CMBItemNotExistException, CMBMethodNotSupportedException, CMBNoConnectionException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBMethodNotSupportedException
- if current item is not an OnDemand document.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public CMBViewData[] getViewData() throws CMBItemNotSetException, CMBItemNotExistException, CMBMethodNotSupportedException, CMBNoConnectionException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBMethodNotSupportedException
- if current item is not an OnDemand document.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public CMBViewData getViewData(int index) throws CMBItemNotSetException, CMBMethodNotSupportedException, CMBNoConnectionException, java.lang.ArrayIndexOutOfBoundsException, CMBException
index
- view data indexjava.lang.ArrayIndexOutOfBoundsException
- if index is invalidCMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBMethodNotSupportedException
- if current item is not an OnDemand document.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void addViewData(CMBViewData viewDataObj) throws CMBItemNotSetException, CMBItemNotExistException, CMBMethodNotSupportedException, CMBNoConnectionException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBMethodNotSupportedException
- if current item is not an OnDemand document.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void updateViewData(int index, CMBViewData viewDataObj) throws CMBItemNotSetException, CMBItemNotExistException, CMBMethodNotSupportedException, CMBNoConnectionException, CMBException, java.lang.ArrayIndexOutOfBoundsException
index
- view data indexviewDataObj
- updated view data objectjava.lang.ArrayIndexOutOfBoundsException
- if index is invalidCMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBMethodNotSupportedException
- if current item is not an OnDemand document.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void deleteViewData(int index) throws CMBItemNotSetException, CMBItemNotExistException, CMBMethodNotSupportedException, CMBNoConnectionException, CMBException, java.lang.ArrayIndexOutOfBoundsException
index
- view data index to be deletedjava.lang.ArrayIndexOutOfBoundsException
- if index is invalidCMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBMethodNotSupportedException
- if current item is not an OnDemand document.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public CMBPrivilege getPrivilege() throws CMBItemNotSetException, CMBItemNotExistException, CMBNoConnectionException, CMBServerAccessErrorException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBServerAccessErrorException
- if unable to access this function from content server.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public CMBItem[] getAllVersions() throws CMBConnectFailedException, CMBItemNotSetException, CMBItemNotExistException, CMBMethodNotSupportedException, CMBNoConnectionException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBMethodNotSupportedException
- if this function is not currently supported by this content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred on the server or the item is in an
invalid entity. Call CMBException.getErrorData() to get the original exception object.public void checkIn() throws CMBItemNotSetException, CMBItemNotExistException, CMBMethodNotSupportedException, CMBNoConnectionException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBMethodNotSupportedException
- if this function is not currently supported by this content server.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void checkOut() throws CMBItemNotSetException, CMBItemNotExistException, CMBMethodNotSupportedException, CMBNoConnectionException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBMethodNotSupportedException
- if this function is not currently supported by this content server.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public boolean isCheckedOut() throws CMBItemNotSetException, CMBItemNotExistException, CMBMethodNotSupportedException, CMBNoConnectionException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBMethodNotSupportedException
- if this function is not currently supported by this content server.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public void unlock() throws CMBItemNotSetException, CMBItemNotExistException, CMBMethodNotSupportedException, CMBNoConnectionException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBMethodNotSupportedException
- if this function is not currently supported by this content server.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public java.lang.String getLockedBy() throws CMBItemNotSetException, CMBItemNotExistException, CMBMethodNotSupportedException, CMBNoConnectionException, CMBException
CMBItemNotSetException
- if there is not an item currently set. Please
call setDataObject() method before calling any methods in this Bean.CMBItemNotExistException
- if the current item does not exist on the content server.CMBNoConnectionException
- if there is no CMBConnection bean set. Please
call setConnection() before calling any methods in this Bean.CMBMethodNotSupportedException
- if this function is not currently supported by this content server.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public CMBItem getUnMappedItem(CMBItem mappedItem) throws CMBNoConnectionException, CMBException
mappedItem
- item with mapped (federated) propertiesCMBNoConnectionException
- if there is no CMBConnection bean set.
Call setConnection() before calling any methods in this Bean.CMBException
- if an error occurred in the content server.
Call CMBException.getErrorData() to get the original exception object.public boolean isSupported(java.lang.String methodName) throws CMBNoConnectionException, CMBException
methodName
- name of method to check for. Valid method names are:
CMBNoConnectionException
- if there is no current connection to
the server.CMBException
- if there is any other error occurs.public boolean isSupported(java.lang.String methodName, java.lang.String serverName, java.lang.String serverType) throws CMBNoConnectionException, CMBException
methodName
- name of method to check for. Valid method names are:
serverName
- the name of the content serverCMBNoConnectionException
- if there is no current connection to
the server.CMBException
- if there is any other error occurs.public CMBTraceEvent getTraceEvent()
public CMBExceptionEvent getExceptionEvent()
public CMBDataReplyEvent getDataReplyEvent()
public CMBDataExitEvent getDataExitEvent()
public CMBItem[] getInboundLinks(java.lang.String linkType) throws CMBException
public CMBItem[] getLinks(java.lang.String linkType) throws CMBException
public void addLink(CMBItem item, java.lang.String linkType) throws CMBException
public void removeLink(CMBItem item, java.lang.String linkType) throws CMBException
find the link which links the dataobject and the item object (outbound link), then delete the link. the destination item is not deleted.
retrieve options must be specified to retrieve source item and the links, otherwise the link can not be deleted.
dataManagement.setDataObject(sourceItem);
dataManagement.setRetrieveLinks(true);
dataManagement.removeLink(destItem,linktype);
|
EIP JavaBeans | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |