Enterprise Information Portal APIs

com.ibm.mm.beans
Class CMBSchemaManagement

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

public class CMBSchemaManagement
extends java.lang.Object
implements java.io.Serializable, java.beans.PropertyChangeListener, CMBConnectionReplyListener, CMBSchemaRequestListener, CMBBaseConstant

The CMBSchemaManagement bean provides EIP federated schema management and specific content server schema management functions. These functions include obtaining the defined search templates, entities, and attributes.

Summary of properties and events:

   imported properties   traceEnabled, defaulting on, will not veto
   exported properties   none
   standalone properties cacheEnabled, defaulting on, caching the retrieved
                         schema information
   interested in events  CMBConnectionReplyEvent - to get connection handle
                         CMBSchemaRequestEvent    - to perform functions
                         PropertyChangeEvent      - to import traceEnabled
   source of events      CMBSchemaReplyEvent      - to reply the request
                         CMBExceptionEvent        - to post exception
                         CMBTraceEvent            - to let logger trace
 

Since:
6.1
See Also:
CMBConnection, 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
CMBSchemaManagement()
          Default constructor.
 
Method Summary
 void addCMBExceptionListener(CMBExceptionListener listener)
          CMBExceptionEvent registration method.
 void addCMBSchemaReplyListener(CMBSchemaReplyListener listener)
          CMBSchemaReplyEvent registration method.
 void addCMBTraceListener(CMBTraceListener listener)
          CMBTraceEvent registration method.
 void clearSchemaCache()
          Clear out all current values in memory.
 CMBConnection getConnection()
          Gets the connection bean reference.
 java.lang.String getCurrentServerName()
          Gets the current server name.
 java.lang.String getCurrentServerType()
          Gets the current server type
 java.util.Properties getDefaultMime2App()
          Gets the definitions of applications to be launched for certain mime types as defined in System Administration.
 CMBEntity[] getEntities()
          Return all top-level entity objects
 CMBEntity getEntity(java.lang.String entityName)
          Return the entity object for the given name mapped entity names are supported in form: FedEntityName;nativeServername;NativeEntityName
 CMBAttribute getEntityAttr(java.lang.String entityName, java.lang.String attrName)
          Deprecated. Use getEntityAttrs instead
 java.lang.String[] getEntityAttrName(java.lang.String entityName)
          Deprecated. Use getEntityAttrNames instead
 java.lang.String getEntityAttrName(java.lang.String entityName, int index)
          Deprecated. Use getEntityAttrNames instead
 java.lang.String[] getEntityAttrNames(java.lang.String entityName)
          Get attribute names for the specified entity.
 java.lang.String getEntityAttrNames(java.lang.String entityName, int index)
          Indexed getter for attribute name of the specified entity.
 CMBAttribute getEntityAttrs(java.lang.String entityName, java.lang.String attrName)
          Gets entity attribute's data.
 short getEntityAttrType(java.lang.String entityName, java.lang.String attrName)
          Gets entity attribute's data type.
 java.lang.String[] getEntityName()
          Deprecated. Use getEntityNames instead
 java.lang.String getEntityName(int index)
          Indexed getter for entity name.
 java.lang.String[] getEntityNames()
          Get all entity names.
 short getEntityType(java.lang.String entityName)
          Returns the entity type
 CMBExceptionEvent getExceptionEvent()
          To support VisualCafe 3.0 "Add Interaction..."
 java.lang.String[] getNativeServerNames()
          Gets the names of all servers that are mapped to by this Federated server.
 java.lang.String[] getNativeServerNames(java.lang.String serverType)
          Gets the names of all servers of the given type that are mapped to by this Federated server.
 java.lang.String[] getNativeServerTypes()
          Gets the types of all servers that are mapped to by this Federated server.
 java.lang.String getParentEntityName(java.lang.String entityName)
          Returns the name of the parent entity.
 CMBSchemaReplyEvent getSchemaReplyEvent()
          To support VisualCafe 3.0 "Add Interaction..."
 CMBSearchTemplate[] getSearchTemplate()
          Deprecated. Use getSearchTemplates instead
 CMBSearchTemplate getSearchTemplate(int index)
          Indexed getter for search template object.
 CMBSearchTemplate getSearchTemplate(java.lang.String name)
          Get a specified search template object.
 java.lang.String[] getSearchTemplateName()
          Deprecated. Use getSearchTemplateNames instead
 java.lang.String getSearchTemplateName(int index)
          Indexed getter for search template name.
 java.lang.String[] getSearchTemplateNames()
          Get all search template names.
 CMBSearchTemplate[] getSearchTemplates()
          Get all search template objects.
 java.lang.String[] getServerName()
          Deprecated. Use getServerNames instead
 java.lang.String getServerName(int index)
          Indexed getter for server name.
 java.lang.String[] getServerNames()
          Get all server names.
 CMBEntity[] getSubEntities(java.lang.String entityName)
          Return all sub entities of the given entity
 CMBTraceEvent getTraceEvent()
          To support VisualCafe 3.0 "Add Interaction..."
 boolean hasSubEntities(java.lang.String entityName)
          Determines whether the entity has sub entities
 boolean isCacheEnabled()
          Property getter.
 boolean isEntityTextSearchable(java.lang.String entityName)
          Determines whether the entity is text searchable.
 boolean isTraceEnabled()
          Property getter.
 void onCMBConnectionReply(CMBConnectionReplyEvent evt)
          Implementation of connection reply service method= update the connection handle accordingly.
 void onCMBSchemaRequest(CMBSchemaRequestEvent evt)
          Implementation of schema request service method: perform the requested function.
 void propertyChange(java.beans.PropertyChangeEvent evt)
          On property change, import the traceEnabled property value.
 void removeCMBExceptionListener(CMBExceptionListener listener)
          CMBExceptionEvent unregistration method.
 void removeCMBSchemaReplyListener(CMBSchemaReplyListener listener)
          CMBSchemaReplyEvent unregistration method.
 void removeCMBTraceListener(CMBTraceListener listener)
          CMBTraceEvent unregistration method.
 void setCacheEnabled(boolean newValue)
          Property setter.
 void setConnection(CMBConnection conn)
          Set the connection handle from the CMBConnection bean.
 void setCurrentServer(java.lang.String serverName, java.lang.String serverType)
          Sets the current server.
 void setTraceEnabled(boolean newValue)
          Property setter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CMBSchemaManagement

