com.epicentric.users
Class UserGroup

java.lang.Object
  |
  +--com.epicentric.users.UserGroup

All Implemented Interfaces:

Describable, PermissionContextOwner

Deprecated. as of Version 4.0, to be removed in 8.0 or later; instead, see the new UserGroup class.

public abstract class UserGroup

extends Object

implements PermissionContextOwner

A group of users. Most portal access privileges are assigned at the user group (not the individual user) level.

Inner Class Summary

protected static class

UserGroup.UserGroupCatalogFinder Deprecated.

Constructor Summary

UserGroup()
Deprecated.

Method Summary

abstract void	addParent(UserGroup parent) Deprecated. Add a parent relationship to this UserGroup.
abstract void	addUser(int userID) Deprecated. Add user with given ID to the group.
abstract void	addUser(int userID, boolean sendBroadcast) Deprecated. Add user with given ID to the group.
abstract boolean	allowsSelfRegistration() Deprecated. Does this user group allow self registration.
abstract boolean	containsUser(int userID) Deprecated.
abstract Set	getChildGroupIDs() Deprecated. Return a Set containing this UserGroup's immediate child UserGroup ids.
abstract String	getDescription() Deprecated. Return the group description.
abstract String	getFormattedCreatedDate() Deprecated. Returns the date this template was created as a string in the format of "MM/DD/YY" (including leading zeros).
abstract int	getId() Deprecated. As of version 3.0. Will be removed in 8.0 or later. This method has been replaced by getID() in an effort to provide consistent method names across the API.
abstract int	getID() Deprecated. Returns this group's id.
abstract String	getName() Deprecated. Return the group name.
abstract Set	getParentGroupIDs() Deprecated. Return a Set containing this UserGroup's immediate parent UserGroup ids.
abstract String	getUniqueID() Deprecated. Used internally by the Entity Management system to get the UID of this user group.
abstract int[]	getUserIDs() Deprecated.
protected abstract Set	loadChildIDs() Deprecated. Load from storage and return a Set containing this UserGroup's immediate child UserGroup ids.
protected abstract Set	loadParentIDs() Deprecated. Load from storage and return a Set containing this UserGroup's immediate parent UserGroup ids.
protected abstract void	reloadChildIDs() Deprecated. Causes the next call to getChildGroupIDs() to fetch fresh data from the database instead of using the cached value.
protected abstract void	reloadParentIDs() Deprecated. Causes the next call to getParentGroupIDs() to fetch fresh data from the database instead of using the cached value.
abstract void	removeParent(UserGroup parent) Deprecated. Remove a parent relationship from this UserGroup.
abstract void	removeUser(int userId) Deprecated. Remove user with given ID from the group.
abstract void	removeUser(int userId, boolean sendBroadcast) Deprecated. Remove user with given ID from the group.
abstract void	save() Deprecated. Store our internal fields in whatever way is appropriate to the implementation.
abstract void	setCreatedDate(Date d) Deprecated. Set the created Date to the group
abstract void	setDescription(String description) Deprecated. Set the group description.
abstract void	setName(String name) Deprecated. Throws exception if new name is the name of an existing UserGroup.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.epicentric.permission.PermissionContextOwner

getPermissionContext

Methods inherited from interface com.epicentric.common.Describable

getCreatedDate, getOwnerID, setOwnerID

Constructor Detail

UserGroup

public UserGroup()

Deprecated.

Method Detail

getId

public abstract int getId()

Deprecated. As of version 3.0. Will be removed in 8.0 or later. This method has been replaced by getID() in an effort to provide consistent method names across the API.

Returns this group's id.

getID

public abstract int getID()

Deprecated.

Returns this group's id.

getUniqueID

public abstract String getUniqueID()

Deprecated.

Used internally by the Entity Management system to get the UID of this user group.

getName

public abstract String getName()

Deprecated.

Return the group name.

setName

public abstract void setName(String name)
                      throws PersistificationException

Deprecated.

