com.filenet.api.meta
Interface ClassDescription

All Superinterfaces:
EngineObject, IndependentObject, Metadata, java.io.Serializable

public interface ClassDescription
extends Metadata, IndependentObject

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
AllowsInstances: false
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: false
IsHidden: false
Searchable: false
StorageType: Domain or ObjectStore
SuperclassName: Metadata


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

get_SuperclassPropertyCount

java.lang.Integer get_SuperclassPropertyCount()
Returns the value of the SuperclassPropertyCount property. For more information, see SuperclassPropertyCount Property.


get_NamePropertyIndex

java.lang.Integer get_NamePropertyIndex()
Returns the value of the NamePropertyIndex property. For more information, see NamePropertyIndex Property.


get_PropertyDescriptions

PropertyDescriptionList get_PropertyDescriptions()
Returns the value of the PropertyDescriptions property. For more information, see PropertyDescriptions Property.


get_HasIncludeSubclasses

java.lang.Boolean get_HasIncludeSubclasses()
Returns the value of the HasIncludeSubclasses property. For more information, see HasIncludeSubclasses Property.


get_HasProperSubclassProperties

java.lang.Boolean get_HasProperSubclassProperties()
Returns the value of the HasProperSubclassProperties property. For more information, see HasProperSubclassProperties Property.


get_ProperSubclassPropertyDescriptions

PropertyDescriptionList get_ProperSubclassPropertyDescriptions()
Returns the value of the ProperSubclassPropertyDescriptions property. For more information, see ProperSubclassPropertyDescriptions Property.


get_AllowsInstances

java.lang.Boolean get_AllowsInstances()
Returns the value of the AllowsInstances property. For more information, see AllowsInstances Property.


get_SymbolicName

java.lang.String get_SymbolicName()
Returns the value of the SymbolicName property. For more information, see SymbolicName Property.


get_Id

Id get_Id()
Returns the value of the Id property. For more information, see Id Property.


get_Name

java.lang.String get_Name()
Returns the value of the Name property. For more information, see Name Property.


get_IsPersistent

java.lang.Boolean get_IsPersistent()
Returns the value of the IsPersistent property. For more information, see IsPersistent Property.


get_IsHidden

java.lang.Boolean get_IsHidden()
Returns the value of the IsHidden property. For more information, see IsHidden Property.


get_IsSecurable

java.lang.Boolean get_IsSecurable()
Returns the value of the IsSecurable property. For more information, see IsSecurable Property.


get_PermissionDescriptions

AccessPermissionDescriptionList get_PermissionDescriptions()
Returns the value of the PermissionDescriptions property. For more information, see PermissionDescriptions Property.


get_DefaultInstancePermissions

AccessPermissionList get_DefaultInstancePermissions()
Returns the value of the DefaultInstancePermissions property. For more information, see DefaultInstancePermissions Property.


get_DefaultInstanceOwner

java.lang.String get_DefaultInstanceOwner()
Returns the value of the DefaultInstanceOwner property. For more information, see DefaultInstanceOwner Property.


get_IsCBREnabled

java.lang.Boolean get_IsCBREnabled()
Returns the value of the IsCBREnabled property. For more information, see IsCBREnabled Property.


describedIsOfClass

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). 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.

Parameters:
className - A String that specifies the symbolic name or ClassNames constant of the parent class to check this subclass against.
Returns:
true if the class specified by ClassName is a subclass of the class; false if it is not.

getScope

Scope getScope()
Returns the originating "scope" (enclosing context) of this ClassDescription object. For more information about ClassDescription scope, see the Scope interface description.

Returns:
A Scope object.

get_SuperclassDescription

ClassDescription get_SuperclassDescription()
Returns the value of the SuperclassDescription property. For more information, see SuperclassDescription Property.


get_ImmediateSubclassDescriptions

ClassDescriptionSet get_ImmediateSubclassDescriptions()
Returns the value of the ImmediateSubclassDescriptions property. For more information, see ImmediateSubclassDescriptions Property.



© Copyright IBM Corporation 2006, 2009. All rights reserved.