public CMBSchemaManagement()
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

onCMBSchemaRequest

public void onCMBSchemaRequest(CMBSchemaRequestEvent evt)
Implementation of schema request service method: perform the requested function. Will fire a CMBSchemaReplyEvent.
Specified by:
onCMBSchemaRequest in interface CMBSchemaRequestListener
Parameters:
evt - a CMBSchemaRequestEvent

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)
On property change, import 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

addCMBSchemaReplyListener

public void addCMBSchemaReplyListener(CMBSchemaReplyListener listener)
CMBSchemaReplyEvent registration method. It ignores a registration request if the listener is already registered.
Parameters:
listener - listener to be registered

removeCMBSchemaReplyListener

public void removeCMBSchemaReplyListener(CMBSchemaReplyListener listener)
CMBSchemaReplyEvent unregistration method.
Parameters:
listener - listener to be unregistered

isTraceEnabled

public boolean isTraceEnabled()
Property getter.
Returns:
traceEnabled property value

setTraceEnabled

public void setTraceEnabled(boolean newValue)
Property setter.
Parameters:
newValue - new trace option value

isCacheEnabled

public boolean isCacheEnabled()
Property getter.
Returns:
cacheEnabled property value

setCacheEnabled

public void setCacheEnabled(boolean newValue)
Property setter.
Parameters:
newValue - new cache option value

setConnection

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

getConnection

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

clearSchemaCache

public void clearSchemaCache()
Clear out all current values in memory.

getServerName

public java.lang.String[] getServerName()
                                 throws CMBException
Deprecated. Use getServerNames instead

Get all server names. Always returns a non-null String array if no error. In the case there is not a server exist, the array size will be zero.
Returns:
an array of server names
Throws:
CMBException - will be thrown for the following errorCode form CMBException.getErrorCode():
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred from the Content Server. Call CMBException.getErrorData() to get the original exception object.

getServerNames

public java.lang.String[] getServerNames()
                                  throws CMBException