Throws exception if new name is the name of an existing UserGroup.

getDescription

public abstract String getDescription()

Deprecated.

Return the group description.

setDescription

public abstract void setDescription(String description)

Deprecated.

Set the group description.

setCreatedDate

public abstract void setCreatedDate(Date d)

Deprecated.

Set the created Date to the group

Parameters:

d - the date of creation

getFormattedCreatedDate

public abstract String getFormattedCreatedDate()

Deprecated.

Returns the date this template was created as a string in the format of "MM/DD/YY" (including leading zeros).

Returns:

"MM/DD/YY" String

allowsSelfRegistration

public abstract boolean allowsSelfRegistration()

Deprecated.

Does this user group allow self registration.

getUserIDs

public abstract int[] getUserIDs()

Deprecated.

containsUser

public abstract boolean containsUser(int userID)

Deprecated.

addUser

public abstract void addUser(int userID)
                      throws PersistificationException

Deprecated.

Add user with given ID to the group. If user is already in group, does not add user twice. Does not check that the ID is valid, and of an existing user. This method does persistence so the user.save() call is not necessary. The user and his relationship to the group are separate elements.

addUser

public abstract void addUser(int userID,
                             boolean sendBroadcast)
                      throws PersistificationException

Deprecated.

Add user with given ID to the group. If user is already in group, does not add user twice. Does not check that the ID is valid, and of an existing user. This method does persistence so the user.save() call is not necessary. The user and his relationship to the group are separate elements.

Parameters:

userID - The user to be added to this group.

sendBroadcast - true if a broadcast message should be sent to notify other nodes of the cluster that the user has been added.

removeUser

public abstract void removeUser(int userId)
                         throws PersistificationException

Deprecated.

Remove user with given ID from the group. If userID is invalid, or user is not in group, does nothing. This method does persistence so the user.save() call is not necessary. The user and his relationship to the group are separate elements.

removeUser

public abstract void removeUser(int userId,
                                boolean sendBroadcast)
                         throws PersistificationException

Deprecated.

Remove user with given ID from the group. If userID is invalid, or user is not in group, does nothing. This method does persistence so the user.save() call is not necessary. The user and his relationship to the group are separate elements.

Parameters:

userID - The user to be removed from this group.

sendBroadcast - true if a broadcast message should be sent to notify other nodes of the cluster that the user has been removed.

save

public abstract void save()
                   throws PersistificationException

Deprecated.

Store our internal fields in whatever way is appropriate to the implementation. This is called from the mutator methods, so it is not necessary to call directly.

NOTE: does not save userID list. That is handled in {add,remove}UserID.

addParent

public abstract void addParent(UserGroup parent)
                        throws PersistificationException

Deprecated.

Add a parent relationship to this UserGroup.

removeParent

public abstract void removeParent(UserGroup parent)
                           throws PersistificationException

Deprecated.

Remove a parent relationship from this UserGroup.

getParentGroupIDs

public abstract Set getParentGroupIDs()

Deprecated.

Return a Set containing this UserGroup's immediate parent UserGroup ids.

getChildGroupIDs

public abstract Set getChildGroupIDs()

Deprecated.

Return a Set containing this UserGroup's immediate child UserGroup ids.

reloadParentIDs

protected abstract void reloadParentIDs()

Deprecated.

Causes the next call to getParentGroupIDs() to fetch fresh data from the database instead of using the cached value.

reloadChildIDs

protected abstract void reloadChildIDs()

Deprecated.

Causes the next call to getChildGroupIDs() to fetch fresh data from the database instead of using the cached value.

loadParentIDs

protected abstract Set loadParentIDs()
                              throws PersistificationException

Deprecated.

Load from storage and return a Set containing this UserGroup's immediate parent UserGroup ids.

loadChildIDs

protected abstract Set loadChildIDs()
                             throws PersistificationException

Deprecated.

Load from storage and return a Set containing this UserGroup's immediate child UserGroup ids.