Role (csbase-common BRS-4.0.0 API)

java.lang.Object
- csbase.logic.Role

All Implemented Interfaces:

IdInterface, Serializable
```
public class Role
extends Object
implements Serializable, IdInterface
```
A classe Role representa um perfil de permissões.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

Role(Object id, RoleInfo info)
Cria um perfil.

Constructors
Constructor and Description
`Role(Object id, RoleInfo info)` Cria um perfil.

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`addObserver(Observer o)` Adiciona um observador local da classe.
`static Role`	`createRole(RoleInfo info)` Solicita ao provedor para criar um novo perfil no sistema.
`static void`	`deleteObserver(Observer o)` Remove um observador local da classe.
`static void`	`deleteRole(Object id)` Solicita ao provedor para remover um perfil do sistema.
`boolean`	`equalContents(Object obj)`
`boolean`	`equals(Object obj)` Verifica se um perfil é igual a um outro.
`static boolean`	`existsAnotherRole(Object id, String name)` Verifica se já existe um outro perfil com o mesmo nome.
`static List<Role>`	`getAllRoles()` Solicita ao provedor todos os perfis cadastrados no sistema.
`static List<Role>`	`getAllRoles(boolean sortByName)` Solicita ao provedor todos os perfis cadastrados no sistema.
`static Comparator<Role>`	`getDescrComparator()` Obtém um comparator de `Role` pelo critério de ordem alfabética da descrição do perfil.
`static Getter`	`getDescrGetter()` Obtém um getter para a descrição de `Role`.
`String`	`getDescription()` Obtém a descrição do perfil.
`Object`	`getId()` Obtém o identificador do perfil.
`String`	`getName()` Obtém nome do perfil.
`static Comparator<Role>`	`getNameComparator()` Obtém um comparator de `Role` pelo critério de ordem alfabética do nome do perfil.
`static Getter`	`getNameGetter()` Obtém um getter para o nome de `Role`.
`Object[]`	`getPermissionIds()` Obtém as permissões do perfil.
`static Role`	`getRole(Object id)` Solicita ao provedor um perfil que possui uma determinada identificação.
`static Role`	`getRoleByName(String name)` Obtém o perfil que possui o nome especificado.
`RoleInfo`	`getRoleInfo()` Obtém uma cópia do RoleInfo deste perfil.
`static boolean`	`hasAnyRoleWithPermission(Object permissionId)` Verifica se algum perfil possui uma determinada permissão.
`int`	`hashCode()` Calcula o código hash do objeto.
`static Role`	`modifyRole(Object id, RoleInfo info)` Solicita ao provedor para modificar um perfil no sistema.
`void`	`setPermissionIds(Object[] permissionIds)` Altera as permissões do perfil.
`String`	`toString()`
`static void`	`update(AdministrationEvent event)` Esse método é chamado quando um serviço de administração sofre alguma alteração relativa a perfis.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Role
```
public Role(Object id,
    RoleInfo info)
```
    Cria um perfil. Só será executado no servidor. Objetos são serializados para o cliente.
    
    Parameters:
    id - o identificador do perfil
    info - as informações do perfil
- Method Detail
  - getRole
```
public static Role getRole(Object id)
                    throws RemoteException
```
    Solicita ao provedor um perfil que possui uma determinada identificação.
    
    Parameters:
    id - a identificação de um perfil
    
    Returns:
    o perfil que possui a identificação requisitada ou null caso esse perfil não exista
    
    Throws:
    
    RemoteException - falha de rmi
  - getRoleByName
```
public static Role getRoleByName(String name)
                          throws Exception
```
    Obtém o perfil que possui o nome especificado.
    
    Parameters:
    name - nome do perfil procurado
    
    Returns:
    perfil que possui o nome procurado ou null caso esse perfil não exista
    
    Throws:
    
    Exception
  - getAllRoles
```
public static List<Role> getAllRoles()
                              throws RemoteException
```
    Solicita ao provedor todos os perfis cadastrados no sistema.
    
    Returns:
    um vetor com os perfis
    
    Throws:
    
    RemoteException - falha de rmi
  - existsAnotherRole
```
public static boolean existsAnotherRole(Object id,
                        String name)
                                 throws Exception
```
    Verifica se já existe um outro perfil com o mesmo nome.
    
    Parameters:
    id - o identificador de um perfil
    name - o nome sendo procurado
    
    Returns:
    true se existir uma outro perfil com o nome procurado ou false no caso de não existir
    
    Throws:
    
    Exception
  - getAllRoles
