Permission (csbase-common 3.2.0-RC2 API)

java.lang.Object
- csbase.logic.Permission

All Implemented Interfaces:

IdInterface, Serializable, Comparable<Object>

Direct Known Subclasses:

AttributesPermission, ChoicePermission, GlobalAdminPermission, SimplePermission, UserPasswordPermission
```
public abstract class Permission
extends Object
implements Serializable, Comparable<Object>, IdInterface
```
Define a super-classe das permissões do sistema CSBase. Toda permissão tem um nome. Sub-classes serão criadas para cada diferente tipo de permissão concreta a ser utilizada pelo sistema. Para permitir construir a interface gráfica de gerência de permissões, serão criadas sub-classes a partir das sub-classes abaixo: SimplePermission, UserPasswordPermission e AttributesPermission.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected String description
Descrição desta permissão.

protected String name
Nome desta permissão.

Fields
Modifier and Type	Field and Description
`protected String`	`description` Descrição desta permissão.
`protected String`	`name` Nome desta permissão.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Permission()
Construtor.

protected Permission(String name, String description)
Construtor.

Constructors
Modifier	Constructor and Description
`protected`	`Permission()` Construtor.
`protected`	`Permission(String name, String description)` Construtor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addObserver(Observer obs)` Adiciona um observador local da classe.
`int`	`compareTo(Object obj)`
`static Permission`	`createPermission(Permission permission)` Cria uma nova Permissão no sistema.
`static void`	`deleteObserver(Observer obs)` Remove um observador local da classe Platform.
`static void`	`deletePermission(Object id)` Remove uma permissão do sistema.
`boolean`	`equalContents(Object obj)` Verifica se o conteúdo de uma permissão é igual ao conteúdo desta.
`boolean`	`equals(Object obj)`
`static boolean`	`existsAnotherPermission(Object id, String name)` Verifica se já existe uma outra permissão com o mesmo nome.
`static List<Permission>`	`getAllPermissions()` Solicita a lista de todas as permissões cadastradas no sistema.
`String`	`getDescription()` Retorna um texto descritivo da permissão.
`Object`	`getId()` Obtém o identificador da Permission.
`String`	`getName()` Retorna o nome da permissão.
`static Permission`	`getPermission(Object id)` Obtem a permissão que possui uma determinada identificação.
`static Permission`	`getPermissionByName(String name)` Solicita uma permissão que possui um determinado nome.
`static List<String>`	`getPermissionClasses()` Solicita a lista de todas as classes de permissões cadastradas no sistema.
`int`	`hashCode()` Calcula o código hash do objeto.
`static Permission`	`modifyPermission(Object id, Permission permission)` Modifica uma permissão no sistema.
`void`	`setDescription(String description)` Altera o texto descritivo da permissão.
`void`	`setId(Object id)` Atribui o identificador da permissão.
`void`	`setName(String name)` Altera o nome da permissão.
`String`	`toString()`
`static void`	`update(AdministrationEvent event)` Esse método é chamado quando um serviço de administração sofre alguma alteração relativa a permissões.
`boolean`	`validate()` Valida a permissão como entrada na tela e retorna true se estiver ok

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

- Field Detail
  - name
```
protected String name
```
    Nome desta permissão.
  - description
```
protected String description
```
    Descrição desta permissão.
- Constructor Detail
  - Permission
```
protected Permission()
```
    Construtor.
  - Permission
```
protected Permission(String name,
                     String description)
```
    Construtor. Define o nome e a descrição da permissão sendo criada.
    
    Parameters:
    
    name - Nome desta permissão.
    
    description - Descrição desta permissão.
- Method Detail
  - getId
```
public Object getId()
```
    Obtém o identificador da Permission.
    
    Specified by:
    
    getId in interface IdInterface
    
    Returns:
    
    o identificador da Permission.
  - getName
```
public String getName()
```
    Retorna o nome da permissão. Esse nome é fornecido pelo usuário quando é criada uma instância de alguma classe concreta de permissão.
    
    Returns:
    
    .
  - setName
```
public void setName(String name)
```
    Altera o nome da permissão. Esse nome é fornecido pelo usuário quando é criada uma instância de alguma classe concreta de permissão.
    
    Parameters:
    
    name - .
  - setId
```
public void setId(Object id)
```
    Atribui o identificador da permissão. Esse identificador é gerado apenas no serviço.
    
    Parameters:
    
    id - .
  - getDescription
```
public String getDescription()
```
    Retorna um texto descritivo da permissão. Esse texto é fornecido pelo usuário quando é criada uma instância de alguma classe concreta de permissão.
    
    Returns:
    
    .
  - setDescription
```
public void setDescription(String description)
```
    Altera o texto descritivo da permissão. Esse texto é fornecido pelo usuário quando é criada uma instância de alguma classe concreta de permissão.
    
    Parameters:
    
    description - .
  - getPermissionClasses
```
public static List<String> getPermissionClasses()
                                         throws Exception