Get all server names. Always returns a non-null String array if no error. In the case there is not a server exist, the array size will be zero.
Returns:
an array of server names
Throws:
CMBException - will be thrown for the following errorCode form CMBException.getErrorCode():
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred from the Content Server. Call CMBException.getErrorData() to get the original exception object.
Since:
8.1

getServerName

public java.lang.String getServerName(int index)
                               throws java.lang.ArrayIndexOutOfBoundsException,
                                      CMBException
Indexed getter for server name.
Parameters:
index - index
Returns:
server name
Throws:
CMBException - will be thrown for the following errorCode form CMBException.getErrorCode():
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred from the Content Server. Call CMBException.getErrorData() to get the original exception object.
java.lang.ArrayIndexOutOfBoundsException - index is out of bounds

getNativeServerNames

public java.lang.String[] getNativeServerNames(java.lang.String serverType)
                                        throws CMBException,
                                               java.lang.Exception
Gets the names of all servers of the given type that are mapped to by this Federated server. This method is only valid for Fed. Always returns a non-null String array if no error. If no servers exist, the array size will be zero.
Parameters:
serverType - String which specifies the type of native servers to return.
Returns:
an array of server names
Throws:
CMBException -
  • CMBException.CMB_ERR_INVALID_METHOD: if the current server type is not CMBBaseConstant.CMB_DSTYPE_FED.
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred from the Content Server. Call CMBException.getErrorData() to get the original exception object.
Since:
8.1

getNativeServerNames

public java.lang.String[] getNativeServerNames()
                                        throws CMBException,
                                               java.lang.Exception
Gets the names of all servers that are mapped to by this Federated server. This method is only valid for Fed. Always returns a non-null String array if no error. If no servers exist, the array size will be zero. The arrays for native server names and native server types are ordered; that is, the type of the server at serverNames[i] is found at serverTypes[i].
Returns:
an array of server names
Throws:
CMBException -
  • CMBException.CMB_ERR_INVALID_METHOD: if the current server type is not CMBBaseConstant.CMB_DSTYPE_FED.
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred from the Content Server. Call CMBException.getErrorData() to get the original exception object.
Since:
8.1

getNativeServerTypes

public java.lang.String[] getNativeServerTypes()
                                        throws CMBException,
                                               java.lang.Exception
Gets the types of all servers that are mapped to by this Federated server. This method is only valid for Fed. Always returns a non-null String array if no error. If no servers exist, the array size will be zero. The arrays for native server names and native server types are ordered; that is, the type of the server at serverNames[i] is found at serverTypes[i].
Returns:
an array of server types
Throws:
CMBException -
  • CMBException.CMB_ERR_INVALID_METHOD: if the current server type is not CMBBaseConstant.CMB_DSTYPE_FED.
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred from the Content Server. Call CMBException.getErrorData() to get the original exception object.
Since:
8.1

getSearchTemplateName

public java.lang.String[] getSearchTemplateName()
                                         throws CMBNoConnectionException,
                                                CMBException
Deprecated. Use getSearchTemplateNames instead

Get all search template names. Always returns a non-null String array if no errors. In the case there is not a template exist, the array size will be zero.
Returns:
an array of search template names
Throws:
CMBNoConnectionException - if there is no connection to the server.
CMBException - will be thrown for the following errorCode form CMBException.getErrorCode():
  • CMBException.CMB_ERR_INVALID_METHOD: if the current server does not support search template
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred from the Content Server. Call CMBException.getErrorData() to get the original exception object.

getSearchTemplateNames

public java.lang.String[] getSearchTemplateNames()
                                          throws CMBNoConnectionException,
                                                 CMBException
Get all search template names. Always returns a non-null String array if no errors. In the case there is not a template exist, the array size will be zero.
Returns:
an array of search template names
Throws:
CMBNoConnectionException - if there is no connection to the server.
CMBException - will be thrown for the following errorCode form CMBException.getErrorCode():
  • CMBException.CMB_ERR_INVALID_METHOD: if the current server does not support search template
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred from the Content Server. Call CMBException.getErrorData() to get the original exception object.
Since:
8.1

getSearchTemplateName

