Class ecm.model.UserGroup

Extends ecm.model._ModelObject.
Represents a group of repository users. Private functions should not be used to access public members of the class. Access member variables directly. For example:

var userGrp = new UserGroup({ id: "usergroup1", name: "usergroup1", displayName: "User Group 1" });
console.debug("Display name=" + userGrp.displayName);

Defined in: <ecm\model\UserGroup.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	displayName  The group display name (may be null).
	roles  An array of ecm.model.Role objects this group is a member of.
	shortName  The group short name (may be null).
	users  An array of ecm.model.User objects for the users associated with this group.

Fields borrowed from class ecm.model._ModelObject:

categorization, id, isRecurring, name, nameFilter, pane, status, type, userId

Method Summary

Method Attributes	Method Name and Description
	hasUser(userId) Determines if the group has the given user.
	toJSON() Generates a JSON representation of this user group.
<static>	ecm.model.UserGroup.UserGroup.getAuthenticatedUsersPseudoGroup() Static function that creates a new pseudo user group object

Methods borrowed from class ecm.model._ModelObject:

destroy, onChange, own, refresh, toString

Field Detail

displayName

---

roles

---

shortName

---

users

Method Detail

hasUser(userId)

Parameters:

userId

The ID of the user to search for in the group.

---

toJSON()

---

<static> ecm.model.UserGroup.UserGroup.getAuthenticatedUsersPseudoGroup()

---