```
public static List<Role> getAllRoles(boolean sortByName)
                              throws Exception
```
    Solicita ao provedor todos os perfis cadastrados no sistema. Os perfis podem estar ordenados por nome, se assim for solicitado.
    
    Parameters:
    sortByName - true se os perfis deverão estar ordenadas alfabeticamente pelo nome e false se a ordenação não é necessária
    
    Returns:
    um vetor com os perfis
    
    Throws:
    
    Exception
  - createRole
```
public static Role createRole(RoleInfo info)
                       throws Exception
```
    Solicita ao provedor para criar um novo perfil no sistema.
    
    Parameters:
    info - as informações do perfil a ser criado.
    
    Returns:
    o perfil criado ou null caso já exista um perfil com a mesma identificação
    
    Throws:
    
    Exception
  - modifyRole
```
public static Role modifyRole(Object id,
              RoleInfo info)
                       throws Exception
```
    Solicita ao provedor para modificar um perfil no sistema.
    
    Parameters:
    id - a identificação do perfil a ser modificado
    info - as informações a serem usuadas na modificação do perfil.
    
    Returns:
    o perfil modificado ou null se a modificação não pode ser efetuada: modificação de nome ou se não existe perfil com o identificador especificado.
    
    Throws:
    
    Exception
  - deleteRole
```
public static void deleteRole(Object id)
                       throws Exception
```
    Solicita ao provedor para remover um perfil do sistema.
    
    Parameters:
    id - o identificador do perfil a ser removido do sistema.
    
    Throws:
    
    Exception
  - update
```
public static void update(AdministrationEvent event)
```
    Esse método é chamado quando um serviço de administração sofre alguma alteração relativa a perfis. Notifica seus observadores locais.
    
    Parameters:
    event - o evento que ocorreu no provedor de perfis
  - 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
  - getId
```
public Object getId()
```
    Obtém o identificador do perfil.
    
    Specified by:
    
    getId in interface IdInterface
    
    Returns:
    o identificador do perfil.
  - getName
```
public String getName()
```
    Obtém nome do perfil.
    
    Returns:
    o nome do perfil
  - getDescription
```
public String getDescription()
```
    Obtém a descrição do perfil.
    
    Returns:
    a descrição do perfil
  - getPermissionIds
```
public Object[] getPermissionIds()
```
    Obtém as permissões do perfil.
    
    Returns:
    o array de permissões do perfil.
  - setPermissionIds
```
public void setPermissionIds(Object[] permissionIds)
```
    Altera as permissões do perfil.
    
    Parameters:
    permissionIds - array de permissões do perfil.
  - getRoleInfo
```
public RoleInfo getRoleInfo()
```
    Obtém uma cópia do RoleInfo deste perfil.
    
    Returns:
    a cópia do RoleInfo
  - getNameComparator
```
public static Comparator<Role> getNameComparator()
```
    Obtém um comparator de Role pelo critério de ordem alfabética do nome do perfil.
    
    Returns:
    um comparador por nome
  - getDescrComparator
```
public static Comparator<Role> getDescrComparator()
```
    Obtém um comparator de Role pelo critério de ordem alfabética da descrição do perfil.
    
    Returns:
    um comparador por descrição
  - getNameGetter
```
public static Getter getNameGetter()
```
    Obtém um getter para o nome de Role.
    
    Returns:
    um getter para o nome
  - getDescrGetter
```
public static Getter getDescrGetter()
```
    Obtém um getter para a descrição de Role.
    
    Returns:
    um getter para a descrição
  - equals
```
public boolean equals(Object obj)
```
    Verifica se um perfil é igual a um outro. Dois perfis de usuários são considerados o mesmo se eles possuem o mesmo identificador.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    obj - o outro objeto com o qual esse perfil está sendo comparado.
    
    Returns:
    true ou false, se o perfil for ou não igual a um outro.
  - 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)
```
  - hasAnyRoleWithPermission
```
public static boolean hasAnyRoleWithPermission(Object permissionId)
                                        throws RemoteException
```
    Verifica se algum perfil possui uma determinada permissão.
    
    Parameters:
    permissionId - Identificador da permissão.
    
    Returns:
    true caso o perfil possua esta permissão, ou false, caso contrário.
    
    Throws:
    
    RemoteException - falha de rmi
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Role

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Role

Method Detail

getRole

getRoleByName

getAllRoles

existsAnotherRole

getAllRoles

createRole

modifyRole

deleteRole

update

addObserver

deleteObserver

getId

getName

getDescription

getPermissionIds

setPermissionIds

getRoleInfo

getNameComparator

getDescrComparator

getNameGetter

getDescrGetter

equals

hashCode

equalContents

hasAnyRoleWithPermission

toString