Class ecm.model.ContentClassTreeModel

Extends ecm.model._ModelObject.
Represents a tree that is used to display the hierarchy for content classes in a repository. The ContentClassTreeModel class implements the Dojo dijit.tree.model class.
Defined in: <ecm\model\ContentClassTreeModel.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.model.ContentClassTreeModel()

Fields borrowed from class ecm.model._ModelObject:: categorization, id, isRecurring, name, nameFilter, pane, status, type, userId

Method Summary

Method Attributes	Method Name and Description
	addAllClass() Adds the pseudo `All` class from the list of classes.
	constructor(repository, hasAll, filterType, excludedItems, itemList, objectStore) Constructs the tree.
	destroy() Destroys the model.
	fetchItemByIdentity(keywordArgs) This method is not implemented.
	getChildren(parentItem, onComplete) Obtains the children of a given item.
	getIdentity(item) Returns the identity for an item.
	getLabel(item) Returns a displayable name for an item.
	getRoot(onItem)
	isItem(something) Returns `true` if the object is modeled by this tree model.
	mayHaveChildren(item) Returns `true` if the item might have children.
	newItem(args, parent, insertIndex) This method is not implemented.
	onChange(item) Callback whenever an item has changed, so that Tree can update the label, icon, and so on.
	onChildrenChange(parent, newChildrenList) A callback function that is called to send notifications about new, updated, or deleted items.
	onProcessingComplete(item) This event is triggered when the model completes processing an item.
	onProcessingStarted(item) This event is triggered when the model begins processing an item.
	pasteItem(childItem, oldParentItem, newParentItem, bCopy) This method is not implemented.
	reload(parent, callback) Will cause a re-retrieval of the parent folder.
	removeAllClass() Removes the pseudo `All` class from the list of classes.
	setBaseClass(className, classLabel) For FileNet P8 repositories, sets the base calls for the tree.
	setBaseContentClass(contentClass) For CMIS repositories, sets the base class for the tree.
	setExcludedItems(excludedItems) Specifies a list of classes to exclude.
	setRepository(repository) Sets the repository containing the content classes.

Methods borrowed from class ecm.model._ModelObject:: own, refresh, toString

Constructor Detail

ecm.model.ContentClassTreeModel()

Method Detail

addAllClass()

Adds the pseudo All class from the list of classes.

constructor(repository, hasAll, filterType, excludedItems, itemList, objectStore)

Constructs the tree.

Parameters:
repository: An instance of ecm.model.Repository for the repository containing the content classes.
hasAll: If set to true, then the model includes a pseudo class called All. In search this parameter is used to get all properties. IBM Content Manager only.
filterType: Filters the items displayed on the tree. Used when getting children for an item.
excludedItems: An array of content class id strings for content classes to exclude.
itemList: Optional parameter to specify a list of items/classes to return, only these items will be shown. Value should be an array of item/class IDs.
objectStore: IBM FileNet P8 only. Optional parameter to specify a FileNet P8 object store when the associated class is from a FileNet P8 object store that is different from the active repository. This is an object valued property where the object store information is stored in the properties id, symbolicName, and displayName.

destroy()

Destroys the model. Note: This function is required by dijit.tree.model

fetchItemByIdentity(keywordArgs)

This method is not implemented.

Parameters:
keywordArgs

getChildren(parentItem, onComplete)

Obtains the children of a given item.

Parameters:
parentItem: The item from which to return the children.
onComplete: A function invoked when the children have been obtained. It is passed an array containing the child items of the parent item.

getIdentity(item)

Returns the identity for an item.

Parameters:
item: The item for which to provide an identity.

getLabel(item)

Returns a displayable name for an item.

Parameters:
item: The item for which to provide a displayable name.

Returns:: String name for the item.

getRoot(onItem)

Parameters:
onItem

isItem(something)

Returns true if the object is modeled by this tree model.

Parameters:
something: An object to test.

mayHaveChildren(item)

Returns true if the item might have children.

Parameters:
item: The item to test.

Returns:: Boolean indicating if the item might have children.

newItem(args, parent, insertIndex)

This method is not implemented. See dojo.data.api.Write for details.

Parameters:
args
parent
insertIndex

onChange(item)

Callback whenever an item has changed, so that Tree can update the label, icon, and so on. Note that changes to an item's children or parent(s) will trigger an onChildrenChange() so you can ignore those changes here.

Parameters:
item: A dojo.data.Item object.

onChildrenChange(parent, newChildrenList)

A callback function that is called to send notifications about new, updated, or deleted items.

Parameters:
parent: A dojo.data.Item.
newChildrenList: An array of dojo.data.Item objects.

onProcessingComplete(item)

This event is triggered when the model completes processing an item. It is intended to allow tree widgets to remove display of progress indicators.

Parameters:
item: Item to which processing is completed.

onProcessingStarted(item)

This event is triggered when the model begins processing an item. It is intended to allow tree widgets to display a progress indicator next to the node for the item.

Parameters:
item: Item to which processing is started.

pasteItem(childItem, oldParentItem, newParentItem, bCopy)

This method is not implemented. see dojo.data.api.Write for details.

Parameters:
childItem
oldParentItem
newParentItem
bCopy

reload(parent, callback)

Will cause a re-retrieval of the parent folder.

Parameters:
parent
callback

removeAllClass()

Removes the pseudo All class from the list of classes.

setBaseClass(className, classLabel)

For FileNet P8 repositories, sets the base calls for the tree. Usually this is the Document class.

Parameters:
className: The identifier of the ContentClass for the class.
classLabel: The displayable name for the class.

setBaseContentClass(contentClass)

For CMIS repositories, sets the base class for the tree. Usually this is the cmis:document class.

Parameters:
contentClass: The ContentClass to be set as root.

setExcludedItems(excludedItems)

Specifies a list of classes to exclude. These classes will not appear in the tree model.

Parameters:
excludedItems: An array of content class ID strings for content classes to exclude.

setRepository(repository)

Sets the repository containing the content classes. This is useful in cases where the repository is switched but the user interface associated with the tree model is not, so the classes should reflect those of the new repository.

Parameters:
repository: An instance of ecm.model.Repository.