Class ecm.model.Role

Extends ecm.model._ModelObject.
Represents a role to which users or groups can be assigned.
Defined in: <ecm\model\Role.js>.

Constructor Summary

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

Field Attributes	Field Name and Description
	currentUserPrivileges The privileges for the current user.
	description The role description text.
	messageId The message Id.
	owner A boolean indicating whether the current user is an owner of this role.
	preDefined A boolean indicating whether the role is predefined.
	privileges The privileges for this role.

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

Method Attributes	Method Name and Description
	hasPrivilege(privilege) Returns true if this item has the specified privilege.
<static>	ecm.model.Role.Role.lookupPrivilegeDescription(privName) Static function that returns the description for the give privilege.
<static>	ecm.model.Role.Role.lookupPrivilegeLabel(privName) Static function that returns the label for the give privilege.
	toJSON() Generates a JSON representation of this role.

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

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.

The privileges for the current user.

The role description text.
Defined in: <ecm\model\RedactionPolicy.js>.

The message Id.

A boolean indicating whether the current user is an owner of this role.

A boolean indicating whether the role is predefined.

The privileges for this role.

Returns true if this item has the specified privilege.

Static function that returns the description for the give privilege.

Static function that returns the label for the give privilege.

Generates a JSON representation of this role.