br.gov.mj.frameworkprocessos.protocolo.servicos
Interface Protocolo

All Known Implementing Classes:
AbstractProtocoloFacade, ProtocoloDelegate, ProtocoloFacadeSession

public interface Protocolo

Author:
gabriel.vicente versão: 1.0

Field Summary
static java.lang.Integer ACAO_GERACAO_PROTOCOLOS
           
static java.lang.Integer ACAO_IMPRESSAO_ETIQUETAS
           
 
Method Summary
 void baixaNumeroProtocolo(java.lang.String protocolo)
          Método para dar baixa em um determinado número de protocolo.
 java.util.Map<java.lang.Integer,java.util.List<Protocolo>> getLotesPendentes(java.lang.Integer codigoUorg)
          Este método retorna um HashMap contendo como chave o número do lote que está sendo impresso e como par da chave retorna uma lista contendo o primeiro e o último protocolo do lote.
 java.util.List<Protocolo> getNumeroProtocolo(java.lang.Integer numero, java.lang.Integer codigouorg, Sessao sessao)
          Método para gerar e retornar todos os números de protocolos de uma determinada UORG, sendo informado o número de protocolos que se deseja criar, para que possa ser criado, a UORG solicitante tem que ser uma Unidadade Protololadora.
 java.util.List<Protocolo> getNumerosPendentes(java.lang.Integer codigoUorg)
          Método para recuperar todos os números de protocolo pendentes de uma determinada UORG.
 JasperPrint getReportLotePendente(java.lang.Integer numeroLote, java.lang.String numeroProtocoloInicial, java.lang.String numeroProtocoloFinal, java.lang.String tituloEtiqueta, java.lang.Integer codigoUorg, Sessao sessao)
          Deprecated.  
 JasperPrint getReportLotePendente(java.lang.Integer numeroLote, java.lang.String numeroProtocoloInicial, java.lang.String numeroProtocoloFinal, java.lang.String siglaUorg, java.lang.String descricaoUorg, java.lang.Integer codigoUorg, Sessao sessao)
          Método para impressão Comum, que atende ao padrão de siglas, responsável por consultar e gerar o relatório do jasper reports com todos os número de protocolos pendentes dentro de um lote e no intervalo passado como parâmetro, os parâmetros numeroProtocoloInicio e numeroProtocoloFinal devem estar dentro do intervalo do Lote passado também como parâmetro.
 JasperPrint getReportLotePendenteEtiquetaNova(java.lang.Integer numeroLote, java.lang.String numeroProtocoloInicial, java.lang.String numeroProtocoloFinal, java.lang.String siglaUorg, java.lang.String descricaoUorg, java.lang.Integer codigoUorg, Sessao sessao)
          Método para impressora à cera, que atende ao padrão de siglas, responsável por consultar e gerar o relatório do jasper reports com todos os número de protocolos pendentes dentro de um lote e no intervalo passado como parâmetro, os parâmetros numeroProtocoloInicio e numeroProtocoloFinal devem estar dentro do intervalo do Lote passado também como parâmetro.
 JasperPrint getReportLotePendenteEtiquetaZebra(java.lang.Integer numeroLote, java.lang.String numeroProtocoloInicial, java.lang.String numeroProtocoloFinal, java.lang.String siglaUorg, java.lang.String descricaoUorg, java.lang.Integer codigoUorg, Sessao sessao)
          Método para impressora Zebra, que atende ao padrão de siglas, responsável por consultar e gerar o relatório do jasper reports com todos os número de protocolos pendentes dentro de um lote e no intervalo passado como parâmetro, os parâmetros numeroProtocoloInicio e numeroProtocoloFinal devem estar dentro do intervalo do Lote passado também como parâmetro.
 JasperPrint getReportNumeroProtocoloPendente(java.lang.String numeroProtocoloPendente, Sessao sessao)
          Este métdo consulta se o protocolo passado como parâmetro está pendente, caso for pendente, o método retorna o relatório com a etiqueta do protocolo pendente.
 java.lang.Boolean getStatusProtocolo(java.lang.String protocolo)
          Método para recuperar o status de um protocolo, informando se o mesmo já foi utilizado ou não.
 

