Class ecm.model.Container

Extends ecm.model._ModelObject.
Represents the information that is used to authenticate with an application server.
Defined in: <ecm\model\Container.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.model.Container(properties) Constructor

Field Summary

Field Attributes	Field Name and Description
	connected A boolean flag set to true if this user is connected through this container.
	desktop The desktop object ecm.model.Desktop
	fullUserId Do not use.
	type Type of container.
	userDisplayName The full, display user name for the user logged into the container.
	userid
	userId The user Id for the user logged into the container.
	userLoginName The login name used to login to the container.

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

Method Summary

Method Attributes	Method Name and Description
	containerLogoff() Disconnects from the server.
	containerLogon(password, callback) Connects to the server and authenticates with the provided password.
	onAddTeamspace(repository) An event function that is invoked when a teamspace has been added successfully.
	onAddTeamspaceTemplate(repository) An event function that is invoked when teamspace templates have been added successfully.
	onChange(modelObject) Event function, called when the repository has changed or cached information has been cleared due to a call to refresh.
	onConnected(container) An event function that is invoked when login completes successfully.
	onDisconnected(repository) An event function that is invoked when logout completes successfully.
	onTeamspaceListChange(repository) Triggered when the list of teamspaces have been changed.
	onTeamspaceTemplateListChange(repository) Triggered when the list of teamspace templates have been changed.
	onWorklistContainersRetrieved(repository) An event function that is invoked when worklist containers are retrieved successfully.

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

Constructor Detail

ecm.model.Container(properties)

Constructor

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

Field Detail

connected

A boolean flag set to true if this user is connected through this container.

desktop

The desktop object ecm.model.Desktop

Deprecated:: Use global ecm.model.desktop reference instead.

fullUserId

Do not use. This property was removed for security reasons.

type

Type of container.

userDisplayName

The full, display user name for the user logged into the container. (Valid when connected.)

userid

Deprecated:: Was never used or set internally. Use userId instead.

userId

The user Id for the user logged into the container. (Valid when connected.)

userLoginName

The login name used to login to the container. (Valid when connected.)

Since:: 2.0.3.8

Method Detail

containerLogoff()

Disconnects from the server.

containerLogon(password, callback)

Connects to the server and authenticates with the provided password.

Parameters:
password: The password to use for login.
callback: A function that is invoked on successfully logging on to the server.

onAddTeamspace(repository)

An event function that is invoked when a teamspace has been added successfully.

Parameters:
repository

Deprecated:: Use Repository onAddTeamspace event.

onAddTeamspaceTemplate(repository)

An event function that is invoked when teamspace templates have been added successfully.

Parameters:
repository

Deprecated:: Use Repository onAddTeamspaceTemplate event.

onChange(modelObject)

Event function, called when the repository has changed or cached information has been cleared due to a call to refresh.

Parameters:
modelObject: The instance of the particular ecm.model object that changed. This could be this repository object or a nested object.

onConnected(container)

An event function that is invoked when login completes successfully.

Parameters:
container

onDisconnected(repository)

An event function that is invoked when logout completes successfully.

Parameters:
repository

onTeamspaceListChange(repository)

Triggered when the list of teamspaces have been changed.

Parameters:
repository

Deprecated:: Use Repository onTeamspaceListChange event.

onTeamspaceTemplateListChange(repository)

Triggered when the list of teamspace templates have been changed.

Parameters:
repository

Deprecated:: Use Repository onTeamspaceTemplateListChange event.

onWorklistContainersRetrieved(repository)

An event function that is invoked when worklist containers are retrieved successfully.

Parameters:
repository

Deprecated:: Use Repository onWorklistContainersRetrieved event.