Enterprise Information Portal APIs

com.ibm.mm.beans
Class CMBDataManagement

java.lang.Object
  |
  +--com.ibm.mm.beans.CMBDataManagement
All Implemented Interfaces:
CMBBaseConstant, CMBConnectionReplyListener, CMBDataRequestListener, java.util.EventListener, java.beans.PropertyChangeListener, java.io.Serializable

public class CMBDataManagement
extends java.lang.Object
implements java.io.Serializable, java.beans.PropertyChangeListener, CMBConnectionReplyListener, CMBDataRequestListener, CMBBaseConstant

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:

  1. Set the current data item using 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).
  2. Invoke other methods to create, retrieve, update, delete or checkin, checkout, unlock the data item.
An alternative method of using this Bean is through events. A CMBDataRequestEvent can be created and supplied to this Bean (which implements CMBDataRequestListener). The bean will then fire a CMBDataReplyEvent to provide the response. When used in this fashion, any exceptions will fire CMBExceptionEvents.

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
 

Since:
6.1
See Also:
CMBConnection, CMBSearchResults, CMBDataExitEvent, Serialized Form

Fields inherited from interface com.ibm.mm.beans.CMBBaseConstant
ANNOTATION_MIME_TYPE, CMB_CLASS_ICM_DOC_MODEL, CMB_CLASS_ICM_DOC_PART, CMB_CLASS_ITEM, CMB_CLASS_RESOURCE_ITEM, CMB_CLASS_UNDEFINED, CMB_CONNTYPE_DYNAMIC, CMB_CONNTYPE_LOCAL, CMB_CONNTYPE_REMOTE, CMB_CONTENT_ATTRONLY, CMB_CONTENT_CHILDREN, CMB_CONTENT_ITEMTREE, CMB_CONTENT_LINKS_INBOUND, CMB_CONTENT_LINKS_OUTBOUND, CMB_CONTENT_YES, CMB_DATATYPE_COLLECTION, CMB_DATATYPE_COLLECTION_DDO, CMB_DATATYPE_COLLECTION_XDO, CMB_DATATYPE_DATAOBJECTBASE, CMB_DATATYPE_DATE, CMB_DATATYPE_DECIMAL, CMB_DATATYPE_DOUBLE, CMB_DATATYPE_FLOAT, CMB_DATATYPE_FSTRING, CMB_DATATYPE_ITEM, CMB_DATATYPE_ITEM_COLLECTION, CMB_DATATYPE_LONG, CMB_DATATYPE_OBJECT, CMB_DATATYPE_OBJECT_COLLECTION, CMB_DATATYPE_SHORT, CMB_DATATYPE_TIME, CMB_DATATYPE_TIMESTAMP, CMB_DATATYPE_UNDEFINED, CMB_DATATYPE_VSTRING, CMB_DSTYPE_CM, CMB_DSTYPE_DB2, CMB_DSTYPE_DES, CMB_DSTYPE_DJ, CMB_DSTYPE_DL, CMB_DSTYPE_DOMDOC, CMB_DSTYPE_FED, CMB_DSTYPE_FN, CMB_DSTYPE_IC, CMB_DSTYPE_ICM, CMB_DSTYPE_IP390, CMB_DSTYPE_JDBC, CMB_DSTYPE_OD, CMB_DSTYPE_VI400, CMB_EIP_LOGOUT, CMB_OBJTYPE_CMBITEM, CMB_OBJTYPE_CMBOBJECT, CMB_OP_AND, CMB_OP_BETWEEN, CMB_OP_CONTAINS_TEXT, CMB_OP_CONTAINS_TEXT_IN_CONTENT, CMB_OP_EQUAL, CMB_OP_GREATER, CMB_OP_GREATER_EQUAL, CMB_OP_IN, CMB_OP_LESS, CMB_OP_LESS_EQUAL, CMB_OP_LIKE, CMB_OP_NOT, CMB_OP_NOT_BETWEEN, CMB_OP_NOT_EQUAL, CMB_OP_NOT_IN, CMB_OP_NOT_LIKE, CMB_OP_OR, CMB_OP_UNDEFINED, CMB_QS_TYPE_COMBINED, CMB_QS_TYPE_DES, CMB_QS_TYPE_FEDERATED, CMB_QS_TYPE_IMAGE, CMB_QS_TYPE_PARAMETRIC, CMB_QS_TYPE_SQL, CMB_QS_TYPE_TEMPLATE, CMB_QS_TYPE_TEXT, CMB_QS_TYPE_UNKNOWN, CMB_QS_TYPE_XPATH, CMB_ST_SKIP_ALWAYS, CMB_ST_SKIP_NEVER, CMB_ST_SKIP_WITH_PROMPT, CMB_STATUS_FAILED, CMB_STATUS_OK, CMB_STATUS_RESULT_END, CMB_STATUS_RESULT_MORE, CMB_STATUS_RESULT_NEW, CMB_TIMESTAMP_UNDEFINED, CMB_TYPE_DOCUMENT, CMB_TYPE_FOLDER, CMB_TYPE_ITEM, CMB_TYPE_UNKNOWN, CMB_USERID_UNDEFINED, CMB_VERSION_CONTROL_ALWAYS_NEW, CMB_VERSION_CONTROL_BY_APP, CMB_VERSION_CONTROL_NEVER, CMB_VERSION_KEYWORD, CMB_VERSION_LATEST, CMB_VERSION_NEW, PROP_CACHE_ENABLED, PROP_CC2MIME_URL, PROP_CONNECTION, PROP_CONNECTION_TYPE, PROP_DATA_MANAGEMENT_ENABLED, PROP_DSTYPE, PROP_LOCAL_SERVER, PROP_NAME, PROP_NEW_PASSWORD, PROP_PASSWORD, PROP_PORT_NUMBER, PROP_QUERY_CALLBACK_THRESHOLD, PROP_QUERY_MAX_RESULTS, PROP_RESULT_PAGESIZE, PROP_RMI_HOSTNAME, PROP_SCHEMA_MANAGEMENT_ENABLED, PROP_SEARCH_ASYNCH, PROP_SEARCH_MULTI_CHARS_WILDCARD, PROP_SEARCH_PARAMETRIC_WILDCARD, PROP_SEARCH_SINGLE_CHAR_WILDCARD, PROP_SEARCH_SKIP_SERVER, PROP_SEARCH_TIMEOUT, PROP_SERVER_NAME, PROP_SV_CONNECTION_TYPE, PROP_SV_PORT_NUMBER, PROP_SV_RMI_HOSTNAME, PROP_TRACE_ENABLED, PROP_USERID
 
