RMClassDescription

```
public interface RMClassDescription
```
Repository class metadata description.
A specific class description can be acquired using the RMFactory.RMClassDescription factory class. All available class descriptions for a repository can be acquired using the Repository.fetchClassDescriptions method.

See Also:
RMFactory.RMClassDescription

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`allowsInstances()` Indicates whether or not objects based upon this class description can be instantiated.
`boolean`	`canIncludeDescendentPropertiesInQuery()` Indicates whether or not this class supports queries that include descendant properties.
`boolean`	`canIncludeSubclassesInQuery()` Indicates whether or not this class supports queries that include its subclasses.
`boolean`	`describedIsOfClass(java.lang.String classSymName)` Indicates whether or not the class described by this `RMClassDescription` instance is a subclass of the specified parent class.
`java.util.List<RMPropertyDescription>`	`getAllDescendentPropertyDescriptions()` Returns a collection of all `RMPropertyDescription` instances that belong to all subclasses of this class.
`java.lang.String`	`getDefaultInstanceOwner()` Returns the name of a user or group that is to be the default owner of a new instance of this class.
`java.util.List<RMPermission>`	`getDefaultInstancePermissions()` Returns a collection of `RMPermission` instances that are to be used as the default set of permissions for a new instance of this class.
`java.lang.String`	`getDescriptiveText()` Returns any descriptive text for this class.
`java.lang.String`	`getDisplayName()` Returns a displayable label for this class.
`java.lang.String`	`getId()` Returns the repository unique identifier for this class description.
`java.lang.Integer`	`getImmediateInheritedPropertyCount()` Specifies the number of `RMPropertyDescription` instances included in this class description that are inherited from the immediate superclass.
`java.util.List<RMClassDescription>`	`getImmediateSubclassDescriptions()` Returns a collection of `RMClassDescription` instances, each of which represents an immediate subclass of this class.
`java.lang.String`	`getName()` Returns a name string for this class description.
`java.lang.Integer`	`getNamePropertyIndex()` Specifies the 0-based index into the class' collection of `RMPropertyDescription` instances designating the `RMPropertyDescription` that represents the default "Name" property for the class, if any.
`RMPropertyDescription`	`getPropertyDescription(java.lang.String symbolicName)` Returns the `RMPropertyDescription` instance specified by its symbolic name from those property descriptions belonging to this class description.
`java.util.List<RMPropertyDescription>`	`getPropertyDescriptions()` Returns the collection of `RMPropertyDescription`s belonging to this class.
`RMClassDescription`	`getSuperclassDescription()` Returns the `RMClassDescription` of the immediate superclass of this class.
`java.lang.String`	`getSymbolicName()` Returns the locale-independent, symbolic name of this class.
`boolean`	`isCBREnabled()` Specifies whether this class (or an included property) is enabled for full text indexing (content-based retrieval).
`boolean`	`isHidden()` Indicates whether or not this class description describes a hidden class.

- Method Detail
  - allowsInstances
```
boolean allowsInstances()
```
    Indicates whether or not objects based upon this class description can be instantiated.
    
    Returns:
    true if instantiation is supported, false otherwise.
  - canIncludeSubclassesInQuery
```
boolean canIncludeSubclassesInQuery()
```
    Indicates whether or not this class supports queries that include its subclasses. Not supported for DomainType.P8_SRM.
    
    Returns:
    true if subclasses can be included in a query, false otherwise.
  - canIncludeDescendentPropertiesInQuery
```
boolean canIncludeDescendentPropertiesInQuery()
```
    Indicates whether or not this class supports queries that include descendant properties. A descendant property is a property that has been added to one or more subclasses of a given class. Not supported for DomainType.P8_SRM.
    
    Returns:
    true if descendant properties can be included in a query, false otherwise.
  - getAllDescendentPropertyDescriptions
```
java.util.List<RMPropertyDescription> getAllDescendentPropertyDescriptions()
```
    Returns a collection of all RMPropertyDescription instances that belong to all subclasses of this class. Not supported for DomainType.P8_SRM.
    
    Returns:
    A List<RMPropertyDescription>
  - getDefaultInstanceOwner
```
java.lang.String getDefaultInstanceOwner()
```
    Returns the name of a user or group that is to be the default owner of a new instance of this class. Not supported for DomainType.P8_SRM.
    
    Returns:
    A String value. Can be null if no default owner is defined.
  - getDefaultInstancePermissions