public java.lang.String getSearchTemplateName(int index)
                                       throws java.lang.ArrayIndexOutOfBoundsException,
                                              CMBNoConnectionException,
                                              CMBException
Indexed getter for search template name.
Parameters:
index - index
Returns:
search template name
Throws:
java.lang.ArrayIndexOutOfBoundsException - index is out of bounds
CMBNoConnectionException - if there is no connection to the server.
CMBException - will be thrown for the following errorCode form CMBException.getErrorCode():
  • CMBException.CMB_ERR_INVALID_METHOD: if the current server does not support search template
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred from the Content Server. Call CMBException.getErrorData() to get the original exception object.

getEntityName

public java.lang.String[] getEntityName()
                                 throws CMBNoConnectionException,
                                        CMBException
Deprecated. Use getEntityNames instead

Get all entity names. Always returns a non-null String array if there are no errors. In case no entity exists, the array size will be zero.
Returns:
an array of entity names
Throws:
CMBNoConnectionException - if there is no connection to the server.
CMBException - will be thrown for the following errorCode form CMBException.getErrorCode():
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred from the Content Server. Call CMBException.getErrorData() to get the original exception object.

getEntityNames

public java.lang.String[] getEntityNames()
                                  throws CMBNoConnectionException,
                                         CMBException
Get all entity names. Always returns a non-null String array if there are no errors. In case no entity exists, the array size will be zero.
Returns:
an array of entity names
Throws:
CMBNoConnectionException - if there is no connection to the server.
CMBException - will be thrown for the following errorCode form CMBException.getErrorCode():
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred from the Content Server. Call CMBException.getErrorData() to get the original exception object.
Since:
8.1

getEntityName

public java.lang.String getEntityName(int index)
                               throws java.lang.ArrayIndexOutOfBoundsException,
                                      CMBNoConnectionException,
                                      CMBException
Indexed getter for entity name.
Parameters:
index - index
Returns:
entity name
Throws:
java.lang.ArrayIndexOutOfBoundsException - index is out of bounds
CMBNoConnectionException - if there is no connection to the server.
CMBException - will be thrown for the following errorCode form CMBException.getErrorCode():
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred from the Content Server. Call CMBException.getErrorData() to get the original exception object.

getEntityAttrName

public java.lang.String[] getEntityAttrName(java.lang.String entityName)
                                     throws CMBNoConnectionException,
                                            CMBException
Deprecated. Use getEntityAttrNames instead

Get attribute names for the specified entity. Always returns a non-null String array if there is no error. In case no attribute exists, the array size will be zero.
Parameters:
entityName - the entity name to get its attributes
Returns:
an array of attribute names
Throws:
CMBNoConnectionException - if there is no connection to the server.
CMBException - will be thrown for the following errorCode form CMBException.getErrorCode():
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred from the Content Server. Call CMBException.getErrorData() to get the original exception object.

getEntityAttrNames

public java.lang.String[] getEntityAttrNames(java.lang.String entityName)
                                      throws CMBNoConnectionException,
                                             CMBException
Get attribute names for the specified entity. Always returns a non-null String array if there is no error. In case no attribute exists, the array size will be zero.
Parameters:
entityName - the entity name to get its attributes
Returns:
an array of attribute names
Throws:
CMBNoConnectionException - if there is no connection to the server.
CMBException - will be thrown for the following errorCode form CMBException.getErrorCode():
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred from the Content Server. Call CMBException.getErrorData() to get the original exception object.
Since:
8.1

getEntityAttrName

public java.lang.String getEntityAttrName(java.lang.String entityName,
                                          int index)
                                   throws java.lang.ArrayIndexOutOfBoundsException,
                                          CMBNoConnectionException,
                                          CMBException
Deprecated. Use getEntityAttrNames instead

Indexed getter for attribute name of the specified entity.
Parameters:
entityName - the entity name to get its attributes
index - index
Returns:
attribute name
Throws:
java.lang.ArrayIndexOutOfBoundsException - index is out of bounds
CMBNoConnectionException - if there is no connection to the server.
CMBException - will be thrown for the following errorCode form CMBException.getErrorCode():
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred from the Content Server. Call CMBException.getErrorData() to get the original exception object.

getEntityAttrNames