Constructor 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

CMBDataManagement

public CMBDataManagement()
Default constructor.
Method Detail

onCMBConnectionReply

public void onCMBConnectionReply(CMBConnectionReplyEvent evt)
Implementation of connection reply service method: update the connection handle accordingly.
Specified by:
onCMBConnectionReply in interface CMBConnectionReplyListener
Parameters:
evt - a CMBConnectionReplyEvent

onCMBDataRequest

public void onCMBDataRequest(CMBDataRequestEvent evt)
Implementation of Data request service method: perform the requested function. This method fires a CMBDataReplyEvent.
Specified by:
onCMBDataRequest in interface CMBDataRequestListener
Parameters:
evt - a CMBDataRequestEvent

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)
On a property change, imports the traceEnabled property value.
Specified by:
propertyChange in interface java.beans.PropertyChangeListener
Parameters:
evt - a property changed event

addCMBExceptionListener

public void addCMBExceptionListener(CMBExceptionListener listener)
CMBExceptionEvent registration method. It ignores a registration request if the listener is already registered.
Parameters:
listener - listener to be registered

removeCMBExceptionListener

public void removeCMBExceptionListener(CMBExceptionListener listener)
CMBExceptionEvent unregistration method.
Parameters:
listener - listener to be unregistered

addCMBTraceListener

public void addCMBTraceListener(CMBTraceListener listener)
CMBTraceEvent registration method. It ignores a registration request if the listener is already registered.
Parameters:
listener - listener to be registered

removeCMBTraceListener