```
java.util.List<RMPermission> getDefaultInstancePermissions()
```
    Returns a collection of RMPermission instances that are to be used as the default set of permissions for a new instance of this class. Not supported for DomainType.P8_SRM.
    
    Returns:
    A List<RMPermission> collection.
  - getDescriptiveText
```
java.lang.String getDescriptiveText()
```
    Returns any descriptive text for this class.
    
    Returns:
    A String value. This entry can be null.
  - getDisplayName
```
java.lang.String getDisplayName()
```
    Returns a displayable label for this class.
    
    Returns:
    A String value.
  - getId
```
java.lang.String getId()
```
    Returns the repository unique identifier for this class description.
    
    Returns:
    A String value.
  - getImmediateSubclassDescriptions
```
java.util.List<RMClassDescription> getImmediateSubclassDescriptions()
```
    Returns a collection of RMClassDescription instances, each of which represents an immediate subclass of this class. Not supported for DomainType.P8_SRM.
    
    Returns:
    A List<RMClassDescription> collection.
  - getName
```
java.lang.String getName()
```
    Returns a name string for this class description.
    
    Returns:
    A String value.
  - getNamePropertyIndex
```
java.lang.Integer getNamePropertyIndex()
```
    Specifies the 0-based index into the class' collection of RMPropertyDescription instances designating the RMPropertyDescription that represents the default "Name" property for the class, if any. Not supported for DomainType.P8_SRM.
    
    Returns:
    An Integer value, or null if no "Name" property is defined for the class.
  - getPropertyDescriptions
```
java.util.List<RMPropertyDescription> getPropertyDescriptions()
```
    Returns the collection of RMPropertyDescriptions belonging to this class.
    
    Returns:
    A List<RMPropertyDescription>
  - getPropertyDescription
```
RMPropertyDescription getPropertyDescription(java.lang.String symbolicName)
```
    Returns the RMPropertyDescription instance specified by its symbolic name from those property descriptions belonging to this class description.
    
    Parameters:
    symbolicName - The symbolic name String of the desired property.
    
    Returns:
    The applicable RMPropertyDescription instance, or null if not found.
  - getSuperclassDescription
```
RMClassDescription getSuperclassDescription()
```
    Returns the RMClassDescription of the immediate superclass of this class. Not supported for DomainType.P8_SRM.
    
    Returns:
    A RMClassDescription instance.
  - getImmediateInheritedPropertyCount
```
java.lang.Integer getImmediateInheritedPropertyCount()
```
    Specifies the number of RMPropertyDescription instances included in this class description that are inherited from the immediate superclass. Not supported for DomainType.P8_SRM.
    
    Returns:
    An Integer value.
  - getSymbolicName
```
java.lang.String getSymbolicName()
```
    Returns the locale-independent, symbolic name of this class.
    
    Returns:
    A String value
  - isCBREnabled
```
boolean isCBREnabled()
```
    Specifies whether this class (or an included property) is enabled for full text indexing (content-based retrieval).
    This class description property must be true for any of its contained property descriptions to be enabled for CBR. It must also be true to enable full text indexing of any content associated with an instance of this class.
    Not supported for DomainType.P8_SRM.
    
    Returns:
    true if full text indexing is supported, false otherwise.
  - isHidden
```
boolean isHidden()
```
    Indicates whether or not this class description describes a hidden class. Not supported for DomainType.P8_SRM.
    
    Returns:
    true if hidden, false otherwise.
  - describedIsOfClass
```
boolean describedIsOfClass(java.lang.String classSymName)
```
    Indicates whether or not the class described by this RMClassDescription instance is a subclass of the specified parent class. Not supported for DomainType.P8_SRM.
    
    Parameters:
    classSymName - Symbolic name of the parent class to check this subclass against.
    
    Returns:
    true if the class described by this RMClassDescription is a subclass of the specified parent class; false otherwise.

allowsInstances

canIncludeSubclassesInQuery

canIncludeDescendentPropertiesInQuery

getAllDescendentPropertyDescriptions

getDefaultInstanceOwner

getDefaultInstancePermissions

getDescriptiveText

getDisplayName

getId

getImmediateSubclassDescriptions

getName

getNamePropertyIndex

getPropertyDescriptions

getPropertyDescription

getSuperclassDescription

getImmediateInheritedPropertyCount

getSymbolicName

isCBREnabled

isHidden

describedIsOfClass