Class ecm.model.ContentClass


Extends ecm.model._ModelObject.
Represents a single class of items in the repository. The type of class that is represented depends on the repository:

Repository Items in class
IBM Content Manager Item type
IBM FileNet P8 Class
IBM Content Manager OnDemand Application

Defined in: <ecm\model\ContentClass.js>.

Constructor Summary

Constructor Attributes Constructor Name and Description
 
Constructs a content class model object.

Field Summary

Field Attributes Field Name and Description
 
An array of ecm.model.AttributeDefinition objects.
 
A boolean value indicating if this content class can have instances on the server.
 
An array of ecm.model.AttributeDefinition objects for the attributes of this content class.
 
An object that references, by attribute name, the ecm.model.AttributeDefinition objects for the attributes of this content class.
 
IBM Content Manager only.
 
IBM Content Manager only.
 
A boolean value indicating if EDS is enabled for this class.
 
A boolean value indicating whether this content class is supported only for folders.
 
A boolean value indicating whether this class is hierarchical.
 
Content Management Interoperability Services (CMIS) only.
 
IBM Content Manager only.
 
IBM Content Manager only.
 
Holds the name attribute value for the content class.
 
A boolean value indicating whether this content class is supported for objects other than folders.
 
IBM FileNet P8 only.
 
The P8 content class id string (symbolic name) of the parent content class of this content class.
 
The privilege properties granted by this content class.
 
A boolean value indicating if this content class is a pseudo class.
 
An instance of ecm.model.Repository for the content repository containing the content class.
 
A boolean value indicating if content item instances of this class can store content.
 
An array of ecm.model.ContentClass objects holding sub classes of this content class
 
IBM Content Manager only.
 
IBM Content Manager only.
 
IBM Content Manager only.
 
A boolean value to indicate if this class is the default for a teamspace.
 
A boolean value indicating when this class supports text based searching.
 
IBM Content Manager only.
Fields borrowed from class ecm.model._ModelObject:
categorization, id, isRecurring, name, nameFilter, pane, status, type, userId

Method Summary

Method Attributes Method Name and Description
 
Returns a clone of this content class.
 
hasPrivilege(privilege)
Returns true if this content class grants the privilege.
 
Retrieves the default instance permissions from this content class.
 
retrieveSubClasses(callback, filterType)
Retrieves the content classes that derive from this content class.
Methods borrowed from class ecm.model._ModelObject:
destroy, onChange, own, refresh, toString

Constructor Detail

ecm.model.ContentClass(properties)

Constructs a content class model object.
Parameters:
properties
The properties for the content class. The properties can be any of the public fields as defined below and on ecm.model._ModelObject.

Field Detail

allAttributeDefinitions

An array of ecm.model.AttributeDefinition objects. Used in Searches.

allowsInstances

A boolean value indicating if this content class can have instances on the server.

attributeDefinitions

An array of ecm.model.AttributeDefinition objects for the attributes of this content class.

attributeDefinitionsById

An object that references, by attribute name, the ecm.model.AttributeDefinition objects for the attributes of this content class.

classification

IBM Content Manager only. The classification, one of the ecm.model.ContentClass.CLASSIFICATION values.

defaultSecurityFromClass

IBM Content Manager only. A boolean value indicating whether a new ecm.model.ContentItem instance of this content class will be assigned the item type security (true) or the current user's default security for new items (false). This setting applies when this content class is configured for item security (itemTypeSecurity is false).
Since:
2.0.3

edsIsEnabled

A boolean value indicating if EDS is enabled for this class.
Since:
2.0.3.6

forFoldersOnly

A boolean value indicating whether this content class is supported only for folders.

hierarchical

A boolean value indicating whether this class is hierarchical.

includedInSuperClassQuery

Content Management Interoperability Services (CMIS) only. A boolean value indicating whether items of this class may be returned when you query against one of its ancestor classes.
Since:
2.0.3.8

inheritSecurityFromParentFolder

IBM Content Manager only. A boolean value indicating whether a new ecm.model.ContentItem instance of this content class will inherit the security settings from the folder where the new instance is filed. This setting applies when this content class is configured for item security (itemTypeSecurity is false).

For information about determining how an access control list (ACL) is assigned when an IBM Content Manager item is created, see: ACL assignment when an item is created.

Since:
2.0.3

itemTypeSecurity

IBM Content Manager only. A boolean value indicating whether this content class uses the item type security for all ecm.model.ContentItem instances of this content class. If this value is false, security is assigned to each ecm.model.ContentItem instance of this content class.

nameAttribute

Holds the name attribute value for the content class.

notForFolders

A boolean value indicating whether this content class is supported for objects other than folders.

objectStore

IBM FileNet P8 only. This is an object valued property where the object store information is stored in the properties id, symbolicName, and displayName.

parentClassId

The P8 content class id string (symbolic name) of the parent content class of this content class. The value is not assigned until after the ecm.model.ContentClass method retrieveAttributeDefinitions is called.
Since:
2.0.2

privileges

The privilege properties granted by this content class. Privileges should be checked by calling the hasPrivilege(privilege) method.
Since:
2.0.2

pseudoClass

A boolean value indicating if this content class is a pseudo class.

repository

An instance of ecm.model.Repository for the content repository containing the content class.

storesContent

A boolean value indicating if content item instances of this class can store content.

subClasses

An array of ecm.model.ContentClass objects holding sub classes of this content class

supportsBoxShareTracking

IBM Content Manager only. A boolean value indicating whether or not this class supports tracking Box share items.
Since:
2.0.3.6

supportsEntryTemplateFolderAssociations

IBM Content Manager only. A boolean value indicating whether or not entry templates can be associated with hierarchical folder instances of this class.
Since:
2.0.3

supportsEntryTemplateTracking

IBM Content Manager only. A boolean value indicating whether or not this class supports tracking the entry template used to create items of this class.
Since:
2.0.3

teamspaceDefault

A boolean value to indicate if this class is the default for a teamspace.

textSearchable

A boolean value indicating when this class supports text based searching.

versionControl

IBM Content Manager only. The version control, one of the ecm.model.ContentClass.VERSION_CONTROL values.

Method Detail

clone()

Returns a clone of this content class. All contents are cloned except for the repository and subClasses properties. The references are copied. References to the content class are replaced with a reference to the cloned content class.
Since:
2.0.3

hasPrivilege(privilege)

Returns true if this content class grants the privilege. If the privilege name is not found then it is assumed to be granted.
Parameters:
privilege
Since:
2.0.2

retrieveDefaultInstancePermissions(callback, callback)

Retrieves the default instance permissions from this content class.
Parameters:
callback
A function that is invoked when the default instance permissions have been retrieved. An ecm.model.Permission object for the default instance permissions.
callback
Since:
2.0.3 Set to true to not replacing the #CREATOR_OWNER account with the current signed in user. (FileNet P8 only)

retrieveSubClasses(callback, filterType)

Retrieves the content classes that derive from this content class.
Parameters:
callback
A function that is invoked when the subclasses have been retrieved. An array of ecm.model.ContentClass objects for the subclasses are passed to the function.
filterType
A string specifying the type of filter.