csbase.logic

Class UserGroup

java.lang.Object

csbase.logic.UserGroup

All Implemented Interfaces:

IdInterface, Serializable

public class UserGroup
extends Object
implements Serializable, IdInterface

A classe UserGroup representa um tipo de Grupo de Usuários. Todo usuário no CSBase está associado (pertence) a um grupo. Mantém uma cache dos UserGroups instanciados localmente.

Version:

$Revision: 170738 $

Author:

$Author: fpina $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	USERGROUP_ID Representa a UserGroup na Hashtable de atributos do usuário na UserInfo

Constructor Summary

Constructors

Constructor and Description
UserGroup(Object id, UserGroupInfo info) Cria uma UserGroup.

Method Summary

Modifier and Type	Method and Description
static void	addObserver(Observer o) Adiciona um observador local da classe.
static UserGroup	createUserGroup(UserGroupInfo info) Cria uma nova UserGroup no sistema.
static void	deleteObserver(Observer o) Remove um observador local da classe.
static void	deleteUserGroup(Object id) Remove um UserGroup do sistema.
boolean	equalContents(Object obj) Indica se conteúdo é igual.
boolean	equals(Object obj) Verifica se dois UserGroups são iguais.
static boolean	existsAnotherUserGroup(Object id, String name) Verifica se já existe um outro UserGroup com o mesmo nome.
static List<UserGroup>	getAllUserGroups() Solicita a lista de todos os grupos de usuários cadastrados no sistema.
String	getDesc() Obtém a descrição do grupo de usuários.
static Comparator<UserGroup>	getDescComparator() Obtém um comparator de UserGroup pelo critério de ordem alfabética da descrição do grupo de usuários.
static Getter	getDescGetter() Obtém um getter para a descrição de UserGroup.
Object	getId() Obtém o identificador do grupo de usuários.
static Getter	getIdGetter() Obtém um getter para o identificador do UserGroup.
UserGroupInfo	getInfo() Obtém as informações do grupo de usuários
String	getName() Obtém o nome do grupo.
static Comparator<UserGroup>	getNameComparator() Obtém um comparator de UserGroup pelo critério de ordem alfabética do nome do grupo de usuários.
static Getter	getNameGetter() Obtém um getter para o nome do UserGroup.
static UserGroup	getUserGroup(Object id) Obtem a UserGroup que possui uma determinada identificação.
static UserGroup	getUserGroupByName(String name) Solicita uma UserGroup que possui um determinado nome.
static UserGroup	getUserGroupFromUser(User user) Solicita uma UserGroup a partir de um usuário.
UserGroupInfo	getUserGroupInfo() Obtém uma cópia do UserGroupInfo deste grupo de usuários.
int	hashCode() Calcula o código hash do objeto.
static UserGroup	modifyUserGroup(Object id, UserGroupInfo info) Modifica um UserGroup no sistema.
void	setDesc(String desc) Muda a descrição do grupo de usuários.
void	setName(String name) Muda o nome do grupo de usuários.
String	toString() Obtém uma descrição de um grupo de usuários.
static void	update(AdministrationEvent event) Esse método é chamado quando um serviço de administração sofre alguma alteração relativa aos grupos de usuários.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

USERGROUP_ID

public static final String USERGROUP_ID

Representa a UserGroup na Hashtable de atributos do usuário na UserInfo

See Also:

Constant Field Values

Constructor Detail

UserGroup

public UserGroup(Object id,
                 UserGroupInfo info)

Cria uma UserGroup. Só será executado no servidor. Objetos são serializados para o cliente.

Parameters:

id - o identificador da UserGroup

info - os dados da UserGroup

Method Detail

equals

public boolean equals(Object obj)

Verifica se dois UserGroups são iguais. Um UserGroup é igual ao outro se ambos possuem o mesmo identificador.

Overrides:

equals in class Object

Parameters:

obj - o outro objeto com o qual esse UserGroup está sendo comparado

Returns:

.

hashCode

public int hashCode()

Calcula o código hash do objeto.

Overrides:

hashCode in class Object

Returns:

Inteiro que representa o código hash do objeto.

equalContents

public boolean equalContents(Object obj)

Indica se conteúdo é igual.

Parameters:

obj - objeto

Returns:

indicativo

getUserGroup

public static UserGroup getUserGroup(Object id)
                              throws RemoteException

Obtem a UserGroup que possui uma determinada identificação. A UserGroup é guardada no cache, caso ela não esteja lá.

Parameters:

id - a identificação de uma UserGroup

Returns:

a UserGroup que possui a identificação requisitada ou null caso essa UserGroup não exista.

Throws:

RemoteException - falha de rmi

getUserGroupByName

public static UserGroup getUserGroupByName(String name)
                                    throws RemoteException

Solicita uma UserGroup que possui um determinado nome.

Parameters:

name - o nome da UserGroup procurada

Returns:

a UserGroup que possui o nome procurado ou null caso essa UserGroup não exista.

Throws:

RemoteException - falha de rmi