Field Detail

ACAO_GERACAO_PROTOCOLOS

static final java.lang.Integer ACAO_GERACAO_PROTOCOLOS

ACAO_IMPRESSAO_ETIQUETAS

static final java.lang.Integer ACAO_IMPRESSAO_ETIQUETAS
Method Detail

getNumeroProtocolo

java.util.List<Protocolo> getNumeroProtocolo(java.lang.Integer numero,
                                             java.lang.Integer codigouorg,
                                             Sessao sessao)
                                             throws ParametroInvalidoException,
                                                    ErroInternoException,
                                                    UnidadeNaoProtocolizadoraException,
                                                    AcessoNegadoException
Método para gerar e retornar todos os números de protocolos de uma determinada UORG, sendo informado o número de protocolos que se deseja criar, para que possa ser criado, a UORG solicitante tem que ser uma Unidadade Protololadora.

Parameters:
numero - onde deve ser informado o número de protocolos que se deseja criar
codigouorg - onde deve ser informado qual a unidade protocoladora que se deseja gerar os números de protocolo
Returns:
List
Throws:
ParametroInvalidoException - , ErroInternoException, UnidadeNaoProtocolizadoraException
ErroInternoException
UnidadeNaoProtocolizadoraException
AcessoNegadoException

baixaNumeroProtocolo

void baixaNumeroProtocolo(java.lang.String protocolo)
                          throws ParametroInvalidoException,
                                 ErroInternoException,
                                 ProtocoloInexistenteException
Método para dar baixa em um determinado número de protocolo.

Parameters:
Protocolo - que se deseja dar baixa.
Throws:
ProtocoloInexistenteException
ParametroInvalidoException - , ErroInternoException, ProtocoloInexistenteException
ErroInternoException

getStatusProtocolo

java.lang.Boolean getStatusProtocolo(java.lang.String protocolo)
                                     throws ParametroInvalidoException,
                                            ErroInternoException
Método para recuperar o status de um protocolo, informando se o mesmo já foi utilizado ou não.

Parameters:
Protocolo - onde deve ser informado qual protocolo deseja verificar o status
Returns:
Boolean
Throws:
ParametroInvalidoException - , ErroInternoException
ErroInternoException

getNumerosPendentes

java.util.List<Protocolo> getNumerosPendentes(java.lang.Integer codigoUorg)
                                              throws ParametroInvalidoException,
                                                     ErroInternoException
Método para recuperar todos os números de protocolo pendentes de uma determinada UORG.

Parameters:
codigouorg - onde deve ser informado qual UORG deve ser recuperado os protocolos pendentes
Throws:
ParametroInvalidoException - , ErroInternoException
ErroInternoException

getLotesPendentes

java.util.Map<java.lang.Integer,java.util.List<Protocolo>> getLotesPendentes(java.lang.Integer codigoUorg)
                                                                             throws ParametroInvalidoException,
                                                                                    ErroInternoException
Este método retorna um HashMap contendo como chave o número do lote que está sendo impresso e como par da chave retorna uma lista contendo o primeiro e o último protocolo do lote. Não retorna protocolos que tenham o atributo numeroLote=null.

Parameters:
codigoUorg - onde deve ser informado qual UORG deve ser recuperado os protocolos pendentes
Throws:
ParametroInvalidoException - , ErroInternoException
ErroInternoException

getReportLotePendente

JasperPrint getReportLotePendente(java.lang.Integer numeroLote,
                                  java.lang.String numeroProtocoloInicial,
                                  java.lang.String numeroProtocoloFinal,
                                  java.lang.String tituloEtiqueta,
                                  java.lang.Integer codigoUorg,
                                  Sessao sessao)
                                  throws ParametroInvalidoException,
                                         ErroInternoException,
                                         AcessoNegadoException
Deprecated. 

Método responsável por consultar e gerar o relatório do jasper reports com todos os número de protocolos pendentes dentro de um lote e no intervalo passado como parâmetro, os parâmetros numeroProtocoloInicio e numeroProtocoloFinal devem estar dentro do intervalo do Lote passado também como parâmetro.