public void removeCMBTraceListener(CMBTraceListener listener)
CMBTraceEvent unregistration method.
Parameters:
listener - listener to be unregistered

addCMBDataReplyListener

public void addCMBDataReplyListener(CMBDataReplyListener listener)
CMBDataReplyEvent registration method. It ignores a registration request if the listener is already registered.
Parameters:
listener - listener to be registered

removeCMBDataReplyListener

public void removeCMBDataReplyListener(CMBDataReplyListener listener)
CMBDataReplyEvent unregistration method.
Parameters:
listener - listener to be unregistered

addCMBDataExitListener

public void addCMBDataExitListener(CMBDataExitListener listener)
CMBDataExitEvent registration method. It ignores a registration request if the listener is already registered.
Parameters:
listener - listener to be registered

removeCMBDataExitListener

public void removeCMBDataExitListener(CMBDataExitListener listener)
CMBDataExitEvent unregistration method.
Parameters:
listener - listener to be unregistered

isTraceEnabled

public boolean isTraceEnabled()
Returns whether trace is enabled.
Returns:
traceEnabled property value

setTraceEnabled

public void setTraceEnabled(boolean newValue)
Sets whether trace is enabled or not.
Parameters:
newValue - new traceEnabled property value

isRetrieveAttributes

public boolean isRetrieveAttributes()
Returns whether retrieval of item attributes has been enabled.
Returns:
retrieveAttributes property value
Since:
8.1

setRetrieveAttributes

public void setRetrieveAttributes(boolean newValue)
Sets whether retrieval of item attributes is enabled.
Parameters:
newValue - new retrieveAttributes property value
Since:
8.1

isRetrieveChildren

public boolean isRetrieveChildren()
Returns whether retrieval of item children has been enabled.
Returns:
retrieveChildren property value
Since:
8.1

setRetrieveChildren

public void setRetrieveChildren(boolean newValue)
Sets whether retrieval of item children is enabled.
Parameters:
newValue - new retrieveChildren property value
Since:
8.1

isRetrieveInBoundLinks

public boolean isRetrieveInBoundLinks()
Returns whether retrieval of items has been enabled.
Returns:
retrieveLinks property value
Since:
8.1

setRetrieveInBoundLinks

public void setRetrieveInBoundLinks(boolean newValue)
Sets whether retrieval of item links is enabled.
Parameters:
newValue - new retrieveLinks propertyvalue
Since:
8.1

isRetrieveLinks

public boolean isRetrieveLinks()
Returns whether retrieval of out bound linked items has been enabled.
Returns:
retrieveLinks property value
Since:
8.1

setRetrieveLinks

public void setRetrieveLinks(boolean newValue)
Sets whether retrieval of outbound item links is enabled.
Parameters:
newValue - new retrieveLinks propertyvalue
Since:
8.1

isRetrieveItemTree

public boolean isRetrieveItemTree()
Returns whether retrieval of the whole item tree hierarchy, including retrieving the children and their contents, has been enabled.
Returns:
retrieveLinks property value
Since:
8.1

setRetrieveItemTree

public void setRetrieveItemTree(boolean newValue)
Sets whether retrieval of the whole item tree hierarchy, including retrieving the children and their contents, is enabled.
Parameters:
newValue - new retrieveLinks propertyvalue
Since:
8.1

setConnection

public void setConnection(CMBConnection conn)
Sets the reference of connection bean.
Parameters:
conn - reference of connection bean

getConnection

public CMBConnection getConnection()
Gets the connection bean reference.
Returns:
the reference to the CMBConnection object.

getItemType

public short getItemType()
                  throws CMBItemNotSetException,
                         CMBNoConnectionException,
                         CMBException
Gets the item type for the current item.
Returns:
current item type: document, folder, or resource item

setDataObject

public void setDataObject(CMBItem dataObject)
Sets the data object. This object needs to be set for most operations.
Parameters:
dataObject - reference to CMBItem object

getDataObject

public CMBItem getDataObject()
Gets the data object.
Returns:
CMBItem object reference

createItem

public void createItem(java.lang.String entityName)
                throws CMBItemNotSetException,
                       CMBNoConnectionException,
                       CMBException
