Class ecm.model._ModelObject

Provides a base class from which all model objects are derived. The _ModelObject class provides common properties and logging for the other classes in the ecm.model package.

Private functions should not be used to access public members of the class. Access member variables directly. For example:

console.debug("Object name=" + obj.name);

Note: Private getter methods, such as getName, will be removed in a future release.
Defined in: <ecm\model\admin\FileTrackingLocation.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.model._ModelObject(properties) Constructs the model object.

Field Summary

Field Attributes	Field Name and Description
	categorization The parent which is used to decide what type of associated asynchronous tasks to list.
	id A string identifier of the object.
	isRecurring Whether this set of tasks is recurring.
	name The displayable name of the object.
	nameFilter a filter string to filter the list of tasks.
	pane The class of the task listing pane responsible for this category task.
	status The status of this particular set of tasks.
	type The type of this task.
	userId The user id associated with this type of task.

Method Summary

Method Attributes	Method Name and Description
	destroy() Destroys the _ModelObject
	onChange(modelObject) This event is invoked whenever the object changes value, or when a child object of this object changes value.
	own() Track handles created by this _ModelObject and remove/destroy them when the model object is destroyed, unless they have already been removed/destroyed manually.
	refresh() Clears any information that has been retrieved about the item and its subordinates, and signals the onChange event to force retrieval as needed.
	toString() Returns a string representation of the object.

Constructor Detail

ecm.model._ModelObject(properties)

Constructs the model object.

Parameters:

properties

The properties for the model object. These properties are accessible directly as fields of the object. The following properties are understood:

id: The identifier for the object, as known by the server.
name: The displayable name for the object.

Field Detail

categorization

The parent which is used to decide what type of associated asynchronous tasks to list.
Defined in: <ecm\model\TaskCategoryConfiguration.js>.

id

A string identifier of the object. This is not normally displayed to the user but is used to identify the corresponding object on the server. Typically, the id will be a symbolic or non-display name, or persistent identifier (PID) or globally unique identifier (GUID) depending on the server. In some cases it is a combination of other identifiers. The application should consider the id to be atomic and not parse the string as the format may change.
Defined in: <ecm\model\_ModelObject.js>.

isRecurring

Whether this set of tasks is recurring.
Defined in: <ecm\model\TaskCategoryConfiguration.js>.

name

The displayable name of the object. This string is intended to represent the object to the user. When available, locale specific names will be used according to the locale of the client browser.
Defined in: <ecm\model\_ModelObject.js>.

nameFilter

a filter string to filter the list of tasks.
Defined in: <ecm\model\TaskCategoryConfiguration.js>.

pane

The class of the task listing pane responsible for this category task.
Defined in: <ecm\model\TaskCategoryConfiguration.js>.

status

The status of this particular set of tasks.
Defined in: <ecm\model\TaskCategoryConfiguration.js>.

type

The type of this task.
Defined in: <ecm\model\TaskCategoryConfiguration.js>.

userId

The user id associated with this type of task.
Defined in: <ecm\model\TaskCategoryConfiguration.js>.

Method Detail

destroy()

Destroys the _ModelObject
Defined in: <ecm\model\_ModelObject.js>.

Since:: 2.0.3

onChange(modelObject)

This event is invoked whenever the object changes value, or when a child object of this object changes value. Note: If you change a field of a model object directly, such as the id or name, you should invoke this method to notify other model objects of the change.
Defined in: <ecm\model\_ModelObject.js>.

Parameters:
modelObject: Either this object or the child object that has changed.

own()

Track handles created by this _ModelObject and remove/destroy them when the model object is destroyed, unless they have already been removed/destroyed manually.
Defined in: <ecm\model\_ModelObject.js>.

Since:: 2.0.3

Returns:: The array of handles, so you can do for example: var handle = this.own(on(...));

refresh()

Clears any information that has been retrieved about the item and its subordinates, and signals the onChange event to force retrieval as needed.
Defined in: <ecm\model\_ModelObject.js>.

toString()

Returns a string representation of the object. This is useful for debugging purposes and should only be used in that way.
Defined in: <ecm\model\_ModelObject.js>.