Parameters:
numeroLote -
numeroProtocoloInicial -
numeroProtocoloFinal -
tituloEtiqueta -
codigoUorg -
Throws:
ParametroInvalidoException - , ErroInternoException
ErroInternoException
AcessoNegadoException

getReportLotePendente

JasperPrint getReportLotePendente(java.lang.Integer numeroLote,
                                  java.lang.String numeroProtocoloInicial,
                                  java.lang.String numeroProtocoloFinal,
                                  java.lang.String siglaUorg,
                                  java.lang.String descricaoUorg,
                                  java.lang.Integer codigoUorg,
                                  Sessao sessao)
                                  throws ParametroInvalidoException,
                                         ErroInternoException,
                                         AcessoNegadoException
Método para impressão Comum, que atende ao padrão de siglas, responsável por consultar e gerar o relatório do jasper reports com todos os número de protocolos pendentes dentro de um lote e no intervalo passado como parâmetro, os parâmetros numeroProtocoloInicio e numeroProtocoloFinal devem estar dentro do intervalo do Lote passado também como parâmetro.

Parameters:
numeroLote -
numeroProtocoloInicial -
numeroProtocoloFinal -
siglaUorg -
descricaoUorg -
codigoUorg -
sessao -
Returns:
Throws:
ParametroInvalidoException
ErroInternoException
AcessoNegadoException

getReportLotePendenteEtiquetaNova

JasperPrint getReportLotePendenteEtiquetaNova(java.lang.Integer numeroLote,
                                              java.lang.String numeroProtocoloInicial,
                                              java.lang.String numeroProtocoloFinal,
                                              java.lang.String siglaUorg,
                                              java.lang.String descricaoUorg,
                                              java.lang.Integer codigoUorg,
                                              Sessao sessao)
                                              throws ParametroInvalidoException,
                                                     ErroInternoException,
                                                     AcessoNegadoException
Método para impressora à cera, que atende ao padrão de siglas, responsável por consultar e gerar o relatório do jasper reports com todos os número de protocolos pendentes dentro de um lote e no intervalo passado como parâmetro, os parâmetros numeroProtocoloInicio e numeroProtocoloFinal devem estar dentro do intervalo do Lote passado também como parâmetro.

Parameters:
numeroLote -
numeroProtocoloInicial -
numeroProtocoloFinal -
siglaUorg -
descricaoUorg -
codigoUorg -
sessao -
Returns:
Throws:
ParametroInvalidoException
ErroInternoException
AcessoNegadoException

getReportLotePendenteEtiquetaZebra

JasperPrint getReportLotePendenteEtiquetaZebra(java.lang.Integer numeroLote,
                                               java.lang.String numeroProtocoloInicial,
                                               java.lang.String numeroProtocoloFinal,
                                               java.lang.String siglaUorg,
                                               java.lang.String descricaoUorg,
                                               java.lang.Integer codigoUorg,
                                               Sessao sessao)
                                               throws ParametroInvalidoException,
                                                      ErroInternoException,
                                                      AcessoNegadoException
Método para impressora Zebra, que atende ao padrão de siglas, responsável por consultar e gerar o relatório do jasper reports com todos os número de protocolos pendentes dentro de um lote e no intervalo passado como parâmetro, os parâmetros numeroProtocoloInicio e numeroProtocoloFinal devem estar dentro do intervalo do Lote passado também como parâmetro.

Parameters:
numeroLote -
numeroProtocoloInicial -
numeroProtocoloFinal -
siglaUorg -
descricaoUorg -
codigoUorg -
sessao -
Returns:
Throws:
ParametroInvalidoException
ErroInternoException
AcessoNegadoException

getReportNumeroProtocoloPendente

JasperPrint getReportNumeroProtocoloPendente(java.lang.String numeroProtocoloPendente,
                                             Sessao sessao)
                                             throws ParametroInvalidoException,
                                                    ErroInternoException,
                                                    AcessoNegadoException
Este métdo consulta se o protocolo passado como parâmetro está pendente, caso for pendente, o método retorna o relatório com a etiqueta do protocolo pendente.

Parameters:
numeroProtocoloPendente -
Throws:
ParametroInvalidoException - , ErroInternoException
ErroInternoException
AcessoNegadoException