====== Cadastrar Convênios ======
Este caso de uso permite o cadastro do convênio após o mesmo ter sido [[desenvolvimento:especificacoes:sipac:convenios:casos_de_uso:convenios:convenios:registrar_convenio|registrado]]. Ele pode ser utilizado pelos gestores de convênios que fazem parte da PROPLAN - SETOR DE CONVÊNIOS.



===== Descrição do Caso de Uso =====

Os dados que foram preenchidos durante o registro do convênio já virão automaticamente preenchidos no cadastro.

=== Passo 1 ===

É mostrado uma listagem com os convênios que estão registrados. Nessa listagem é mostrado as seguintes informações para cada convênio:

  * **Nº/Ano**: Formato - 9999/AAAA, Tipo - NUMÉRICO.
  * **Processo**: Formato - 9999/AAAA, Tipo - NUMÉRICO.
  * **Partícipes**: Formato - NOME, Tipo - TEXTO.
  * ** 	Unidades Interessadas**: Formato - NOME, Tipo - TEXTO.

É possível cadastrar qualquer um dos convênios que estão nesta listagem, assim como removê-los.

=== Passo 2 ===

Deve ser informado os dados gerais do convênio, tais como:

  * **Data de Registro**: Formato DD/MM/AAAA, Tipo - DATA.
  * **Número do Convênio**: Formato 99/AAAA, Tipo - NUMÉRICO.
  * **Número Externo do Convênio**: Formato - 9X99XX/AAAA, Tipo - TEXTO e NÚMERICO.
  * **Número de Cadastro do Convênio***: Formato - 99/AAAA, Tipo - NUMÉRICO. Campo obrigatório.
  * **Descrição**: Tipo - TEXTO.
  * **Objetivos do Convênio***: Tipo - TEXTO. Campo obrigatório.
  * **Classificação***: Tipo - TEXTO. Por exemplo: ''DESPESA'', ''RECEITA'', ''ESTÁGIO''. Campo obrigatório.
  * **Tipo de Documento***: Tipo - TEXTO. Por exemplo: ''CONVÊNIO'', ''PORTARIA'', ''DESCENTRALIZAÇÃO''. Campo obrigatório.
  * **Valor do Convênio**: Formato - 99,99, Tipo - NUMÉRICO.
  * **Observações***: Tipo - TEXTO.
 

=== Passo 3 ===

Inicialmente é mostrado alguns dados gerais do convênio, tais como:

  * **Número do Convênio**: Formato 99/AAAA, Tipo - NUMÉRICO.
  * **Número de Cadastro do Convênio**: Formato - 99/AAAA, Tipo - NUMÉRICO.
  * **Código SIAFI**: Formato 99999, Tipo - NUMÉRICO.
  * **Origem Recursos**: Tipo - TEXTO.
  * **Tipo de Documento**: Tipo - TEXTO. Por exemplo: ''CONVÊNIO'', ''PORTARIA'', ''DESCENTRALIZAÇÃO''.
  * **Classificação**: Tipo - TEXTO. Por exemplo: ''DESPESA'', ''RECEITA'', ''ESTÁGIO''.
  * **Valor do Convênio**: Formato - 99,99, Tipo - NUMÉRICO.
  * **Status**: Tipo - TEXTO.
  * **Descrição**: Tipo - TEXTO.
  * **Objetivos do Convênio**: Tipo - TEXTO. 
  
É neste passo que deverão ser adicionadas as Unidades Interessadas no Projeto. Para isso deve-se informar o **Nome** ou **Código** da unidade e então adicioná-la. É necessário adicionar pelo menos uma unidade para prosseguir o fluxo. É possível também remover alguma unidade da listagem.


=== Passo 4 ===

É mostrado alguns dados já informados, como:

  * **Objetivos do Convênio**: Tipo - TEXTO.
  * **Valor do Convênio**: Formato - 99,99, Tipo - NUMÉRICO.
  * A lista das **Unidades Interessadas**.