Creates a new item and puts it in the given entity name on the server.
Parameters:
entityName - entity name. For Fed, this is of the form FedEntityName;ServerName;NativeEntityName
Throws:
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.

createResourceItem

public void createResourceItem(java.lang.String className,
                               java.lang.String entityName)
                        throws CMBItemNotSetException,
                               CMBNoConnectionException,
                               CMBException
Creates a new resource item and puts it in the given entity name on the server. This is for CM V8 servers only.
Parameters:
className - The class name of the resource item class. This is a subclass of DKLobICM.
entityName - entity name
Throws:
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.
Since:
8.1

updateItem

public void updateItem()
                throws CMBItemNotSetException,
                       CMBItemNotExistException,
                       CMBNoConnectionException,
                       CMBException
Updates the attribute values of the current item. This assumes the latest version.
Throws:
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.

updateItem

public void updateItem(int version)
                throws CMBItemNotSetException,
                       CMBItemNotExistException,
                       CMBNoConnectionException,
                       CMBException
Updates the attribute values of the current item. Use the given version.
Parameters:
version - May be one of the following:
  • CMB_VERSION_LATEST
  • CMB_VERSION_NEW
Throws:
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.

reindexItem

public void reindexItem()
                 throws CMBItemNotSetException,
                        CMBNoConnectionException,
                        CMBException
Moves this item from current entity to a new entity.
Throws:
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.

reindexItem

public void reindexItem(java.lang.String newEntityName)
                 throws CMBItemNotSetException,
                        CMBNoConnectionException,
                        CMBException
Moves this item from current entity to a new entity.
Parameters:
newEntityName - name of the new entity this item will be moved to
Throws:
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.

unindexItem

public void unindexItem()
                 throws CMBItemNotSetException,
                        CMBNoConnectionException,
                        CMBException
Removes this item from current entity but do not delete it. This method is a COntent Manager only method that moves the item to NOINDEX index class.
Throws:
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.

deleteItem

public void deleteItem()
                throws CMBItemNotSetException,
                       CMBItemNotExistException,
                       CMBNoConnectionException,
                       CMBException
Deletes this item from the server.
Throws:
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.

retrieveItem

public void retrieveItem()
                  throws CMBItemNotSetException,
                         CMBItemNotExistException,
                         CMBNoConnectionException,
                         CMBServerAccessErrorException,
                         CMBConnectFailedException,
                         CMBException
Retrieves the latest version of the current item from the server.
Throws:
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.
  • there is no current connection to the server where this item came from.
CMBConnectFailedException - if
  • CMB_CONNECT_INVALID_USERID_PASSWD: invalid user ID or password
  • CMB_CONNECT_SERVER_UNAVAILABLE: server not available or an error occurred in server while logging on
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.

retrieveItem

public void retrieveItem(int version)
                  throws CMBItemNotSetException,
                         CMBItemNotExistException,
                         CMBNoConnectionException,
                         CMBServerAccessErrorException,
                         CMBConnectFailedException,
                         CMBException
Retrieves the current item from the server.
Parameters:
int - version The version of the item to retrieve
Throws:
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.
  • there is no current connection to the server where this item came from.
CMBConnectFailedException - if
  • CMB_CONNECT_INVALID_USERID_PASSWD: invalid user ID or password
  • CMB_CONNECT_SERVER_UNAVAILABLE: server not available or an error occurred in server while logging on
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.
Since:
8.1

setEntityName

public void setEntityName(java.lang.String entityName)
Sets the new entityName for the current item.
Parameters:
entityName - new entity name

getContent

public CMBObject[] getContent()
                       throws CMBItemNotSetException,
                              CMBItemNotExistException,
                              CMBNoConnectionException,
                              CMBException
Gets all the content objects from the current item.
Returns:
an array of content objects of type CMBObject. If there is no content objects for this item, the array will be empty.
Throws:
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.

getContent

public CMBObject getContent(int index)
                     throws CMBItemNotSetException,
                            CMBItemNotExistException,
                            java.lang.ArrayIndexOutOfBoundsException,
                            CMBNoConnectionException,
                            CMBException