getUserGroupFromUser

public static UserGroup getUserGroupFromUser(User user)
                                      throws RemoteException

Solicita uma UserGroup a partir de um usuário.

Parameters:

user - usuário que se deseja obter a UserGroup.

Returns:

UserGroup

Throws:

RemoteException - falha de rmi

getAllUserGroups

public static List<UserGroup> getAllUserGroups()
                                        throws RemoteException

Solicita a lista de todos os grupos de usuários cadastrados no sistema. Os UserGroups são colocados no cache.

Returns:

um vetor com todos os UserGroups

Throws:

RemoteException - falha de rmi

createUserGroup

public static UserGroup createUserGroup(UserGroupInfo info)
                                 throws Exception

Cria uma nova UserGroup no sistema. Não se pode criar uma nova UserGroup com o mesmo nome de outra já existente. A UserGroup criada é colocada na cache.

Parameters:

info - os dados da nova UserGroup

Returns:

a UserGroup criada ou null caso já exista uma UserGroup com o mesmo nome

Throws:

Exception - em aso de falha.

modifyUserGroup

public static UserGroup modifyUserGroup(Object id,
                                        UserGroupInfo info)
                                 throws RemoteException

Modifica um UserGroup no sistema. Não se pode modificar o nome de um UserGroup se já existir uma outro com esse nome. O UserGroup modificado é colocado no cache.

Parameters:

id - o identificador do grupo a ser modificado

info - os dados do grupo a ser modificado

Returns:

o UserGroup modificado ou null caso já exista um UserGroup com o mesmo nome ou não exista UserGroup com o id especificado

Throws:

RemoteException - falha de rmi

existsAnotherUserGroup

public static boolean existsAnotherUserGroup(Object id,
                                             String name)
                                      throws RemoteException

Verifica se já existe um outro UserGroup com o mesmo nome.

Parameters:

id - o identificador de um UserGroup

name - o nome sendo procurado

Returns:

true se existir uma outro UserGroup com o nome procurado ou false no caso de não existir

Throws:

RemoteException - falha de rmi

deleteUserGroup

public static void deleteUserGroup(Object id)
                            throws RemoteException,
                                   AdministrationDeleteException

Remove um UserGroup do sistema. O UserGroup removido é retirado do cache.

Parameters:

id - a identificação do UserGroup a ser removido do sistema.

Throws:

RemoteException - falha de rmi

AdministrationDeleteException - caso haja usuário cadastrado no grupo

getNameComparator

public static Comparator<UserGroup> getNameComparator()

Obtém um comparator de UserGroup pelo critério de ordem alfabética do nome do grupo de usuários.

Returns:

um comparador por nome

getDescComparator

public static Comparator<UserGroup> getDescComparator()

Obtém um comparator de UserGroup pelo critério de ordem alfabética da descrição do grupo de usuários.

Returns:

um comparador por descrição

getNameGetter

public static Getter getNameGetter()

Obtém um getter para o nome do UserGroup.

Returns:

um getter para o nome

getIdGetter

public static Getter getIdGetter()

Obtém um getter para o identificador do UserGroup.

Returns:

um getter para o identificador

getDescGetter

public static Getter getDescGetter()

Obtém um getter para a descrição de UserGroup.

Returns:

um getter para a descrição

addObserver

public static void addObserver(Observer o)

Adiciona um observador local da classe. Sempre que a classe é avisada pelo serviço de administração de que alguma mudança ocorreu, os observadores locais também são notificados.

Parameters:

o - um observador local

deleteObserver

public static void deleteObserver(Observer o)

Remove um observador local da classe.

Parameters:

o - o observador a ser removido

update

public static void update(AdministrationEvent event)

Esse método é chamado quando um serviço de administração sofre alguma alteração relativa aos grupos de usuários. Atualiza o cache de grupo de usuários e notifica seus observadores locais.

Parameters:

event - o evento que ocorreu no serviço de administração

getId

public Object getId()

Obtém o identificador do grupo de usuários.

Specified by:

getId in interface IdInterface

Returns:

o identificador do grupo de usuários

getName

public String getName()

Obtém o nome do grupo.

Returns:

o nome do grupo

getDesc

public String getDesc()

Obtém a descrição do grupo de usuários.

Returns:

a descrição do grupo de usuários

getInfo

public UserGroupInfo getInfo()

Obtém as informações do grupo de usuários

Returns:

UserGroupInfo

getUserGroupInfo

public UserGroupInfo getUserGroupInfo()

Obtém uma cópia do UserGroupInfo deste grupo de usuários.

Returns:

a cópia do UserGroupInfo

setName

public void setName(String name)

Muda o nome do grupo de usuários.

Parameters:

name - o novo nome

setDesc

public void setDesc(String desc)

Muda a descrição do grupo de usuários.

Parameters:

desc - a nova informação

toString

public String toString()

Obtém uma descrição de um grupo de usuários.

Overrides:

toString in class Object

Returns:

um texto que descreve as informações desse UserGroup.