Neste passo deve-se informar quais os partícipes do convênio. Para isso é necessário buscar o partícipe e depois adicioná-lo, é possível realizar essa buscar pelo CPF/CNPJ ou pela Razão Social. Caso o partícipe ainda não esteja cadastrado na base de dados, o usuário pode cadastrá-lo e depois realizar a buscar par inserir o partícipe. Quando inserido, o partícipe irá para uma listagem com os seguintes dados:

  * **CPF/CNPJ**: Formato - 999.999.999/9999-99, Tipo - NUMÉRICO.
  * **Razão Social**: Formato - NOME, Tipo - TEXTO.

O usuário pode remover qualquer um dos partícipes inseridos.
  
=== Passo 5 ===

Inicialmente é mostrado os dados já informados para o convênio:

  * **Objetivos do Convênio**: Tipo - TEXTO.
  * **Valor do Convênio**: Formato - 99,99, Tipo - NUMÉRICO.
  * A lista das **Unidades Interessadas**.
  * A lista com os **Partícipes Inseridos**.

Neste passo é que serão informadas as funções que cada parícipe irá desempenhar. Para isso deve-se associar o partícipe a um determinado tipo ou função, entre essas funções temos ''CONVENENTE'', ''CONCEDENTE'', ''EXECUTOR''. Quando realizada a associação, o partícipe e sua respectiva função serão adicionados uma listagem que exibe:

  * **Partícipe**: Formato - NOME, Tipo - TEXTO.
  * **Tipo de Partícipe**: Tipo - TEXTO.

É possível também remover qualquer partícipe desta lista.


=== Passo 6 ===

Nesse último passo é mostrado mais uma vez alguns dados do convênio, como:

  * **Número do Convênio**: Formato 99/AAAA, Tipo - NUMÉRICO.
  * **Número de Cadastro do Convênio**: Formato - 99/AAAA, Tipo - NUMÉRICO.
  * **Código SIAFI**: Formato 99999, Tipo - NUMÉRICO.
  * **Origem Recursos**: Tipo - TEXTO.
  * **Tipo de Documento**: Tipo - TEXTO. Por exemplo: ''CONVÊNIO'', ''PORTARIA'', ''DESCENTRALIZAÇÃO''.
  * **Classificação**: Tipo - TEXTO. Por exemplo: ''DESPESA'', ''RECEITA'', ''ESTÁGIO''.
  * **Valor do Convênio**: Formato - 99,99, Tipo - NUMÉRICO.
  * **Status**: Tipo - TEXTO.
  * **Descrição**: Tipo - TEXTO.
  * **Objetivos do Convênio**: Tipo - TEXTO. 

E deve ser informado alguns dados complementares para o cadastro do convênio:

  * **Código SIAFI**: Formato 99999, Tipo - NUMÉRICO.
  * **Origem Recursos**: Tipo - TEXTO.
  * **Data de Assinatura***: Formato DD/MM/AAAA, Tipo - DATA. Campo obrigatório.
  * **Prazo de Vigência***: Formato DD/MM/AAAA, Tipo - DATA. Deve ser igual ou superior a data de assinatura. Campo obrigatório.
  * **Prazo Prest. de Contas**: Formato DD/MM/AAAA, Tipo - DATA.
  * **Prazo de Deligência**: Formato DD/MM/AAAA, Tipo - DATA.
  * **Responsável do Setor**: Formato - NOME, Tipo - TEXTO.
  * **Coordenadora**: Formato - CÓDIGO-NOME, Tipo - NUMÉRICO e TEXTO.
  * **CPF do Coordenador**: Formato - 999.999.999-99, Tipo - NUMÉRICO. Deve ser informado o CPF do coordenador e buscá-lo, para então inserir o coordenador.
  * **Telefone**: Formato - 9999-9999, Tipo - NUMÉRICO. Telefone do coordenador.
  * **E-mail**: Tipo - TEXTO. E-mail do coordenador.
  * **Observações**: Tipo - TEXTO.