Gets the specified content object from the current item.
Parameters:
index - content index
Returns:
a content object
Throws:
CMBItemNotSetException - if the data object is not set
CMBItemNotExistException - if the item does not exist on the content server.
java.lang.ArrayIndexOutOfBoundsException - if index is invalid
CMBNoConnectionException - 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.

getContentID

public java.lang.String getContentID(int index)
                              throws CMBItemNotSetException,
                                     CMBItemNotExistException,
                                     java.lang.ArrayIndexOutOfBoundsException,
                                     CMBNoConnectionException,
                                     CMBException
Gets content ID at given index
Parameters:
index - content index
Returns:
content PID string
Throws:
java.lang.ArrayIndexOutOfBoundsException - if index is invalid
CMBItemNotSetException - 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.

getContentById

public CMBObject getContentById(java.lang.String contentID)
                         throws CMBItemNotSetException,
                                CMBItemNotExistException,
                                CMBNoConnectionException,
                                CMBException
Gets CMBObject for the given content PID string
Parameters:
contentID - content PID string
Returns:
CMBObject or null if pid string is invalid
Throws:
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.

getContentCount

public int getContentCount()
                    throws CMBItemNotSetException,
                           CMBItemNotExistException,
                           CMBNoConnectionException,
                           CMBException
Gets number of content parts for this given document.
Returns:
number of parts
Throws:
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.

getContentByUniqueName

public CMBObject getContentByUniqueName(java.lang.String contentName)
                                 throws CMBItemNotSetException,
                                        CMBItemNotExistException,
                                        CMBNoConnectionException,
                                        CMBException
Gets CMBObject for the given content PID string.
Parameters:
contentName - content unique name
Returns:
CMBObject or null if PID string is invalid
Throws:
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.

deleteContent

public void deleteContent(int index)
                   throws CMBItemNotSetException,
                          CMBItemNotExistException,
                          CMBNoConnectionException,
                          java.lang.ArrayIndexOutOfBoundsException,
                          CMBException
Deletes the part at the specified location.
Parameters:
index - part location
Throws:
java.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.

updateContent

public void updateContent(int index,
                          CMBObject obj)
                   throws CMBItemNotSetException,
                          CMBItemNotExistException,
                          CMBNoConnectionException,
                          CMBException
Updates the specified content for the current item.
Parameters:
index - content location
obj - updated content object
Throws:
java.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.

addContent

public void addContent(CMBObject obj)
                throws CMBItemNotSetException,
                       CMBItemNotExistException,
                       CMBNoConnectionException,
                       CMBException
Adds a new content part to the current document at the end of the parts list. Note: If the document does not exist yet on the server, the content is not stored until a createItem() call is performed.
Parameters:
obj - CMBObject for new content part
Throws:
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.

getAnnotation

public CMBAnnotation[] getAnnotation()
                              throws CMBItemNotSetException,
                                     CMBItemNotExistException,
                                     CMBNoConnectionException,
                                     CMBException
Deprecated. Use getAnnotations instead

Gets all the annotations from the current item.
Returns:
a collection of annotation objects of type byte[]

getAnnotations

public CMBAnnotation[] getAnnotations()
                               throws CMBItemNotSetException,
                                      CMBItemNotExistException,
                                      CMBNoConnectionException,
                                      CMBException
Gets all the annotations from the current item.
Returns:
a collection of annotation objects of type byte[]
Throws:
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.

getItemMimeType

public java.lang.String getItemMimeType()
                                 throws CMBItemNotSetException,
                                        CMBItemNotExistException,
                                        CMBNoConnectionException,
                                        CMBException
Gets the mime content type for the item. If the item consists of a single content part, the mimetype of the content part is returned. If the item consists of multiple parts, and the mimetype of all content parts is the same, the mime type of the parts is returned. If the mimetype of the content parts is not the same, multipart/mixed is returned. An exception is OnDemand large object documents, which will return the item type of the original document.
Returns:
mime type for the item that is currently set.
Throws:
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.

getAnnotation

