~~ODT~~

<PHP>
echo "<div style='display:block;float:right;'>"; 
echo "Última atualização: ";
ver('', false);
echo "</div>";
</PHP>

====== Buscar Protocolo de Empenhos ======

O empenho é a primeira fase da despesa e pode ser conceituado conforme prescreve o art. 58 da Lei nº 4.320/64. Este caso de uso tem a funcionalidade de busca e visualização dos protocolos de empenhos já emitidos pelo sistema. 

Esta operação pode ser realizada pelos usuários que estão habilitados a realizar o controle da liquidação de despesas e das compras da instituição.

Pré-condições: O usuário deve possuir o perfil de Gestor de Liquidação de Despesas para executar esta funcionalidade.

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

Este caso de uso inicia quando o usuário acessa a opção: //SIPAC -> Liquidação de Despesas -> Aba Relatórios -> Empenho -> Buscar Protocolo de Empenhos//.

O sistema solicita que informe um ou mais parâmetros para a busca:
  * **Unidade Gestora***: Formato - NOME(CÓDIGO), TIPO - TEXTO E NÚMERO  
  * **Período de Cadastro**: Formato - DD/MM/AAAA à DD/MM/AAAA, Tipo - DATA.
  * **Protocolo(Número/Ano)**: Formato - 9.../AAAA, Tipo - NUMÉRICO.
  * **Empenho(Número/Ano )**: Formato - 9.../AAAA , Tipo - NUMÉRICO.
  * **Formato de Relatório**: Tipo - LÓGICO

Caso a opção de busca seja pelo //Número/Ano do Protocolo//, o sistema exibe a lista com os empenhos associados ao protocolo, mas se a opção de busca for //Número/Ano do Empenho//, o sistema exibe a lista com os protocolos associados ao empenho informado. 

Confirmando os parâmetros informados, caso a opção //Formato de Relatório// não tenha sido informada, o sistema mostrará abaixo os dados dos protocolos encontrados na busca. Esses dados são:

  * **__Protocolo__**: Formato - 9.../AAAA, Tipo - NUMÉRICO.
    * **__Empenho__**: Formato - 9.../AAAA, Tipo - NUMÉRICO. O Empenho pode ser detalhado através do caso de uso [[desenvolvimento:especificacoes:sipac:liquidacao_de_despesas:casos_de_uso:liquidacao_de_despesas:consultas:empenhos|Consulta de Empenhos]].
    * **__Recebimento__**: Formato - DD/MM/AAAA | NÃO RECEBIDO, Tipo - DATA.
    * **__Valor__**: Tipo - NUMÉRICO.
    * **__Licitação__**: Formato - NOME DA MODALIDADE - 9.../AAAA, Tipo - TEXTO e NUMÉRICO.
    * **__Unidade__**: Formato - NOME DA UNIDADE, Tipo - TEXTO.
    * **__Fornecedor__**: Tipo - TEXTO.
    * **__Material__**: Tipo - TEXTO.

Caso o usuário selecione a opção de Formato de Relatório, o sistema exibe o modelo:

===MODELO===

**Relatório de Protocolo de Empenhos**

  * **__Período de Cadastro__**: DD/MM/AAAA à DD/MM/AAAA, Tipo - DATA.
  * **__Protocolo__**: Formato - 9.../AAAA, Tipo - NUMÉRICO.
  * **__Empenho__**: 9.../AAAA - SIGLAS UNIDADE GESTORA, Tipo - TEXTO e NUMÉRICO.
__ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ __


|  **__Protocolo__**: Formato - 9.../AAAA, Tipo - NUMÉRICO.  ||||||
^ Empenho  ^  Recebimento  ^  Valor ^ Licitação  ^ Unidade  ^ Fornecedor  ^
| 9.../AAAA|  DD/MM/AAAA  | R$ 99,99| NOME DA MODALIDADE 9.../AAAA | NOME DA UNIDADE   | NOME DO FORNECEDOR  |
| **Material**: DESCRIÇÃO DOS MATERIAIS  ||||||
| ------  ||||||
| 9.../AAAA|  DD/MM/AAAA  | R$ 99,99| NOME DA MODALIDADE 9.../AAAA | NOME DA UNIDADE   | NOME DO FORNECEDOR  |
| **Material**: DESCRIÇÃO DOS MATERIAIS  ||||||
| ------  ||||||
|  **__Protocolo__**: Formato - 9.../AAAA, Tipo - NUMÉRICO.  ||||||
| 9.../AAAA|  DD/MM/AAAA  | R$ 99,99| NOME DA MODALIDADE 9.../AAAA  | SUPERINTENDÊNCIA   | EMPRESA Ltda.  |
| **Material**: ARMÁRIO DE COZINHA ARMÁRIO GUARDA-VOLUMES – 06  ||||||
| ------  ||||||
| 9.../AAAA|  DD/MM/AAAA  | R$ 99,99| NOME DA MODALIDADE 9.../AAAA  | SUPERINTENDÊNCIA   | EMPRESA Ltda.  |
| **Material**: ARMÁRIO DE COZINHA ARMÁRIO GUARDA-VOLUMES – 06  ||||||


__ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ __

**Total de Protocolos de Empenho**: 99

O Empenho pode ser detalhado através do caso de uso [[desenvolvimento:especificacoes:sipac:liquidacao_de_despesas:casos_de_uso:liquidacao_de_despesas:consultas:empenhos|Consulta de Empenhos]].


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

  * **RN01** - O usuário logado só poder ver dados para as unidades que o papel GESTOR LIQUIDAÇÃO tem permissão. Por exemplo, o usuário com login: pedro pertence a unidade 14.00(CT), mas foi cadastrada a permissão de GESTOR LIQUIDACAO para (11.00) e (23.00) então ele possui a permissão de ver dados apenas da 11.00 e 23.00 e não possui permissao para 1400. Já o usuário que tiver o papel GESTOR LIQUIDACAO e tiver unidade de Permissao igual a nulo poderá ver os dados de todas as unidades. 

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

**Art. 58 da Lei nº 4.320/64**: O empenho é o ato emanado de autoridade competente que cria o Estado obrigação de pagamento pendente ou não de implemento de condição.

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

^ Classe ^ Tabela |
| br.ufrn.sipac.liquidacao.acompanhamento.dominio.ProtocoloEmpenhos | administrativo.liquidacao.protocolo_empenhos |
| br.ufrn.sipac.orcamento.movimentacoes.dominio.Empenho | administrativo.sco.empenho |


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

Sistema: SIPAC

Módulo: Liquidação de Despesas

Link(s): Liquidação de Despesas -> Relatórios -> Empenho -> Buscar Protocolo de Empenhos

Usuário: paulinho

Papel que o usuário deve ter: SipacPapeis.GESTOR_LIQUIDACAO.

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

Os protocolos de empenhos podem ser emitidos pelo caminho:

  *  Módulos -> Liquidação de Despesas -> Liquidação de Despesas -> Empenho -> Emitir Protocolo de Empenhos

Verificar se as informações dos protocolos trazidos na busca são as mesmas para os diferentes filtros de busca.

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

Não foi possível encontrar no sistema um caso de uso que verificasse se os dados trazidos na busca estavam corretos, no entanto essa informação pode ser verificada pela consulta abaixo:

<code sql>
SELECT pe.id, pe.numero, pe.ano, pe.data_cadastro, pe.id_usuario 
FROM liquidacao.item_protocolo_empenhos ipe
     INNER JOIN liquidacao.protocolo_empenhos pe ON ipe.id_protocolo_empenhos = pe.id
     INNER JOIN sco.empenho e ON ipe.id_empenho = e.id_empenho
WHERE e.cod_empenho = <<NÚMERO DO EMPENHO>> AND e.ano = <<ANO DO EMPENHO>>
AND pe.data_cadastro >= <<PERÍODO INICIAL DO CADASTRO>> AND pe.data_cadastro <= <<PERÍODO FINAL DO CADASTRO>>
</code>

Para buscar por um número de protocolo de certo empenho, a seguinte consulta pode ser usada: //SELECT p.numero, p.ano FROM liquidacao.protocolo_empenhos p//