Enterprise Information Portal APIs

com.ibm.mm.beans
Class CMBEntity

java.lang.Object
  |
  +--com.ibm.mm.beans.CMBEntity
All Implemented Interfaces:
java.io.Serializable

public class CMBEntity
extends java.lang.Object
implements java.io.Serializable

This is a helper class for the CMBSchemaManagement bean. This class provides functions for retrieval of entity data including attributes, types, and sub entities.

Since:
8.1
See Also:
CMBSchemaManagement, Serialized Form

Method Summary
 CMBAttribute getAttribute(java.lang.String attrName)
          Gets a single attribute in this entity
 java.lang.String[] getAttributeNames()
          Gets the names of this entity's attributes
 CMBAttribute[] getAttributes()
          Gets the attribute objects for this entity
 short getAttributeType(java.lang.String attrName)
          Gets the type of a single attribute in this entity
 short[] getAttributeTypes()
          Gets the types of this entity's attributes
 short getClassification()
          Gets the classification of the objects in this entity.
 java.lang.String getName()
          Return the name of the entity
 java.lang.String getParentEntityName()
          Return the name of the parent entity, or an empty string if there is none.
 java.lang.String[] getPartTypes()
           
 int getPartTypeVersionPolicy()
          Gets the value that controls the way versioning is performed.
 CMBEntity[] getSubEntities()
          Get all the sub entities in this entity
 CMBAttribute getTextSearchAttribute()
          Gets the attribute object for text seach on this entity.
 short getType()
          Returns the entity type, 0 by default
 short getVersionControl()
          Returns the version control of the entity
 boolean hasSubEntities()
          Determines if this entity has sub entities.
 boolean isRoot()
          Determines whether the entity describes a root component Only CM V8 has a distinction between root and non-root components.
 boolean isTextSearchable()
          Determines whether the entity is text searchable.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

hasSubEntities

public boolean hasSubEntities()
                       throws CMBException
Determines if this entity has sub entities.
Returns:
boolean result

getAttributeNames

public java.lang.String[] getAttributeNames()
                                     throws CMBNoConnectionException,
                                            CMBException
Gets the names of this entity's attributes
Returns:
array of attribute names

getAttributeTypes

public short[] getAttributeTypes()
                          throws CMBNoConnectionException,
                                 CMBException
Gets the types of this entity's attributes
Returns:
array of attribute types

getAttributes

public CMBAttribute[] getAttributes()
                             throws CMBNoConnectionException,
                                    CMBException
Gets the attribute objects for this entity
Returns:
array of attribute objects

getTextSearchAttribute

public CMBAttribute getTextSearchAttribute()
                                    throws CMBNoConnectionException,
                                           CMBException
Gets the attribute object for text seach on this entity. ICM only.
Returns:
The text search attribute, or null if there is none defined

getClassification

public short getClassification()
Gets the classification of the objects in this entity. The default value is CMBBaseConstant.CMB_CLASS_UNDEFINED. CM V8 only.
Returns:
The classification. Must be one of the following:
  • CMBBaseConstant.CMB_CLASS_UNDEFINED - indicates that this entity does not have an item type classification. This will be returned for backends other than CM V8.
  • CMBBaseConstant.CMB_CLASS_ITEM - indicates a non-resource item type
  • CMBBaseConstant.CMB_CLASS_RESOURCE_ITEM - indicates a resource item type
  • CMBBaseConstant.CMB_CLASS_ICM_DOC_MODEL - indicates an ICM document model item type
  • CMBBaseConstant.CMB_CLASS_ICM_DOC_PART - indicates an ICM document model document part type

getAttribute

public CMBAttribute getAttribute(java.lang.String attrName)
                          throws CMBNoConnectionException,
                                 CMBException
Gets a single attribute in this entity
Parameters:
attrName - the name of the desired attribute
Returns:
the attribute object

getAttributeType

public short getAttributeType(java.lang.String attrName)
                       throws CMBNoConnectionException,
                              CMBException
Gets the type of a single attribute in this entity
Parameters:
attrName - the name of the desired attribute
Returns:
the attribute type

getSubEntities

public CMBEntity[] getSubEntities()
                           throws CMBException
Get all the sub entities in this entity
Returns:
the array of entity objects

getName

public java.lang.String getName()
Return the name of the entity

getParentEntityName

public java.lang.String getParentEntityName()
Return the name of the parent entity, or an empty string if there is none.

getType

public short getType()
Returns the entity type, 0 by default

getVersionControl

public short getVersionControl()
Returns the version control of the entity
Returns:
short The version control type Value may be one of the following:
  • CMBBaseConstant.CMB_VERSION_CONTROL_NEVER - This entity does not support versioning
  • CMBBaseConstant.CMB_VERSION_CONTROL_ALWAYS_NEW - A new version is always created when an item in this entity is updated
  • CMBBaseConstant.CMB_VERSION_CONTROL_BY_APP - The application decides whether to update the existing version or create a new version
If versioning is not supported for a datastore, the function will always return CMBBaseConstant.CMB_VERSION_CONTROL_NEVER
See Also:
CMBConnection.isVersioningEnabled()

isRoot

public boolean isRoot()
Determines whether the entity describes a root component Only CM V8 has a distinction between root and non-root components. All other backends will return true for all entities.

isTextSearchable

public boolean isTextSearchable()
Determines whether the entity is text searchable.

getPartTypes

public java.lang.String[] getPartTypes()
                                throws CMBException
Returns:
document part type names that are predefined in this entity. ICM or Federation to ICM only

getPartTypeVersionPolicy

public int getPartTypeVersionPolicy()
Gets the value that controls the way versioning is performed. This will be one of the following values: ICM only.
Returns:
version control
Since:
8.1

EIP JavaBeans

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