public CMBAnnotation getAnnotation(int index)
                            throws CMBItemNotSetException,
                                   CMBItemNotExistException,
                                   java.lang.ArrayIndexOutOfBoundsException,
                                   CMBNoConnectionException,
                                   CMBException
Gets a specific annotation from the current item by index.
Parameters:
index - annotation index
Returns:
annotation object
Throws:
java.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.

getAnnotationCount

public int getAnnotationCount()
                       throws CMBItemNotSetException,
                              CMBItemNotExistException,
                              CMBNoConnectionException,
                              CMBException
Gets thre number of annotations in the current document.
Returns:
number of annotation objects
Throws:
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.

addAnnotation

public void addAnnotation(CMBAnnotation obj)
                   throws CMBItemNotSetException,
                          CMBItemNotExistException,
                          CMBNoConnectionException,
                          CMBException
Adds a new annotation to current item at the end of annotation list.
Parameters:
obj - new annotation object
Throws:
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.

updateAnnotation

public void updateAnnotation(int index,
                             CMBAnnotation obj)
                      throws CMBItemNotSetException,
                             CMBItemNotExistException,
                             CMBNoConnectionException,
                             CMBException
Updates the specified annotation for the current item.
Parameters:
index - annotation location
obj - annotation object to be updated
Throws:
java.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.

deleteAnnotation

public void deleteAnnotation(int index)
                      throws CMBItemNotSetException,
                             CMBItemNotExistException,
                             CMBNoConnectionException,
                             java.lang.ArrayIndexOutOfBoundsException,
                             CMBException
Deletes the annotation at the specified location.
Parameters:
index - annotation location
Throws:
java.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.

getNoteLogs

public CMBObject[] getNoteLogs()
                        throws CMBItemNotSetException,
                               CMBItemNotExistException,
                               CMBNoConnectionException,
                               CMBException
Gets an array of CMBObjects for note logs on the current item.
Returns:
Array of CMBObjects
Throws:
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.

getNoteLog

public CMBObject getNoteLog(int index)
                     throws CMBItemNotSetException,
                            CMBItemNotExistException,
                            CMBNoConnectionException,
                            java.lang.ArrayIndexOutOfBoundsException,
                            CMBException
Gets a CMBObject for the note log for a particular item.
Parameters:
index - the item index
Returns:
CMBObject for the note log
Throws:
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.
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.

getNoteLogCount

public int getNoteLogCount()
                    throws CMBItemNotSetException,
                           CMBItemNotExistException,
                           CMBNoConnectionException,
                           CMBException
Gets the number of note logs for the current item.

If there are no notes or if notes are not supported on the platform, the method returns 0.

Returns:
integer number of note logs
Throws:
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.

updateNoteLog

public void updateNoteLog(int index,
                          CMBObject obj)
                   throws CMBItemNotSetException,
                          CMBItemNotExistException,
                          CMBNoConnectionException,
                          CMBException
Updates the specified notelog for the current item.
Parameters:
index - notelog location
obj - updated notelog object
Throws:
java.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.

deleteNoteLog

public void deleteNoteLog(int index)
                   throws CMBItemNotSetException,
                          CMBItemNotExistException,
                          CMBNoConnectionException,
                          java.lang.ArrayIndexOutOfBoundsException,
                          CMBException
Deletes the noteLog at the specified location.
Parameters:
index - noteLog location
Throws:
java.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.

addNoteLog

public void addNoteLog(CMBObject obj)
                throws CMBItemNotSetException,
                       CMBItemNotExistException,
                       CMBNoConnectionException,
                       CMBException
Adds a new note log object to current document.
Throws:
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.

getResources

public CMBResources getResources()
                          throws CMBItemNotSetException,
                                 CMBItemNotExistException,
                                 CMBMethodNotSupportedException,
                                 CMBNoConnectionException,
                                 CMBException
Gets reference to CMBResources object; for OnDemand documents only.
Returns:
CMBResources object
Throws:
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.

getFixedViewData

public CMBFixedViewData getFixedViewData()
                                  throws CMBItemNotSetException,
                                         CMBItemNotExistException,
                                         CMBMethodNotSupportedException,
                                         CMBNoConnectionException,
                                         CMBException
