public interface RMClassDescription
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.
RMFactory.RMClassDescription
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.
|
boolean allowsInstances()
true
if instantiation is supported, false
otherwise.boolean canIncludeSubclassesInQuery()
true
if subclasses can be included in a query, false
otherwise.boolean canIncludeDescendentPropertiesInQuery()
true
if descendant properties can be included in a query, false
otherwise.java.util.List<RMPropertyDescription> getAllDescendentPropertyDescriptions()
RMPropertyDescription
instances that belong to
all subclasses of this class.List<RMPropertyDescription
>
java.lang.String getDefaultInstanceOwner()
String
value. Can be null
if no default owner is defined.java.util.List<RMPermission> getDefaultInstancePermissions()
RMPermission
instances that are to be used as the
default set of permissions for a new instance of this class.List<RMPermission
>
collection.java.lang.String getDescriptiveText()
String
value. This entry can be null
.java.lang.String getDisplayName()
String
value.java.lang.String getId()
String
value.java.util.List<RMClassDescription> getImmediateSubclassDescriptions()
RMClassDescription
instances, each of which
represents an immediate subclass of this class.List<RMClassDescription>
collection.java.lang.String getName()
String
value.java.lang.Integer getNamePropertyIndex()
RMPropertyDescription
instances
designating the RMPropertyDescription
that represents the default "Name" property
for the class, if any.Integer
value, or null
if no "Name" property is defined
for the class.java.util.List<RMPropertyDescription> getPropertyDescriptions()
RMPropertyDescription
s belonging to this class.List<RMPropertyDescription
>
RMPropertyDescription getPropertyDescription(java.lang.String symbolicName)
RMPropertyDescription
instance specified by its symbolic name
from those property descriptions belonging to this class description.symbolicName
- The symbolic name String
of the desired property.RMPropertyDescription
instance, or null
if not found.RMClassDescription getSuperclassDescription()
RMClassDescription
of the immediate superclass of this class.RMClassDescription
instance.java.lang.Integer getImmediateInheritedPropertyCount()
RMPropertyDescription
instances included in this class description
that are inherited from the immediate superclass.Integer
value.java.lang.String getSymbolicName()
String
valueboolean isCBREnabled()
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.
true
if full text indexing is supported, false
otherwise.boolean isHidden()
true
if hidden, false
otherwise.boolean describedIsOfClass(java.lang.String classSymName)
RMClassDescription
instance is a subclass of the specified parent class.classSymName
- Symbolic name of the parent class to check this subclass against.true
if the class described by this RMClassDescription
is a subclass of the specified parent class; false
otherwise.© Copyright IBM Corp. 2010, 2013. All Rights Reserved.