```
    Solicita a lista de todas as classes de permissões cadastradas no sistema.
    
    Returns:
    
    um vetor com todas as permissões
    
    Throws:
    
    Exception - em caso de erro de comunicação.
  - validate
```
public boolean validate()
```
    Valida a permissão como entrada na tela e retorna true se estiver ok
    
    Returns:
    
    true se estiver ok
  - compareTo
```
public int compareTo(Object obj)
```
    Specified by:
    
    compareTo in interface Comparable<Object>
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
    Verifica se o conteúdo de uma permissão é igual ao conteúdo desta.
    
    Parameters:
    
    obj - Permissão cujo conteúdo será comparado ao conteúdo desta.
    
    Returns:
    
    True, se o conteúdo das permissões for igual, false caso contrátio.
  - getAllPermissions
```
public static List<Permission> getAllPermissions()
                                          throws Exception
```
    Solicita a lista de todas as permissões cadastradas no sistema. As pemissões são colocadas no cache.
    
    Returns:
    
    um vetor com todas as permissões
    
    Throws:
    
    Exception - em caso de erro de comunicação.
  - getPermission
```
public static Permission getPermission(Object id)
                                throws RemoteException
```
    Obtem a permissão que possui uma determinada identificação. A permissão é guardada no cache, caso ela não esteja lá.
    
    Parameters:
    
    id - a identificação de uma permissão
    
    Returns:
    
    a permissão que possui a identificação requisitada ou null caso essa permissão não exista.
    
    Throws:
    
    RemoteException - falha de rmi
  - createPermission
```
public static Permission createPermission(Permission permission)
                                   throws Exception
```
    Cria uma nova Permissão no sistema. Não se pode criar uma nova Permissão com o mesmo nome de outra já existente. A Permissão criada é colocada na cache.
    
    Parameters:
    
    permission - os dados da nova Permissão
    
    Returns:
    
    a Permissão criada ou null caso já exista uma Permissão com o mesmo nome.
    
    Throws:
    
    Exception - em caso de erro de comunicação.
  - getPermissionByName
```
public static Permission getPermissionByName(String name)
                                      throws Exception
```
    Solicita uma permissão que possui um determinado nome.
    
    Parameters:
    
    name - o nome da permissão procurada
    
    Returns:
    
    a permissão que possui o nome procurado ou null caso essa permissão não exista.
    
    Throws:
    
    Exception - em caso de erro de comunicação.
  - modifyPermission
```
public static Permission modifyPermission(Object id,
                                          Permission permission)
                                   throws Exception
```
    Modifica uma permissão no sistema. Não se pode modificar o nome de uma permissão se já existir uma outra com esse nome. A permissão modificada é colocada no cache.
    
    Parameters:
    
    id - o identificador da permissão a ser modificada
    
    permission - os dados da permissão a ser modificada
    
    Returns:
    
    a permissão modificada ou null caso já exista uma permissão com o mesmo nome ou não exista permissão com o id especificado
    
    Throws:
    
    Exception - em caso de erro de comunicação.
  - existsAnotherPermission
```
public static boolean existsAnotherPermission(Object id,
                                              String name)
                                       throws Exception
```
    Verifica se já existe uma outra permissão com o mesmo nome.
    
    Parameters:
    
    id - o identificador de uma permissão
    
    name - o nome sendo procurado
    
    Returns:
    
    true se existir uma outra permissão com o nome procurado ou false no caso de não existir
    
    Throws:
    
    Exception - em caso de erro de comunicação.
  - deletePermission
```
public static void deletePermission(Object id)
                             throws Exception,
                                    AdministrationDeleteException
```
    Remove uma permissão do sistema. A permissão removida é retirada do cache.
    
    Parameters:
    
    id - a identificação da permissão a ser removida do sistema.
    
    Throws:
    
    Exception - em caso de erro de comunicação.
    
    AdministrationDeleteException - em caso de erro na operação.
  - addObserver
```
public static void addObserver(Observer obs)
```
    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:
    
    obs - um observador local
  - deleteObserver
```
public static void deleteObserver(Observer obs)
```
    Remove um observador local da classe Platform.
    
    Parameters:
    
    obs - 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 a permissões. Atualiza o cache de permissões e notifica seus observadores locais.
    
    Parameters:
    
    event - a ação que ocorreu no serviço de administração
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Permission

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

description

Constructor Detail

Permission

Permission

Method Detail

getId

getName

setName

setId

getDescription

setDescription

getPermissionClasses

validate

compareTo

equals

hashCode

equalContents

getAllPermissions

getPermission

createPermission

getPermissionByName

modifyPermission

existsAnotherPermission

deletePermission

addObserver

deleteObserver

update

toString