Class ecm.model.Configuration

Extends ecm.model._ModelObject.
Provides a model class used to work with configuration data. Only users with administration rights in IBM Content Navigator can use the methods provided by the class.
Defined in: <ecm\model\Configuration.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	action A string holding the jax-rs action name.

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

Method Summary

Method Attributes	Method Name and Description
	newConfigObj(params, callback) Creates a new a configuration object.
	onNewConfigObj(model) Method called when a new configuration object has been created.
	onRetrieveConfigObj(model) Method called when a configuration object has been retrieved.
	onRetrieveConfigObjList(list) Method called when a list of configuration objects have been retrieved.
	onSaveConfigObj(model) Method called when a new configuration object has been added to the configuration.
	retrieveConfigObj(params, callback) Retrieve a configuration object back based on the id.
	retrieveConfigObjList(params, callback) Retrieve a list of contained objects back based on type parameter and call the call-back method.
	saveConfigObj(params, callback) Adds a new configuration object or updates an existing object in IBM Content Navigator.

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

Constructor Detail

ecm.model.Configuration()

Field Detail

action

A string holding the jax-rs action name.

Method Detail

newConfigObj(params, callback)

Creates a new a configuration object.

Parameters:
params: Object containing:
configuration - Name of the configuration to create.

login_desktop - Optional desktop identifier.
callback: A call back method. Call-back method will be called at end with a Stateful model parameter.

Returns:: A dojo.Stateful model object

onNewConfigObj(model)

Method called when a new configuration object has been created.

Parameters:
model: An instance of a dojo.Stateful model object containing the configuration data.

onRetrieveConfigObj(model)

Method called when a configuration object has been retrieved.

Parameters:
model: An instance of a dojo.Stateful model object containing the configuration data.

onRetrieveConfigObjList(list)

Method called when a list of configuration objects have been retrieved.

Parameters:
list: An array of dojo.Stateful model objects containing the configuration data.

onSaveConfigObj(model)

Method called when a new configuration object has been added to the configuration.

Parameters:
model: An instance of a dojo.Stateful model object containing the configuration data.

retrieveConfigObj(params, callback)

Retrieve a configuration object back based on the id. Id and name is an internal private attribute provided in constructor. Id is the unique identifier and name is the configuration name such as "RepositoryConfig" or "DesktopConfig". User will need to create an configuration object first then use this method.

Parameters:
params: Object containing:
id - Identifier of the configuration object to retrieve

configuration - Name of the configuration being retrieved

type - The object type (e.g. "plugins", "viewers", "properties").

login_desktop - Optional desktop identifier.
callback: A call back method. Call-back method will be called at end with a Stateful model parameter.

Returns:: A dojo.Stateful model object

retrieveConfigObjList(params, callback)

Retrieve a list of contained objects back based on type parameter and call the call-back method. Each configuration object has supported type (e.g. "plugins", "viewers", "properties"). Please check its documentation to find out what type is supported. If type is not found, a empty list will be returned. Not all configuration support type.

Parameters:
params: Object containing:
type - The object type (e.g. "plugins", "viewers", "properties").

sorted - Optional boolean indicating if the list should be sorted

login_desktop - Option desktop identifier.
callback: A call back method. Call-back method will be called at end with a Stateful model parameter.

Returns:: An array of dojo.Stateful model objects

saveConfigObj(params, callback)

Adds a new configuration object or updates an existing object in IBM Content Navigator.

Parameters:
params: Object containing:
application - Name of the application containing the configuration.

login_desktop - Optional desktop identifier.

model - An instance of a dojo.Stateful object containing the data to add or update.
callback: A call back method. Call-back method will be called at end with a Stateful model parameter.