public java.lang.String getEntityAttrNames(java.lang.String entityName,
                                           int index)
                                    throws java.lang.ArrayIndexOutOfBoundsException,
                                           CMBNoConnectionException,
                                           CMBException
Indexed getter for attribute name of the specified entity.
Parameters:
entityName - the entity name to get its attributes
index - index
Returns:
attribute name
Throws:
java.lang.ArrayIndexOutOfBoundsException - index is out of bounds
CMBNoConnectionException - if there is no connection to the server.
CMBException - will be thrown for the following errorCode form CMBException.getErrorCode():
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred from the Content Server. Call CMBException.getErrorData() to get the original exception object.
Since:
8.1

getEntityAttrType

public short getEntityAttrType(java.lang.String entityName,
                               java.lang.String attrName)
                        throws CMBNoConnectionException,
                               CMBException
Gets entity attribute's data type.
Parameters:
entityName - name of entity
attrName - name of attribute
Returns:
short - the attribute data type
Throws:
CMBNoConnectionException - if there is no connection to the server.
CMBException - will be thrown for the following errorCode form CMBException.getErrorCode():
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred from the Content Server. Call CMBException.getErrorData() to get the original exception object.

getEntityAttr

public CMBAttribute getEntityAttr(java.lang.String entityName,
                                  java.lang.String attrName)
                           throws CMBNoConnectionException,
                                  CMBException
Deprecated. Use getEntityAttrs instead

Gets entity attribute's data.
Parameters:
entityName - name of entity
attrName - name of attribute
Returns:
CMBAttribute - the attribute data object, or null if this entity or attribute does not exist.
Throws:
CMBNoConnectionException - if there is no connection to the server.
CMBException - will be thrown for the following errorCode form CMBException.getErrorCode():
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred at the Content Server. Call CMBException.getErrorData() to get the original exception object.

getEntityAttrs

public CMBAttribute getEntityAttrs(java.lang.String entityName,
                                   java.lang.String attrName)
                            throws CMBNoConnectionException,
                                   CMBException
Gets entity attribute's data.
Parameters:
entityName - name of entity
attrName - name of attribute
Returns:
CMBAttribute - the attribute data object, or null if this entity or attribute does not exist.
Throws:
CMBNoConnectionException - if there is no connection to the server.
CMBException - will be thrown for the following errorCode form CMBException.getErrorCode():
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred at the Content Server. Call CMBException.getErrorData() to get the original exception object.
Since:
8.1

getEntities

public CMBEntity[] getEntities()
                        throws CMBException,
                               CMBNoConnectionException
Return all top-level entity objects
Returns:
CMBEntity[] the entity object array
Throws:
CMBException - will be thrown for the following errorCode from CMBException.getErrorCode():
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred at the Content Server. Call CMBException.getErrorData() to get the original exception object.
Since:
8.1

getEntity

public CMBEntity getEntity(java.lang.String entityName)
                    throws CMBException,
                           CMBNoConnectionException
Return the entity object for the given name mapped entity names are supported in form: FedEntityName;nativeServername;NativeEntityName
Parameters:
entityName - name of the desired entity
Returns:
CMBEntity the entity objct
Throws:
CMBException - will be thrown for the following errorCode from CMBException.getErrorCode():
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred at the Content Server. Call CMBException.getErrorData() to get the original exception object.
Since:
8.1

hasSubEntities

public boolean hasSubEntities(java.lang.String entityName)
                       throws CMBException
Determines whether the entity has sub entities
Parameters:
entityName - name of entity
Returns:
boolean Does the entity have sub entites?
Throws:
CMBException - will be thrown for the following errorCode from CMBException.getErrorCode():
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred at the Content Server. Call CMBException.getErrorData() to get the original exception object.
Since:
8.1

getSubEntities

public CMBEntity[] getSubEntities(java.lang.String entityName)
                           throws CMBException
Return all sub entities of the given entity
Parameters:
entityName - name of the parent entity
Returns:
CMBEntity[] the array of sub entities
Throws:
CMBException - will be thrown for the following errorCode from CMBException.getErrorCode():
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred at the Content Server. Call CMBException.getErrorData() to get the original exception object.
Since:
8.1

getSearchTemplate