Gets a reference to CMBFixedViewData object; for OnDemand documents only.
Returns:
a CMBFixedViewData object
Throws:
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.

getViewData

public CMBViewData[] getViewData()
                          throws CMBItemNotSetException,
                                 CMBItemNotExistException,
                                 CMBMethodNotSupportedException,
                                 CMBNoConnectionException,
                                 CMBException
Gets reference to CMBViewData object; for OnDemand documents only.
Returns:
an array of CMBViewData objects
Throws:
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.

getViewData

public CMBViewData getViewData(int index)
                        throws CMBItemNotSetException,
                               CMBMethodNotSupportedException,
                               CMBNoConnectionException,
                               java.lang.ArrayIndexOutOfBoundsException,
                               CMBException
Gets a particular logical view data by index. This method returns a reference to the CMBViewData object at the index. Use for OnDemand documents only.
Parameters:
index - view data index
Returns:
an array of CMBViewData objects
Throws:
java.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.
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.

addViewData

public void addViewData(CMBViewData viewDataObj)
                 throws CMBItemNotSetException,
                        CMBItemNotExistException,
                        CMBMethodNotSupportedException,
                        CMBNoConnectionException,
                        CMBException
Adds new view data object to current document; for OnDemand documents only.
Throws:
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.

updateViewData

public void updateViewData(int index,
                           CMBViewData viewDataObj)
                    throws CMBItemNotSetException,
                           CMBItemNotExistException,
                           CMBMethodNotSupportedException,
                           CMBNoConnectionException,
                           CMBException,
                           java.lang.ArrayIndexOutOfBoundsException
Updates the given index view data object; for OnDemand documents only.
Parameters:
index - view data index
viewDataObj - updated view data object
Throws:
java.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.
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.

deleteViewData

public void deleteViewData(int index)
                    throws CMBItemNotSetException,
                           CMBItemNotExistException,
                           CMBMethodNotSupportedException,
                           CMBNoConnectionException,
                           CMBException,
                           java.lang.ArrayIndexOutOfBoundsException
Deletes a view data object at given index.
Parameters:
index - view data index to be deleted
Throws:
java.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.
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.

getPrivilege

public CMBPrivilege getPrivilege()
                          throws CMBItemNotSetException,
                                 CMBItemNotExistException,
                                 CMBNoConnectionException,
                                 CMBServerAccessErrorException,
                                 CMBException
Gets the privileges for current document.
Returns:
CMBPrivilege object
Throws:
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.

getAllVersions

public CMBItem[] getAllVersions()
                         throws CMBConnectFailedException,
                                CMBItemNotSetException,
                                CMBItemNotExistException,
                                CMBMethodNotSupportedException,
                                CMBNoConnectionException,
                                CMBException
Gets all versions of the current item. Currently this method is only supported for CMV8 backends.
Throws:
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.
Since:
8.1

checkIn

public void checkIn()
             throws CMBItemNotSetException,
                    CMBItemNotExistException,
                    CMBMethodNotSupportedException,
                    CMBNoConnectionException,
                    CMBException
Checks the current document back into the content server.
Throws:
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.

checkOut

public void checkOut()
              throws CMBItemNotSetException,
                     CMBItemNotExistException,
                     CMBMethodNotSupportedException,
                     CMBNoConnectionException,
                     CMBException
Checks the current document out from depository source in the content server.
Throws:
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.

isCheckedOut

public boolean isCheckedOut()
                     throws CMBItemNotSetException,
                            CMBItemNotExistException,
                            CMBMethodNotSupportedException,
                            CMBNoConnectionException,
                            CMBException
Checks if current document is checked out from the content server.
Returns:
true if the current document is checked out, false otherwise
Throws:
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.

unlock

public void unlock()
            throws CMBItemNotSetException,
                   CMBItemNotExistException,
                   CMBMethodNotSupportedException,
                   CMBNoConnectionException,
                   CMBException
Unlocks the current document from the previous checkout.
Throws:
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.

getLockedBy

public java.lang.String getLockedBy()
                             throws CMBItemNotSetException,
                                    CMBItemNotExistException,
                                    CMBMethodNotSupportedException,
                                    CMBNoConnectionException,
                                    CMBException
