Content Engine Java API: ClassDefinition

All Superinterfaces:

EngineObject, IndependentlyPersistableObject, IndependentObject, Replicable, RepositoryObject, java.io.Serializable, Subscribable

All Known Subinterfaces:

CmQueueEntryClassDefinition, DocumentClassDefinition, EventClassDefinition, ReplicableClassDefinition, SubscribableClassDefinition, VersionableClassDefinition
```
public interface ClassDefinition
extends RepositoryObject, Replicable, Subscribable, IndependentlyPersistableObject
```
Represents the class definition (mutable class metadata) of non-versionable, non-subscribable classes. Subclasses of the Subscribable class are defined in SubscribableClassDefinition objects, except for the Document class and its subclasses, which are defined in DocumentClassDefinition objects, and the Event class and its subclasses, which are defined in EventClassDefinition objects. You can modify class definition metadata via its properties and property definitions throughout the life of an instantiated object. Note, however, that you cannot modify a class definition's ClassDescription property.
Metadata

Auditable: true
AllowsInstances: false
AllowsSubClasses: false
ClassDefinitionName: ReplicableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: Replicable

Method Summary

Methods
Modifier and Type	Method and Description
`ClassDefinition`	`createSubclass()` Creates a subclass of the class defined by this class definition.
`ClassDefinition`	`createSubclass(Id id)` Creates a subclass, with the specified ID, of the class defined by this class definition.
`IdList`	`get_AliasIds()` Returns the value of the AliasIds property.
`java.lang.Boolean`	`get_AllowsInstances()` Returns the value of the AllowsInstances property.
`java.lang.Boolean`	`get_AllowsPropertyAdditions()` Returns the value of the AllowsPropertyAdditions property.
`java.lang.Boolean`	`get_AllowsSubclasses()` Returns the value of the AllowsSubclasses property.
`EventSet`	`get_AuditedEvents()` Returns the value of the AuditedEvents property.
`java.lang.String`	`get_Creator()` Returns the value of the Creator property.
`java.util.Date`	`get_DateCreated()` Returns the value of the DateCreated property.
`java.util.Date`	`get_DateLastModified()` Returns the value of the DateLastModified property.
`java.lang.String`	`get_DefaultInstanceOwner()` Returns the value of the DefaultInstanceOwner property.
`AccessPermissionDescriptionList`	`get_DefaultInstancePermissionDescriptions()` Returns the value of the DefaultInstancePermissionDescriptions property.
`AccessPermissionList`	`get_DefaultInstancePermissions()` Returns the value of the DefaultInstancePermissions property.
`java.lang.Integer`	`get_DefaultRetentionPeriod()` Returns the value of the DefaultRetentionPeriod property.
`java.lang.String`	`get_DescriptiveText()` Returns the value of the DescriptiveText property.
`LocalizedStringList`	`get_DescriptiveTexts()` Returns the value of the DescriptiveTexts property.
`java.lang.String`	`get_DisplayName()` Returns the value of the DisplayName property.
`LocalizedStringList`	`get_DisplayNames()` Returns the value of the DisplayNames property.
`Id`	`get_Id()` Returns the value of the Id property.
`ClassDefinitionSet`	`get_ImmediateSubclassDefinitions()` Returns the value of the ImmediateSubclassDefinitions property.
`AddOn`	`get_InstalledByAddOn()` Returns the value of the InstalledByAddOn 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_IsSystemOwned()` Returns the value of the IsSystemOwned property.
`java.lang.String`	`get_LastModifier()` Returns the value of the LastModifier property.
`java.lang.String`	`get_Name()` Returns the value of the Name property.
`java.lang.String`	`get_Owner()` Returns the value of the Owner property.
`AccessPermissionList`	`get_Permissions()` Returns the value of the Permissions property.
`PropertyDefinitionList`	`get_PropertyDefinitions()` Returns the value of the PropertyDefinitions property.
`java.lang.Integer`	`get_ProtectedPropertyCount()` Returns the value of the ProtectedPropertyCount property.
`DurationUnits`	`get_RetentionPeriodUnits()` Returns the value of the RetentionPeriodUnits property.
`ClassDefinition`	`get_SuperclassDefinition()` Returns the value of the SuperclassDefinition property.
`java.lang.String`	`get_SymbolicName()` Returns the value of the SymbolicName property.
`TableDefinition`	`get_TableDefinition()` Returns the value of the TableDefinition property.
`ClassWorkflowSubscriptionSet`	`get_WorkflowSubscriptions()` Returns the value of the WorkflowSubscriptions property.
`void`	`set_AliasIds(IdList value)` Sets the value of the AliasIds property.
`void`	`set_AllowsInstances(java.lang.Boolean value)` Sets the value of the AllowsInstances property.
`void`	`set_Creator(java.lang.String value)` Sets the value of the Creator property.
`void`	`set_DateCreated(java.util.Date value)` Sets the value of the DateCreated property.
`void`	`set_DateLastModified(java.util.Date value)` Sets the value of the DateLastModified property.
`void`	`set_DefaultInstanceOwner(java.lang.String value)` Sets the value of the DefaultInstanceOwner property.
`void`	`set_DefaultInstancePermissions(AccessPermissionList value)` Sets the value of the DefaultInstancePermissions property.
`void`	`set_DefaultRetentionPeriod(java.lang.Integer value)` Sets the value of the DefaultRetentionPeriod property.
`void`	`set_DescriptiveTexts(LocalizedStringList value)` Sets the value of the DescriptiveTexts property.
`void`	`set_DisplayNames(LocalizedStringList value)` Sets the value of the DisplayNames property.
`void`	`set_IsCBREnabled(java.lang.Boolean value)` Sets the value of the IsCBREnabled property.
`void`	`set_IsHidden(java.lang.Boolean value)` Sets the value of the IsHidden property.
`void`	`set_LastModifier(java.lang.String value)` Sets the value of the LastModifier property.
`void`	`set_Owner(java.lang.String value)` Sets the value of the Owner property.
`void`	`set_Permissions(AccessPermissionList value)` Sets the value of the Permissions property.
`void`	`set_PropertyDefinitions(PropertyDefinitionList value)` Sets the value of the PropertyDefinitions property.
`void`	`set_RetentionPeriodUnits(DurationUnits value)` Sets the value of the RetentionPeriodUnits property.
`void`	`set_SymbolicName(java.lang.String value)` Sets the value of the SymbolicName property.

Methods inherited from interface com.filenet.api.core.RepositoryObject
getObjectStore

Methods inherited from interface com.filenet.api.replication.Replicable
get_ExternalReplicaIdentities, get_ReplicationGroup, set_ExternalReplicaIdentities, set_ReplicationGroup

Methods inherited from interface com.filenet.api.core.Subscribable
raiseEvent

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber

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_Creator
```
java.lang.String get_Creator()
```
    Returns the value of the Creator property. For more information, see Creator Property.
  - set_Creator
```
void set_Creator(java.lang.String value)
```
    Sets the value of the Creator property. For more information, see Creator Property.
  - get_DateCreated
```
java.util.Date get_DateCreated()
```
    Returns the value of the DateCreated property. For more information, see DateCreated Property.
  - set_DateCreated
```
void set_DateCreated(java.util.Date value)
```
    Sets the value of the DateCreated property. For more information, see DateCreated Property.
  - get_LastModifier
```
java.lang.String get_LastModifier()
```
    Returns the value of the LastModifier property. For more information, see LastModifier Property.
  - set_LastModifier
```
void set_LastModifier(java.lang.String value)
```
    Sets the value of the LastModifier property. For more information, see LastModifier Property.
  - get_DateLastModified
```
java.util.Date get_DateLastModified()
```
    Returns the value of the DateLastModified property. For more information, see DateLastModified Property.
  - set_DateLastModified
```
void set_DateLastModified(java.util.Date value)
```
    Sets the value of the DateLastModified property. For more information, see DateLastModified 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_AuditedEvents
```
EventSet get_AuditedEvents()
```
    Returns the value of the AuditedEvents property. For more information, see AuditedEvents Property.
  - get_Owner
```
java.lang.String get_Owner()
```
    Returns the value of the Owner property. For more information, see Owner Property.
  - set_Owner
```
void set_Owner(java.lang.String value)
```
    Sets the value of the Owner property. For more information, see Owner Property.
  - get_Permissions
```
AccessPermissionList get_Permissions()
```
    Returns the value of the Permissions property. For more information, see Permissions Property.
  - set_Permissions
```
void set_Permissions(AccessPermissionList value)
```
    Sets the value of the Permissions property. For more information, see Permissions Property.
  - get_IsSystemOwned
```
java.lang.Boolean get_IsSystemOwned()
```
    Returns the value of the IsSystemOwned property. For more information, see IsSystemOwned Property.
  - get_AliasIds
```
IdList get_AliasIds()
```
    Returns the value of the AliasIds property. For more information, see AliasIds Property.
  - set_AliasIds
```
void set_AliasIds(IdList value)
```
    Sets the value of the AliasIds property. For more information, see AliasIds Property.
  - get_DisplayName
```
java.lang.String get_DisplayName()
```
    Returns the value of the DisplayName property. For more information, see DisplayName Property.
  - get_DescriptiveText
```
java.lang.String get_DescriptiveText()
```
    Returns the value of the DescriptiveText property. For more information, see DescriptiveText Property.
  - get_DisplayNames
```
LocalizedStringList get_DisplayNames()
```
    Returns the value of the DisplayNames property. For more information, see DisplayNames Property.
  - set_DisplayNames
```
void set_DisplayNames(LocalizedStringList value)
```
    Sets the value of the DisplayNames property. For more information, see DisplayNames Property.
  - get_DescriptiveTexts
```
LocalizedStringList get_DescriptiveTexts()
```
    Returns the value of the DescriptiveTexts property. For more information, see DescriptiveTexts Property.
  - set_DescriptiveTexts
```
void set_DescriptiveTexts(LocalizedStringList value)
```
    Sets the value of the DescriptiveTexts property. For more information, see DescriptiveTexts Property.
  - get_SuperclassDefinition
```
ClassDefinition get_SuperclassDefinition()
```
    Returns the value of the SuperclassDefinition property. For more information, see SuperclassDefinition Property.
  - get_ProtectedPropertyCount
```
java.lang.Integer get_ProtectedPropertyCount()
```
    Returns the value of the ProtectedPropertyCount property. For more information, see ProtectedPropertyCount Property.
  - get_ImmediateSubclassDefinitions
```
ClassDefinitionSet get_ImmediateSubclassDefinitions()
```
    Returns the value of the ImmediateSubclassDefinitions property. For more information, see ImmediateSubclassDefinitions Property.
  - get_IsPersistent
```
java.lang.Boolean get_IsPersistent()
```
    Returns the value of the IsPersistent property. For more information, see IsPersistent Property.
  - get_AllowsInstances
```
java.lang.Boolean get_AllowsInstances()
```
    Returns the value of the AllowsInstances property. For more information, see AllowsInstances Property.
  - set_AllowsInstances
```
void set_AllowsInstances(java.lang.Boolean value)
```
    Sets the value of the AllowsInstances property. For more information, see AllowsInstances Property.
  - get_AllowsSubclasses
```
java.lang.Boolean get_AllowsSubclasses()
```
    Returns the value of the AllowsSubclasses property. For more information, see AllowsSubclasses Property.
  - get_AllowsPropertyAdditions
```
java.lang.Boolean get_AllowsPropertyAdditions()
```
    Returns the value of the AllowsPropertyAdditions property. For more information, see AllowsPropertyAdditions Property.
  - get_PropertyDefinitions
```
PropertyDefinitionList get_PropertyDefinitions()
```
    Returns the value of the PropertyDefinitions property. For more information, see PropertyDefinitions Property.
  - set_PropertyDefinitions
```
void set_PropertyDefinitions(PropertyDefinitionList value)
```
    Sets the value of the PropertyDefinitions property. For more information, see PropertyDefinitions Property.
  - get_TableDefinition
```
TableDefinition get_TableDefinition()
```
    Returns the value of the TableDefinition property. For more information, see TableDefinition Property.
  - get_SymbolicName
```
java.lang.String get_SymbolicName()
```
    Returns the value of the SymbolicName property. For more information, see SymbolicName Property.
  - set_SymbolicName
```
void set_SymbolicName(java.lang.String value)
```
    Sets the value of the SymbolicName property. For more information, see SymbolicName Property.
  - get_WorkflowSubscriptions
```
ClassWorkflowSubscriptionSet get_WorkflowSubscriptions()
```
    Returns the value of the WorkflowSubscriptions property. For more information, see WorkflowSubscriptions Property.
  - get_IsHidden
```
java.lang.Boolean get_IsHidden()
```
    Returns the value of the IsHidden property. For more information, see IsHidden Property.
  - set_IsHidden
```
void set_IsHidden(java.lang.Boolean value)
```
    Sets the value of the IsHidden property. For more information, see IsHidden Property.
  - get_DefaultInstancePermissions
```
AccessPermissionList get_DefaultInstancePermissions()
```
    Returns the value of the DefaultInstancePermissions property. For more information, see DefaultInstancePermissions Property.
  - set_DefaultInstancePermissions
```
void set_DefaultInstancePermissions(AccessPermissionList value)
```
    Sets the value of the DefaultInstancePermissions property. For more information, see DefaultInstancePermissions Property.
  - get_DefaultInstancePermissionDescriptions
```
AccessPermissionDescriptionList get_DefaultInstancePermissionDescriptions()
```
    Returns the value of the DefaultInstancePermissionDescriptions property. For more information, see DefaultInstancePermissionDescriptions Property.
  - get_DefaultInstanceOwner
```
java.lang.String get_DefaultInstanceOwner()
```
    Returns the value of the DefaultInstanceOwner property. For more information, see DefaultInstanceOwner Property.
  - set_DefaultInstanceOwner
```
void set_DefaultInstanceOwner(java.lang.String value)
```
    Sets 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.
  - set_IsCBREnabled
```
void set_IsCBREnabled(java.lang.Boolean value)
```
    Sets the value of the IsCBREnabled property. For more information, see IsCBREnabled Property.
  - get_InstalledByAddOn
```
AddOn get_InstalledByAddOn()
```
    Returns the value of the InstalledByAddOn property. For more information, see InstalledByAddOn Property.
  - get_DefaultRetentionPeriod
```
java.lang.Integer get_DefaultRetentionPeriod()
```
    Returns the value of the DefaultRetentionPeriod property. For more information, see DefaultRetentionPeriod Property.
  - set_DefaultRetentionPeriod
```
void set_DefaultRetentionPeriod(java.lang.Integer value)
```
    Sets the value of the DefaultRetentionPeriod property. For more information, see DefaultRetentionPeriod Property.
  - get_RetentionPeriodUnits
```
DurationUnits get_RetentionPeriodUnits()
```
    Returns the value of the RetentionPeriodUnits property. For more information, see RetentionPeriodUnits Property.
  - set_RetentionPeriodUnits
```
void set_RetentionPeriodUnits(DurationUnits value)
```
    Sets the value of the RetentionPeriodUnits property. For more information, see RetentionPeriodUnits Property.
  - createSubclass
```
ClassDefinition createSubclass()
```
    Creates a subclass of the class defined by this class definition. If this class is not allowed to be subclassed, an exception will be thrown.
    
    Returns:
    A ClassDefinition object that defines the new subclass.
  - createSubclass
```
ClassDefinition createSubclass(Id id)
```
    Creates a subclass, with the specified ID, of the class defined by this class definition. If this class is not allowed to be subclassed, an exception will be thrown.
    
    Parameters:
    id - An Id object that specifies the ID of the new subclass.
    
    Returns:
    A ClassDefinition object that defines the new subclass.

Methods inherited from interface com.filenet.api.core.RepositoryObject

Methods inherited from interface com.filenet.api.replication.Replicable

Methods inherited from interface com.filenet.api.core.Subscribable

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject

Methods inherited from interface com.filenet.api.core.IndependentObject

Methods inherited from interface com.filenet.api.core.EngineObject

get_Creator

set_Creator

get_DateCreated

set_DateCreated

get_LastModifier

set_LastModifier

get_DateLastModified

set_DateLastModified

get_Id

get_Name

get_AuditedEvents

get_Owner

set_Owner

get_Permissions

set_Permissions

get_IsSystemOwned

get_AliasIds

set_AliasIds

get_DisplayName

get_DescriptiveText

get_DisplayNames

set_DisplayNames

get_DescriptiveTexts

set_DescriptiveTexts

get_SuperclassDefinition

get_ProtectedPropertyCount

get_ImmediateSubclassDefinitions

get_IsPersistent

get_AllowsInstances

set_AllowsInstances

get_AllowsSubclasses

get_AllowsPropertyAdditions

get_PropertyDefinitions

set_PropertyDefinitions

get_TableDefinition

get_SymbolicName

set_SymbolicName

get_WorkflowSubscriptions

get_IsHidden

set_IsHidden

get_DefaultInstancePermissions

set_DefaultInstancePermissions

get_DefaultInstancePermissionDescriptions

get_DefaultInstanceOwner

set_DefaultInstanceOwner

get_IsCBREnabled

set_IsCBREnabled

get_InstalledByAddOn

get_DefaultRetentionPeriod

set_DefaultRetentionPeriod

get_RetentionPeriodUnits

set_RetentionPeriodUnits

createSubclass

createSubclass