Após informar os dados e efetuar o cadastro, será exibida uma tela com uma mensagem informando que o cadastro foi realizado com sucesso e mostrando alguns dados, como:

  * **Número do Convênio**: Formato 99/AAAA, Tipo - NUMÉRICO.
  * **Número de Cadastro do Convênio**: Formato - 99/AAAA, Tipo - NUMÉRICO.
  * **Código SIAFI**: Formato 99999, Tipo - NUMÉRICO.
  * **Origem Recursos**: Tipo - TEXTO.
  * **Tipo de Documento**: Tipo - TEXTO. Por exemplo: ''CONVÊNIO'', ''PORTARIA'', ''DESCENTRALIZAÇÃO''.
  * **Classificação**: Tipo - TEXTO. Por exemplo: ''DESPESA'', ''RECEITA'', ''ESTÁGIO''.
  * **Data de Assinatura**: Formato DD/MM/AAAA, Tipo - DATA.
  * **Prazo de Vigência**: Formato DD/MM/AAAA, Tipo - DATA.
  * **Valor do Convênio**: Formato - 99,99, Tipo - NUMÉRICO.
  * **Status**: Tipo - TEXTO.
  * **Descrição**: Tipo - TEXTO.
  * **Objetivos do Convênio**: Tipo - TEXTO. 

É possível também [[Imprimir Capa de Convênio]]. Com isso chega ao final o caso de uso.


===== Principais Regras de Negócio =====

As Regras de Negócio são as mesmas do caso de uso [[desenvolvimento:especificacoes:sipac:convenios:casos_de_uso:convenios:convenios:registrar_convenio|Registrar Convênio]] acrescentando a regra:
  - Um convênio para ser cadastrado é preciso que antes disso ele seja registrado.
  - O prazo de vigência deve ser igual ou superior a data de assinatura.

===== Classes Persistentes e Tabelas Envolvidas =====

^ Classe ^ Tabela |
| br.ufrn.sipac.convenios.dominio.Convenio  | administrativo.convenios.convenio  |
| br.ufrn.sipac.convenios.dominio.ClassificacaoConvenio | administrativo.convenios.classificacao_convenio |
| br.ufrn.sipac.convenios.dominio.TipoDocConvenio | administrativo.convenios.tipo_documento_convenio |
| br.ufrn.sipac.cadastro.dominio.Unidade | administrativo.comum.unidade |
| br.ufrn.sipac.cadastro.dominio.Pessoa | administrativo.comum.pessoa |
| br.ufrn.sipac.convenios.dominio.ConvenenteTipoConvenente | administrativo.convenios.convenente_tipo_convenente |

====== Plano de Teste ======

Sistema: SIPAC

Módulo: Convênios

Link(s): Projetos -> Convênios -> Convênios -> Cadastrar Convênio

Usuário: afnd

Papel que usuário deve ter: SipacPapeis.GESTOR_CONVENIO

===== Cenários de Teste =====

Verificar se a busca pelo partícipe está trazendo tanto pessoa física quanto jurídica, e se o sistema está exibindo uma mensagem de erro quando o usuário tenta entrar no caso de uso e não existe nenhum convênio cadastrado.

Para visualizar se o cadastro foi feito com sucesso, basta acessar o caso de uso:

**//Projetos → Convênios → Convênios → Editar Convênio //**

e selecionar o convênio que foi cadastrado.

===== Dados para o Teste =====

Para realizar o teste, é necessário registrar um convênio antes, para isso basta acessar o seguinte caso de uso:

**//Projetos -> Convênios -> Convênios -> Registrar Convênio//**

Durante o registro do convênio é preciso cadastrar um novo partícipe para poder inseri-lo, ou então inserir um partícipe que já esteja cadastrado, para buscar informações de partícipes já cadastrados basta acessar o caso de uso abaixo:

**//Projetos -> Cadastros -> Cadastro -> Partícipes -> Alterar/Remover//**