Gets the user ID that has checked out the current document from the content server.
Throws:
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.

getUnMappedItem

public CMBItem getUnMappedItem(CMBItem mappedItem)
                        throws CMBNoConnectionException,
                               CMBException
Gets an unmapped item from the given mapped item.
Parameters:
mappedItem - item with mapped (federated) properties
Returns:
an unmapped item with properties of its server
Throws:
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.

isSupported

public boolean isSupported(java.lang.String methodName)
                    throws CMBNoConnectionException,
                           CMBException
Checks to see if the method is supported by the content server. While most of the functions in this Bean are supported by all content servers, some are specific to a content server and some are only supported by certain servers. You must to call this method to check whether the specific operation is allowed on the server where the data object came from.
Parameters:
methodName - name of method to check for. Valid method names are:
  • reindexItem
  • checkIn
  • checkOut
  • isCheckedOut
  • getLockedBy
  • unlock
  • getFixedViewData
  • getViewData
  • updateViewData
  • deleteViewData
  • addViewData
  • getResources
Returns:
true if the method is supported by the back-end server
Throws:
CMBNoConnectionException - if there is no current connection to the server.
CMBException - if there is any other error occurs.

isSupported

public boolean isSupported(java.lang.String methodName,
                           java.lang.String serverName,
                           java.lang.String serverType)
                    throws CMBNoConnectionException,
                           CMBException
Checks to see if the method is supported by the content server. While most of the functions in this Bean are supported by all content servers, some are specific to a content server and some are only supported by certain servers. This version of the isSupported method requires the server name and server type of the content server. The selected data object (using setDataObject) is not used by this method.
Parameters:
methodName - name of method to check for. Valid method names are:
  • reindexItem
  • checkIn
  • checkOut
  • isCheckedOut
  • getLockedBy
  • unlock
  • getFixedViewData
  • getViewData
  • updateViewData
  • deleteViewData
  • addViewData
  • getResources
serverName - the name of the content server
Returns:
true if the method is supported by the back-end server
Throws:
CMBNoConnectionException - if there is no current connection to the server.
CMBException - if there is any other error occurs.
Since:
8.1

getTraceEvent

public CMBTraceEvent getTraceEvent()
Returns the trace event. To support VisualCafe 3.0 "Add Interaction..."
Returns:
a CMBTraceEvent

getExceptionEvent

public CMBExceptionEvent getExceptionEvent()
Returns the exception event. To support VisualCafe 3.0 "Add Interaction..."
Returns:
a CMBExceptionEvent

getDataReplyEvent

public CMBDataReplyEvent getDataReplyEvent()
Returns the data reply event. To support VisualCafe 3.0 "Add Interaction..."
Returns:
a CMBDataReplyEvent

getDataExitEvent

public CMBDataExitEvent getDataExitEvent()
Returns the data exit event. To support VisualCafe 3.0 "Add Interaction..."
Returns:
a CMBDataExitEvent

getInboundLinks

public CMBItem[] getInboundLinks(java.lang.String linkType)
                          throws CMBException
ICM only must call dataitem.setRetrieved(false); and dataBean.setRetrieveLinks(true); before calling this method.
Returns:
inbound linked items
Since:
8.1

getLinks

public CMBItem[] getLinks(java.lang.String linkType)
                   throws CMBException
ICM only must call dataitem.setRetrieved(false); and dataBean.setRetrieveLinks(true); before calling this method.
Returns:
outbound linked items
Since:
8.1

addLink

public void addLink(CMBItem item,
                    java.lang.String linkType)
             throws CMBException
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. linkType coulde be one of DKConstantICM.DK_ICM_LINKTYPENAME_CONTAINS, DKConstantICM.DK_ICM_LINKTYPENAME_FOLDERCONTAINS, DKConstantICM.DK_ICM_LINKTYPENAME_CONTAINSRESOURCE or user defined type
Since:
8.1

removeLink

public void removeLink(CMBItem item,
                       java.lang.String linkType)
                throws CMBException
ICM only

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);

Since:
8.1

EIP JavaBeans

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