====== Estornar Cancelamento de Empenho  ======

O estorno da [[desenvolvimento:especificacoes:sipac:orcamentario:casos_de_uso:movimentacoes:empenho:cancelar_nota_de_empenho|cancelamento de empenho]] tem o objetivo de cancelar a operação de cancelamento do empenho. O estorno deverá ser utilizado quando houve algum erro ao cadastrar o Cancelamento de Empenho, a operação inativará o registro e toda a movimentação relacionada. O valor relacionado ao cancelamento será debitado do orçamento.
      

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

O caso de uso inicia quando o usuário acessa //SIPAC -> Orçamento -> Estornos -> Estorno -> Cancelamento de Empenho//.

===Passo 1===

Para realizar o estorno do cancelamento de empenho é necessário informar o número do empenho, este empenho deverá possuir alguma anulação. Ou ainda informar o número do empenho e o número da anulação de empenho. Conforme abaixo: ([[desenvolvimento:especificacoes:sipac:orcamentario:casos_de_uso:estornos:estorno:cancelamento_de_empenho#Principais Regras de Negócio|RN01,RN02,RN03,RN04]])

  * **__Ano Orçamentário__**: Formato - ANO ORÇAMENTÁRIO ATUAL (9999). Tipo - NUMÉRICO.
  * **Empenho***: Formato - NÚMERO/ANO Tipo - NUMÉRICO.
  * **Unidade**: Formato - NOME DA UNIDADE. Tipo - TEXTO. (As unidades serão listadas conforme o empenho informado)
  * **Documento de Cancelamento de Empenho**: Formato - 999... Tipo - NUMÉRICO

===Passo 2===
Após a consulta ser realizada são exibidos os dados do empenho e seus cancelamentos listados abaixo conforme foi informado os dados na consulta:

    ***__Empenho__**: Formato - 9.../AAAA, Tipo - NUMÉRICO.
    ***__Gestora__**: formato: NOME GESTORA (CÓDIGO), Tipo - TEXTO.
    ***__Data__**: Formato - DD/MM/AAAA, Tipo - DATA.
    ***__Processo__**: Formato - 9.../AAAA, Tipo - NUMÉRICO.
    ***__Prog. de Trabalho Resum__.**: Formato - NOME PROGRAMA (CÓDIGO), Tipo - TEXTO.
    ***__Natureza da Despesa__**: Formato - NOME NATUREZA (CÓDIGO), Tipo - TEXTO.
    ***__Fonte de Recurso__**: Formato - NOME FONTE (CÓDIGO), Tipo - TEXTO.
    ***__Esfera__**: Formato - NOME ESFERA (CÓDIGO), Tipo - TEXTO.
    ***__Plano Interno__**: formato: NOME PLANO INTERNO (CÓDIGO), Tipo TEXTO.
    ***__Modalidade__**: Tipo - TEXTO. As modalidades apresentadas são: ''ESTIMATIVO'', ''ORDINÁRIO'' ou ''GLOBAL''.
    ***__Licitação__**:  Tipo - NUMÉRICO.
    ***__Credor__**: Formato - NOME CREDOR, Tipo TEXTO.
    ***__Total do empenho__**: Tipo NUMÉRICO.
    ***__Saldo do Empenho__**: Tipo NUMÉRICO.
    ***__Valor Anulado__**: Tipo NUMÉRICO.
    ***__Valor Reforçado__**: Tipo NUMÉRICO.
    ***__Valor Cancelado__**: Tipo NUMÉRICO. 
    ***__Registrado por__**: Tipo TEXTO, formato: NOME USUÁRIO (LOGIN).
    *Sistema apresenta opção para visualizar detalhes do usuário que efetuou o registro, exibindo as informações:
      ***__Login__**: Tipo - TEXTO.
      ***__Nome__**: Tipo - TEXTO.
      ***__Unidade__**: Tipo - TEXTO.
      ***__Email__**: Tipo - TEXTO.
      ***__Telefone__**:  Tipo - NUMÉRICO.
      ***__Ramal__**: Tipo - NUMÉRICO.
  *Sistema apresenta lista dos Centros de Custo, com os dados:
     * **__Centro de Custo__**: Tipo TEXTO, formato: NOME DA UNIDADE (CÓDIGO). Observa-se que o //**Centro de Custo**// corresponde a Unidade Gestora da instituição.
     * **__Valor__**: Tipo - NUMÉRICO.
     * **__Saldo__**: Tipo - NUMÉRICO.
       * **__Detalhamento por Sub-Item__**: Tipo - TEXTO.
       * **__Valor__**: Tipo - NUMÉRICO.
     ***__Total do Valor e Saldo__**: Tipo - NUMÉRICO.

  *Sistema apresenta lista dos cancelamentos de empenho com os dados:
     * **__Documento__**: Tipo - NUMÉRICO.
     * **__Tipo__**: Formato - ''Cancelamento Total do Empenho'' ou ''Cancelamento Parcial do Empenho''. Tipo - TEXTO.
     * **__Unidade__**: Formato - NOME DA UNIDADE(CÓDIGO) Tipo - TEXTO.
     * **__Data__**: Formato - DD/MM/AAAA, Tipo - DATA.
     * **__Valor__**: Tipo - NUMÉRICO.
     * Opção de Estorno. ([[desenvolvimento:especificacoes:sipac:orcamentario:casos_de_uso:estornos:estorno:cancelamento_de_empenho#Principais Regras de Negócio|RN04]])

===Passo 3===
Ao selecionar a opção de estorno será exibido o comprovante de estorno conforme os dados abaixo:

  * **__Número do Empenho__**. Formato - 9.../AAAA. Tipo NUMÉRICO e TEXTO. Um link para visualizar detalhes do empenho é exibido.
  * **__Documento__**. Formato - CÓDIGO DO CANCELAMENTO. Tipo - NUMÉRICO
  * **__Unidade__**: Formato - NOME DA UNIDADE. Tipo - TEXTO.
  * **__Data do Cancelamento__**. Tipo - DATA
  * **__Data do Estorno__**. Tipo - DATA
  * **__Tipo__**: Formato - ''Cancelamento Total do Empenho'' ou ''Cancelamento Parcial do Empenho''. Tipo - TEXTO.
  * **__Valor__**. Formato: 9999,9999. Tipo - NUMÉRICO.
  * **__Observações__**. Tipo - TEXTO
  * **__Movimentador__**: Tipo TEXTO, formato: NOME USUÁRIO.
    *Sistema apresenta opção para visualizar detalhes do usuário que efetuou o registro, exibindo as informações:
      ***__Login__**: Tipo - TEXTO.
      ***__Nome__**: Tipo - TEXTO.
      ***__Unidade__**: Tipo - TEXTO.
      ***__Email__**: Tipo - TEXTO.
      ***__Telefone__**:  Tipo - NUMÉRICO.
      ***__Ramal__**: Tipo - NUMÉRICO.

  * Opção para Realizar Outro Estorno de Cancelamento no Mesmo Empenho retornando ao **Passo 2**

O caso de uso é finalizado.

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

Para executar o caso de uso é necessário que exista se avalie as seguintes situações:

  * **RN01:**  Se a busca for feita pelo número/ano do empenho:
    *  O código do empenho deverá corresponder a um empenho que tenha como unidade gestora a gestora do usuário logado;

  * **RN02:** Se a buscar feita pelo número/ano do empenho e o pelo subempenho:
    *  Serão exibidos apenas os cancelamentos referentes ao subempenho selecionado;

  * **RN03:** Se a buscar feita pelo número/ano do empenho, subempenho e número do cancelamento:
    *  Será exibida apenas o cancelamento com o número informado;

  * **RN04:** Não será permitido realizar o estorno de um cancelamento que esteja associado a um empenho anulado totalmente.

==== Resoluções/Legislações Associadas ====

Não se Aplica. 

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

^ Classe ^ Tabela |
|br.ufrn.sipac.orcamento.movimentacoes.dominio.EventoEmpenho|administrativo.sco.evento_empenho|
|br.ufrn.sipac.orcamento.movimentacoes.dominio.MovimentacaoOrcamentaria|administrativo.sco.movimentacao_orcamentaria|

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

Sistema: SIPAC

Módulo: SCO

Link(s): Estornos -> Estorno -> Cancelamento de Empenho

Usuário: larrubia2 (EXECUTOR_ORCAMENTO_GLOBAL), seoccet02 (EXECUTOR_ORCAMENTO_LOCAL), raiula (EXECUTOR_CONVENIO)

Papel que usuário deve ter: ScoPapeis.EXECUTOR_ORCAMENTO_LOCAL, ScoPapeis.EXECUTOR_ORCAMENTO_GLOBAL, ScoPapeis.EXECUTOR_CONVENIO

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

Realizar o estorno e verificar as movimentações orçamentários no relatório SCO -> Relatórios -> Movimentações Orçamentárias -> Movimentação Orçamentária por Unidade

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

Para obter os dados necessários para a realização do teste deste caso de uso deve ser buscado estes dados em SCO -> Consultas -> Empenho -> Cancelamento de Empenho. Nesta consulta deverá observado o número do empenho.