|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ClassDescription
Represents the fixed description (immutable metadata) of a class.
A ClassDescription
object maintains a fixed snapshot, via its properties and property descriptions,
of an instantiated object's property metadata throughout the object's lifetime.
Because all of its properties are read-only, you cannot directly modify a ClassDescription
object.
If you need to update the metadata of a class, use its ClassDefinition
object.
Metadata
Auditable: false
Method Summary | |
---|---|
java.lang.Boolean |
describedIsOfClass(java.lang.String className)
Returns whether the class described by this ClassDescription object is a subclass of the specified class (true ) or not (false ). |
java.lang.Boolean |
get_AllowsInstances()
Returns the value of the AllowsInstances property. |
java.lang.String |
get_DefaultInstanceOwner()
Returns the value of the DefaultInstanceOwner property. |
AccessPermissionList |
get_DefaultInstancePermissions()
Returns the value of the DefaultInstancePermissions property. |
java.lang.Boolean |
get_HasIncludeSubclasses()
Returns the value of the HasIncludeSubclasses property. |
java.lang.Boolean |
get_HasProperSubclassProperties()
Returns the value of the HasProperSubclassProperties property. |
Id |
get_Id()
Returns the value of the Id property. |
ClassDescriptionSet |
get_ImmediateSubclassDescriptions()
Returns the value of the ImmediateSubclassDescriptions property. |
java.lang.Boolean |
get_IsCBREnabled()
Returns the value of the IsCBREnabled property. |
java.lang.Boolean |
get_IsHidden()
Returns the value of the IsHidden property. |
java.lang.Boolean |
get_IsPersistent()
Returns the value of the IsPersistent property. |
java.lang.Boolean |
get_IsSecurable()
Returns the value of the IsSecurable property. |
java.lang.String |
get_Name()
Returns the value of the Name property. |
java.lang.Integer |
get_NamePropertyIndex()
Returns the value of the NamePropertyIndex property. |
AccessPermissionDescriptionList |
get_PermissionDescriptions()
Returns the value of the PermissionDescriptions property. |
PropertyDescriptionList |
get_ProperSubclassPropertyDescriptions()
Returns the value of the ProperSubclassPropertyDescriptions property. |
PropertyDescriptionList |
get_PropertyDescriptions()
Returns the value of the PropertyDescriptions property. |
ClassDescription |
get_SuperclassDescription()
Returns the value of the SuperclassDescription property. |
java.lang.Integer |
get_SuperclassPropertyCount()
Returns the value of the SuperclassPropertyCount property. |
java.lang.String |
get_SymbolicName()
Returns the value of the SymbolicName property. |
Scope |
getScope()
Returns the originating "scope" (enclosing context) of this ClassDescription object. |
Methods inherited from interface com.filenet.api.meta.Metadata |
---|
get_DescriptiveText, get_DisplayName, get_Ids |
Methods inherited from interface com.filenet.api.core.IndependentObject |
---|
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh |
Methods inherited from interface com.filenet.api.core.EngineObject |
---|
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses |
Method Detail |
---|
java.lang.Integer get_SuperclassPropertyCount()
java.lang.Integer get_NamePropertyIndex()
PropertyDescriptionList get_PropertyDescriptions()
java.lang.Boolean get_HasIncludeSubclasses()
java.lang.Boolean get_HasProperSubclassProperties()
PropertyDescriptionList get_ProperSubclassPropertyDescriptions()
java.lang.Boolean get_AllowsInstances()
java.lang.String get_SymbolicName()
Id get_Id()
java.lang.String get_Name()
java.lang.Boolean get_IsPersistent()
java.lang.Boolean get_IsHidden()
java.lang.Boolean get_IsSecurable()
AccessPermissionDescriptionList get_PermissionDescriptions()
AccessPermissionList get_DefaultInstancePermissions()
java.lang.String get_DefaultInstanceOwner()
java.lang.Boolean get_IsCBREnabled()
java.lang.Boolean describedIsOfClass(java.lang.String className)
ClassDescription
object is a subclass of the specified class (true
) or not (false
).
Note that this method will not work for search-related ClassDescription
objects; that is, ClassDescription
objects that are returned from
a SearchScope.fetchSearchableClassDescriptions
method call.
className
- A String
that specifies the symbolic name or ClassNames
constant of the parent class
to check this subclass against.
true
if the class specified by ClassName is a subclass of the class; false
if it is not.Scope getScope()
ClassDescription
object.
For more information about ClassDescription
scope, see the
Scope
interface description.
Scope
object.ClassDescription get_SuperclassDescription()
ClassDescriptionSet get_ImmediateSubclassDescriptions()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |