Class ecm.model.admin.InterfaceTextConfig

Extends ecm.model.admin._ConfigurationObject.
Represents the configuration information for an application label, a system property label, or a desktop label in the user interface. This information includes:

The label key
The type of label: action, application, desktop, or system
The repository type for a repository label
The desktop identifier for a desktop label

Defined in: <ecm\model\admin\InterfaceTextConfig.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.model.admin.InterfaceTextConfig()

Method Summary

Method Attributes	Method Name and Description
	constructor(id, name)
	getClassicLabelKey()
	getDesktopId()
	getDisplayedIn()
	getInterfaceTextConfig(callback, params)
	getLabelData()
	getLabelKey()
	getLocaleData()
	getRepositoryId()
	getRepositoryLabel()
	getRepositoryType()
	getTooltipKey()
	getType()
	getUserData()
	hasLabelData()
<static>	ecm.model.admin.InterfaceTextConfig.InterfaceTextConfig.createInterfaceTextConfig(id) Static function that constructs an interface text config object.
<static>	ecm.model.admin.InterfaceTextConfig.InterfaceTextConfig.getUniqueId(sequenceNumber) Static function that creates a unique id by using time.
<static>	ecm.model.admin.InterfaceTextConfig.InterfaceTextConfig.updateConfiguration(configs, desktopId, callback, extraParams) Static function that updates InterfaceText and Desktop's application spaces at the same time.
<static>	ecm.model.admin.InterfaceTextConfig.InterfaceTextConfig.updateConfigurationOnly(configs, callback) Static function that updates InterfaceText and Desktop's application spaces at the same time.
	isCM()
	isOD()
	isP8()
	isTypeAction()
	isTypeApplication()
	isTypeDesktop()
	isTypeSystem()
	setDesktopId(id)
	setDisplayedIn(value)
	setLabelData(labelData)
	setLabelKey(key)
	setLocaleData(localeData)
	setRepositoryId(id)
	setRepositoryLabel(label)
	setRepositoryType(type)
	setType(type)
	setUserData(data)
	updateConfigs(configs, callback, extraParams)
	updateInterfaceTextConfig(callback, params)

Constructor Detail

ecm.model.admin.InterfaceTextConfig()

Method Detail

constructor(id, name)

Parameters:
id
name

getClassicLabelKey()

getDesktopId()

getDisplayedIn()

getInterfaceTextConfig(callback, params)

Parameters:
callback
params

getLabelData()

getLabelKey()

getLocaleData()

getRepositoryId()

getRepositoryLabel()

getRepositoryType()

getTooltipKey()

getType()

getUserData()

hasLabelData()

<static> ecm.model.admin.InterfaceTextConfig.InterfaceTextConfig.createInterfaceTextConfig(id)

Static function that constructs an interface text config object.

Parameters:
id: Interface text identifier.

<static> ecm.model.admin.InterfaceTextConfig.InterfaceTextConfig.getUniqueId(sequenceNumber)

Static function that creates a unique id by using time.

Parameters:
sequenceNumber: The sequence number to use to create the unique id.

<static> ecm.model.admin.InterfaceTextConfig.InterfaceTextConfig.updateConfiguration(configs, desktopId, callback, extraParams)

Static function that updates InterfaceText and Desktop's application spaces at the same time.

Parameters:
configs: JSON object to send to the configuration service API.
desktopId: The ID of the destktop to update
callback: A function to run after the service API call completes.
extraParams

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

<static> ecm.model.admin.InterfaceTextConfig.InterfaceTextConfig.updateConfigurationOnly(configs, callback)

Static function that updates InterfaceText and Desktop's application spaces at the same time.

Parameters:
configs: JSON Object to send to the configuration service API.
callback: A funciton to run after the service API call completes.

isCM()

isOD()

isP8()

isTypeAction()

isTypeApplication()

isTypeDesktop()

isTypeSystem()

setDesktopId(id)

Parameters:
id

setDisplayedIn(value)

Parameters:
value

setLabelData(labelData)

Parameters:
labelData

setLabelKey(key)

Parameters:
key

setLocaleData(localeData)

Parameters:
localeData

setRepositoryId(id)

Parameters:
id

setRepositoryLabel(label)

Parameters:
label

setRepositoryType(type)

Parameters:
type

setType(type)

Parameters:
type

setUserData(data)

Parameters:
data

updateConfigs(configs, callback, extraParams)

Parameters:
configs
callback
extraParams

updateInterfaceTextConfig(callback, params)

Parameters:
callback
params