public CMBSearchTemplate[] getSearchTemplate()
                                      throws CMBNoConnectionException,
                                             CMBException
Deprecated. Use getSearchTemplates instead

Get all search template objects.
Returns:
an array of search template objects. If there is no search template defined, the array will be empty.
Throws:
CMBNoConnectionException - if there is no connection to the server.
CMBException - will be thrown for the following errorCode form CMBException.getErrorCode():
  • CMBException.CMB_ERR_INVALID_METHOD: if the current server type does not support search templates.
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred from the Content Server. Call CMBException.getErrorData() to get the original exception object.

getSearchTemplates

public CMBSearchTemplate[] getSearchTemplates()
                                       throws CMBNoConnectionException,
                                              CMBException
Get all search template objects.
Returns:
an array of search template objects. If there is no search template defined, the array will be empty.
Throws:
CMBNoConnectionException - if there is no connection to the server.
CMBException - will be thrown for the following errorCode form CMBException.getErrorCode():
  • CMBException.CMB_ERR_INVALID_METHOD: if the current server type does not support search templates.
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred from the Content Server. Call CMBException.getErrorData() to get the original exception object.
Since:
8.1

getSearchTemplate

public CMBSearchTemplate getSearchTemplate(int index)
                                    throws java.lang.ArrayIndexOutOfBoundsException,
                                           CMBNoConnectionException,
                                           CMBException
Indexed getter for search template object.
Parameters:
index - index
Returns:
search template object, if there is no search templates on the system, null will be returned.
Throws:
java.lang.ArrayIndexOutOfBoundsException - index is out of bounds
CMBNoConnectionException - if there is no connection to the server.
CMBException - will be thrown for the following errorCode form CMBException.getErrorCode():
  • CMBException.CMB_ERR_INVALID_METHOD: if the current server type is not CMBBaseConstant.CMB_DSTYPE_FED.
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred from the Content Server. Call CMBException.getErrorData() to get the original exception object.

getSearchTemplate

public CMBSearchTemplate getSearchTemplate(java.lang.String name)
                                    throws CMBNoConnectionException,
                                           CMBException
Get a specified search template object.
Parameters:
name - search template name
Returns:
search template object
Throws:
CMBNoConnectionException - if there is no connection to the server.
CMBException - will be thrown for the following errorCode form CMBException.getErrorCode():
  • CMBException.CMB_ERR_INVALID_METHOD: if the current server type is not CMBBaseConstant.CMB_DSTYPE_FED.
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has occurred from the Content Server. Call CMBException.getErrorData() to get the original exception object.

getCurrentServerName

public java.lang.String getCurrentServerName()
Gets the current server name.
Returns:
the current server name

getCurrentServerType

public java.lang.String getCurrentServerType()
Gets the current server type
Returns:
current server type

setCurrentServer

public void setCurrentServer(java.lang.String serverName,
                             java.lang.String serverType)
Sets the current server. Federation only. an exception is thrown when there is no way to connect to a native server. exception is added later on so we can not use CMBException.
Parameters:
serverName - the server name
serverType - the server type

getDefaultMime2App

public java.util.Properties getDefaultMime2App()
                                        throws CMBException
Gets the definitions of applications to be launched for certain mime types as defined in System Administration.
Returns:
a Properties object with mime types mapped to application to be launched to view documents of that mime type.

getParentEntityName

public java.lang.String getParentEntityName(java.lang.String entityName)
Returns the name of the parent entity.
Parameters:
entityName - name of entity
Returns:
String The parent entity name; null if none found
Since:
8.1

isEntityTextSearchable

public boolean isEntityTextSearchable(java.lang.String entityName)
Determines whether the entity is text searchable.
Parameters:
entityName - name of entity
Returns:
boolean Is the entity text searchable?
Since:
8.1

getEntityType

public short getEntityType(java.lang.String entityName)
Returns the entity type
Parameters:
entityName - name of entity
Returns:
short The entity type Returns 0 by default.
Since:
8.1

getSchemaReplyEvent

public CMBSchemaReplyEvent getSchemaReplyEvent()
To support VisualCafe 3.0 "Add Interaction..."
Returns:
a CMBSchemaReplyEvent

getTraceEvent

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

getExceptionEvent

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

EIP JavaBeans

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