br.gov.mj.frameworkprocessos.processo.servicos
Interface Tramite

All Known Implementing Classes:
AbstractTramiteFacade, TramiteDelegate, TramiteFacadeSession

public interface Tramite

Interface para prestar serviços ao FP ao que diz respeito a trâmite e unidade de trâmite.

Version:
$Revision: 1.33 $ $Date: 2007-07-13 13:06:26 $
Author:
União Federativa do Brasil, Ministério da Justiça, SE-SPOA-CGTI

Method Summary
 ResponsavelTecnico atribuirResponsavelTecnico(java.lang.Integer codigoDocumento, java.lang.Integer codigoPessoaFisica, Sessao sessao)
          Altera o responsável técnico de um trâmite.
 void atualizarPrazoTramite(java.lang.Integer codigoTramite, java.lang.Integer prazo, ProcessoUtil.TipoPrazo tipoPrazo, Sessao sessao)
          Atualiza o prazo das ações de um trâmite.
 void cancelarTramite(java.lang.Integer codigoTramite, Sessao sessao)
          Cancela um trâmite.
 void confirmarEnvioGuia(Sessao sessao, java.lang.Integer... codigosTramites)
          Confirma o envio (impressão) da(s) guia(s).
 void confirmarTramiteExterno(Tramite tramite, Sessao sessao)
          Confirma o recebimento de um trâmite externo
 java.util.List<GrupoTramite> getGruposTramite(java.lang.Boolean ativo)
          Pesquisa pelos grupos de trâmite.
 java.util.List<GrupoTramite> getGruposTramitePorOrgaoAdmPublica(java.lang.Integer codigoPessoaJuridica, java.lang.Boolean ativo)
          Pesquisa pelos grupos de trâmite que pertencem a um Órgão da Administração Pública.
 GrupoTramite getGrupoTramite(java.lang.Integer codigoGrupoTramite)
          Pesquisa pelo grupo de trâmite especificado
 UnidadeTramite getProtocoloCentralAtivo()
          Pesquisa o protocolo central ativo
 UnidadeTramite getProtocoloSetorialAtivoPorGrupo(java.lang.Integer codigoGrupoTramite)
          Pesquisa pelo protocolo setorial ativo de um grupo
 ResponsavelTecnico getResponsavelTecnico(java.lang.Integer codigoResponsavelTecnico)
          Pesquisa pelo responsável técnico
 ResponsavelTecnico getResponsavelTecnicoAtual(java.lang.Integer codigoDocumento)
          Pesquisa pelo responsável técnico atual de um documento.
 java.util.List<UnidadeTramite> getTodosProtocolosCentrais()
          Pesquisa por todos os protocolos centrais
 java.util.List<UnidadeTramite> getTodosProtocolosSetoriaisPorGrupo(java.lang.Integer codigoGrupoTramite)
          Pesquisa por todos os protocolos setoriais de um grupo
 Tramite getTramite(java.lang.Integer codigoTramite)
          Retorna o trâmite especificado como parâmetro
 java.util.List<TramiteVO> getTramites(java.lang.Integer codigoDocumento)
          Pesquisar pelos trâmites de um documento
 java.util.List<Tramite> getTramites(Tramite tramite)
          Pesquisar trâmites por um exemplo
 Tramite getUltimoTramite(java.lang.Integer codigoDocumento, java.lang.Boolean isTramiteEncerrado, java.lang.Boolean procurarDocumentoPrincipal)
          Pesquisa pelo último trâmite de um documento
 java.util.List<UnidadeTramite> getUnidadesTramite(UnidadeTramite unidadeTramiteExemplo)
          Pesquisa uma unidade de trâmite por um exemplo
 java.util.List<UnidadeTramite> getUnidadesTramitePorGrupo(java.lang.Integer codigoGrupoTramite, java.lang.Boolean ativo)
          Pesquisa pelas unidades de trâmite de um grupo
 java.util.List<UnidadeTramite> getUnidadesTramitePorUsuario(Sessao sessao)
          Pesquisa pelas unidades de trâmite de um usuário.
 java.util.List<UnidadeTramite> getUnidadesTramitesPermitidas(java.lang.Integer codigoUnidadaOrigem)
          Pesquisa por todas as unidades para as quais a unidade informada pode tramitar
 UnidadeTramite getUnidadeTramite(java.lang.Integer codigoUnidadeTramite)
          Pesquisa pela unidade de trâmite especificada
 java.util.List<Usuario> getUsuariosPorUnidadeTramite(java.lang.Integer codigoUnidadeTramite, Sessao sessao)
          Pesquisa pelos usuários de uma unidade de trâmite (unidades, protocolos central e setoriais).
 Tramite realizarTramite(Tramite tramite, Sessao sessao)
          Tramita um documento/processo.
 Tramite receberTramite(Tramite tramite, Sessao sessao)
          Recebe o trâmite especificado
 void retirarResponsavelTecnico(java.lang.Integer codigoDocumento, Sessao sessao)
          Retira a responsabilidade técnica de um trâmite.
 java.lang.Boolean verificarPossibilidadeTramite(java.lang.Integer codigoUnidadeOrigem, java.lang.Integer codigoUnidadeDestino)
          Verifica se há a possibilidade de trâmite entre duas unidades
 

Method Detail

getUsuariosPorUnidadeTramite

java.util.List<Usuario> getUsuariosPorUnidadeTramite(java.lang.Integer codigoUnidadeTramite,
                                                     Sessao sessao)
                                                     throws ParametroInvalidoException,
                                                            ErroInternoException,
                                                            UnidadeTramiteNaoEncontradaException
Pesquisa pelos usuários de uma unidade de trâmite (unidades, protocolos central e setoriais).

Parameters:
codigoUnidadeTramite - Código da unidade de trâmite
sessao - Sessão do usuário logado no sistema
Throws:
ParametroInvalidoException
ErroInternoException
UnidadeTramiteNaoEncontrada
UnidadeTramiteNaoEncontradaException

getUnidadesTramitePorUsuario

java.util.List<UnidadeTramite> getUnidadesTramitePorUsuario(Sessao sessao)
                                                            throws ParametroInvalidoException,
                                                                   ErroInternoException
Pesquisa pelas unidades de trâmite de um usuário.

Parameters:
sessao - Sessão do usuário logado no sistema
Returns:
Lista das unidades de trâmite do usuário
Throws:
ParametroInvalidoException
ErroInternoException

getUnidadesTramitePorGrupo

java.util.List<UnidadeTramite> getUnidadesTramitePorGrupo(java.lang.Integer codigoGrupoTramite,
                                                          java.lang.Boolean ativo)
                                                          throws ParametroInvalidoException,
                                                                 ErroInternoException
Pesquisa pelas unidades de trâmite de um grupo

Parameters:
codigoGrupoTramite - Código do grupo a ser pesquisado
ativo - Indica se quer só os ativos (true) ou todos (false)
Returns:
Lista das unidades de trêmite do grupo
Throws:
ParametroInvalidoException
ErroInternoException

getProtocoloSetorialAtivoPorGrupo

UnidadeTramite getProtocoloSetorialAtivoPorGrupo(java.lang.Integer codigoGrupoTramite)
                                                 throws ParametroInvalidoException,
                                                        ErroInternoException
Pesquisa pelo protocolo setorial ativo de um grupo

Parameters:
codigoGrupoTramite - Código do grupo a ser pesquisado
Returns:
Protocolo setorial ativo
Throws:
ParametroInvalidoException
ErroInternoException

getTodosProtocolosSetoriaisPorGrupo

java.util.List<UnidadeTramite> getTodosProtocolosSetoriaisPorGrupo(java.lang.Integer codigoGrupoTramite)
                                                                   throws ParametroInvalidoException,
                                                                          ErroInternoException
Pesquisa por todos os protocolos setoriais de um grupo

Parameters:
codigoGrupoTramite - Código do grupo cujos protocolos setoriais serão presquisados
Returns:
Liste de protocolos setoriais
Throws:
ParametroInvalidoException
ErroInternoException

getProtocoloCentralAtivo

UnidadeTramite getProtocoloCentralAtivo()
                                        throws ErroInternoException
Pesquisa o protocolo central ativo

Returns:
Protocolo central
Throws:
ErroInternoException

getTodosProtocolosCentrais

java.util.List<UnidadeTramite> getTodosProtocolosCentrais()
                                                          throws ErroInternoException
Pesquisa por todos os protocolos centrais

Returns:
Lista de protocolos centrais
Throws:
ErroInternoException

getGruposTramite

java.util.List<GrupoTramite> getGruposTramite(java.lang.Boolean ativo)
                                              throws ParametroInvalidoException,
                                                     ErroInternoException
Pesquisa pelos grupos de trâmite.

Parameters:
ativo - Indica se quer só os ativos (true) ou todos (false).
Returns:
Lista de grupos de trâmite
Throws:
ParametroInvalidoException
ErroInternoException

getGrupoTramite

GrupoTramite getGrupoTramite(java.lang.Integer codigoGrupoTramite)
                             throws ParametroInvalidoException,
                                    ErroInternoException
Pesquisa pelo grupo de trâmite especificado

Parameters:
codigoGrupoTramite - Código do grupo de tramite a ser pesquisado
Returns:
Grupo de Tramite encontrado
Throws:
ParametroInvalidoException
ErroInternoException

getGruposTramitePorOrgaoAdmPublica

java.util.List<GrupoTramite> getGruposTramitePorOrgaoAdmPublica(java.lang.Integer codigoPessoaJuridica,
                                                                java.lang.Boolean ativo)
                                                                throws ParametroInvalidoException,
                                                                       ErroInternoException
Pesquisa pelos grupos de trâmite que pertencem a um Órgão da Administração Pública.

Parameters:
codigoPessoaJuridica - código do órgão da administração pública.
ativo - Indica se quer só os ativos (true) ou todos (false).
Returns:
Lista de grupos de trâmite
Throws:
ParametroInvalidoException
ErroInternoException

getUnidadeTramite

UnidadeTramite getUnidadeTramite(java.lang.Integer codigoUnidadeTramite)
                                 throws ParametroInvalidoException,
                                        ErroInternoException
Pesquisa pela unidade de trâmite especificada

Parameters:
codigoUnidadeTramite - Código da unidade de tramite a ser pesquisada
Returns:
Unidade de trâmite encontrada
Throws:
ParametroInvalidoException
ErroInternoException

getUnidadesTramite

java.util.List<UnidadeTramite> getUnidadesTramite(UnidadeTramite unidadeTramiteExemplo)
                                                  throws ParametroInvalidoException,
                                                         ErroInternoException
Pesquisa uma unidade de trâmite por um exemplo

Parameters:
unidadeTramiteExemplo - Unidade de trâmite exemplo para a pesquisa
Returns:
Lista de unidades de trâmite
Throws:
ParametroInvalidoException
ErroInternoException

verificarPossibilidadeTramite

java.lang.Boolean verificarPossibilidadeTramite(java.lang.Integer codigoUnidadeOrigem,
                                                java.lang.Integer codigoUnidadeDestino)
                                                throws ParametroInvalidoException,
                                                       ErroInternoException,
                                                       UnidadeTramiteNaoEncontradaException,
                                                       UnidadeTramiteInativaException
Verifica se há a possibilidade de trâmite entre duas unidades

Parameters:
codigoUnidadeOrigem - Código da unidade de origem do trâmite
codigoUnidadeDestino - Código da unidade de destino do trâmite
Returns:
Se há possibilidade de trâmite retorna true, caso contrário, retorna false
Throws:
ParametroInvalidoException
ErroInternoException,
UnidadeTramiteNaoEncontrada
UnidadeTramiteInativaException
ErroInternoException
UnidadeTramiteNaoEncontradaException

getTramites

java.util.List<TramiteVO> getTramites(java.lang.Integer codigoDocumento)
                                      throws ParametroInvalidoException,
                                             ErroInternoException
Pesquisar pelos trâmites de um documento

Parameters:
codigoDocumento - Código do documento cujos trâmites serão pesquisados
Returns:
Lista de trâmites encontrados
Throws:
ParametroInvalidoException
ErroInternoException

getTramites

java.util.List<Tramite> getTramites(Tramite tramite)
                                    throws ParametroInvalidoException,
                                           ErroInternoException
Pesquisar trâmites por um exemplo

Parameters:
tramite - Trâmite de exemplo para pesquisa
Returns:
Lista de trâmites encontrados
Throws:
ParametroInvalidoException
ErroInternoException

realizarTramite

Tramite realizarTramite(Tramite tramite,
                        Sessao sessao)
                        throws ParametroInvalidoException,
                               ErroInternoException,
                               UnidadeTramiteInativaException,
                               UsuarioSemPosseDocumentoException,
                               UnidadeDestinoNaoPermitidaException,
                               AcessoNegadoException,
                               UnidadeTramiteNaoEncontradaException,
                               DocumentoNaoEncontradoException,
                               DocumentoAssociadoException,
                               TramiteNaoConcluidoException,
                               ModuloSistemaSemPosseDocumentoException
Tramita um documento/processo.

Parameters:
tramite - Trâmite a ser inserido
sessao - Sessão do usuário logado no sistema
Returns:
Trâmite inserido
Throws:
ParametroInvalidoException
ErroInternoException
UnidadeTramiteInativaException
UsuarioSemPosseDocumentoException
UnidadeDestinoNaoPermitidaException
AcessoNegadoException
UnidadeTramiteNaoEncontrada
DocumentoNaoEncontradoException
DocumentoAssociadoException
TramiteNaoConcluidoException
UnidadeTramiteNaoEncontradaException
ModuloSistemaSemPosseDocumentoException

receberTramite

Tramite receberTramite(Tramite tramite,
                       Sessao sessao)
                       throws AcessoNegadoException,
                              ParametroInvalidoException,
                              TramiteNaoEncontradoException,
                              ErroInternoException,
                              UsuarioSemPosseDocumentoException,
                              TramiteJaRecebidoException
Recebe o trâmite especificado

Parameters:
tramite - Tramite a ser recebido
sessao - Sessão do usuário logado no sistema
Throws:
ParametroInvalidoException
ErroInternoException,
TramiteNaoEncontradoException
UsuarioSemPosseDocumentoException,
AcessoNegadoException
TramiteJaRecebidoException
ErroInternoException
UsuarioSemPosseDocumentoException

cancelarTramite

void cancelarTramite(java.lang.Integer codigoTramite,
                     Sessao sessao)
                     throws ParametroInvalidoException,
                            ErroInternoException,
                            TramiteNaoEncontradoException,
                            UsuarioSemPosseDocumentoException,
                            TramiteJaRecebidoException,
                            AcessoNegadoException
Cancela um trâmite.

Parameters:
codigoTramite - Código do tramite a ser cancelado
sessao - Sessão do usuário logado no sistema
Throws:
ParametroInvalidoException
ErroInternoException
TramiteNaoEncontradoException
UsuarioSemPosseDocumentoException
TramiteJaRecebidoException
AcessoNegadoException

getUltimoTramite

Tramite getUltimoTramite(java.lang.Integer codigoDocumento,
                         java.lang.Boolean isTramiteEncerrado,
                         java.lang.Boolean procurarDocumentoPrincipal)
                         throws ParametroInvalidoException,
                                ErroInternoException
Pesquisa pelo último trâmite de um documento

Parameters:
codigoDocumento - Código do documento cujo último trâmite será pesquisado
Returns:
Último trâmite do documento
Throws:
ParametroInvalidoException
ErroInternoException

getUnidadesTramitesPermitidas

java.util.List<UnidadeTramite> getUnidadesTramitesPermitidas(java.lang.Integer codigoUnidadaOrigem)
                                                             throws ErroInternoException,
                                                                    ParametroInvalidoException
Pesquisa por todas as unidades para as quais a unidade informada pode tramitar

Parameters:
codigoUnidadaOrigem - Código da unidade de origem do trâmite
Returns:
Lista das unidades de trâmite que podem ser destino da unidade informada
Throws:
ErroInternoException
ParametroInvalidoException

atribuirResponsavelTecnico

ResponsavelTecnico atribuirResponsavelTecnico(java.lang.Integer codigoDocumento,
                                              java.lang.Integer codigoPessoaFisica,
                                              Sessao sessao)
                                              throws ErroInternoException,
                                                     ParametroInvalidoException,
                                                     TramiteNaoEncontradoException,
                                                     DocumentoNaoEncontradoException,
                                                     PessoaFisicaNaoEncontradaException,
                                                     UsuarioSemPosseDocumentoException,
                                                     ModuloSistemaSemPosseDocumentoException,
                                                     DocumentoAssociadoException
Altera o responsável técnico de um trâmite.

Parameters:
codigoDocumento - Código do documento ao qual o responsável técnico será atribuido
codigoPessoaFisica - Código da pessoa física que será o responsável técnico
sessao - Sessão do usuário logado no sistema
Returns:
Responsável técnico
Throws:
ErroInternoException
ParametroInvalidoException
TramiteNaoEncontradoException
DocumentoNaoEncontradoException
PessoaFisicaNaoEncontradaException
UsuarioSemPosseDocumentoException
ModuloSistemaSemPosseDocumentoException
DocumentoAssociadoException

retirarResponsavelTecnico

void retirarResponsavelTecnico(java.lang.Integer codigoDocumento,
                               Sessao sessao)
                               throws ErroInternoException,
                                      ParametroInvalidoException,
                                      DocumentoNaoEncontradoException,
                                      ResponsavelTecnicoNaoEncontradoException,
                                      UsuarioSemPosseDocumentoException,
                                      DocumentoAssociadoException
Retira a responsabilidade técnica de um trâmite.

Parameters:
codigoDocumento - Código do documento ao qual o responsável técnico será retirado
sessao - Sessão do usuário logado no sistema
Throws:
ErroInternoException
ParametroInvalidoException
ResponsavelTecnicoNaoEncontradoException
UsuarioSemPosseDocumentoException
DocumentoNaoEncontradoException
DocumentoAssociadoException

getResponsavelTecnicoAtual

ResponsavelTecnico getResponsavelTecnicoAtual(java.lang.Integer codigoDocumento)
                                              throws ErroInternoException,
                                                     ParametroInvalidoException
Pesquisa pelo responsável técnico atual de um documento.

Parameters:
codigoDocumento - Código do documento cujo responsável técnico será pesquisado.
Returns:
Responsável técnico atual
Throws:
ErroInternoException
ParametroInvalidoException

getResponsavelTecnico

ResponsavelTecnico getResponsavelTecnico(java.lang.Integer codigoResponsavelTecnico)
                                         throws ErroInternoException,
                                                ParametroInvalidoException
Pesquisa pelo responsável técnico

Parameters:
codigoResponsavelTecnico - Código do responsável técnico que será pesquisado.
Returns:
Responsável técnico
Throws:
ErroInternoException
ParametroInvalidoException

confirmarTramiteExterno

void confirmarTramiteExterno(Tramite tramite,
                             Sessao sessao)
                             throws AcessoNegadoException,
                                    ParametroInvalidoException,
                                    TramiteNaoEncontradoException,
                                    ErroInternoException,
                                    UsuarioSemPosseDocumentoException,
                                    TramiteJaRecebidoException
Confirma o recebimento de um trâmite externo

Parameters:
tramite - Trâmite externo cujo recebimento será confirmado
sessao - Sessão do usuário logado no sistema
Throws:
AcessoNegadoException
ParametroInvalidoException
TramiteNaoEncontradoException
ErroInternoException
UsuarioSemPosseDocumentoException
TramiteJaRecebidoException

getTramite

Tramite getTramite(java.lang.Integer codigoTramite)
                   throws ParametroInvalidoException,
                          TramiteNaoEncontradoException,
                          ErroInternoException
Retorna o trâmite especificado como parâmetro

Parameters:
codigoTramite - Código do tramite a ser retornado
Returns:
Trâmite encontrado
Throws:
ParametroInvalidoException
TramiteNaoEncontradoException
ErroInternoException

atualizarPrazoTramite

void atualizarPrazoTramite(java.lang.Integer codigoTramite,
                           java.lang.Integer prazo,
                           ProcessoUtil.TipoPrazo tipoPrazo,
                           Sessao sessao)
                           throws ParametroInvalidoException,
                                  ErroInternoException,
                                  UsuarioSemPosseDocumentoException,
                                  TramiteNaoEncontradoException
Atualiza o prazo das ações de um trâmite.

Parameters:
codigoTramite - Código do trâmite cujo prazo será atualizado
prazo - Novo prazo
tipoPrazo - Tipo do novo prazo
sessao - Sessão do usuário logado no sistema
Throws:
ParametroInvalidoException
ErroInternoException
UsuarioSemPosseDocumentoException
TramiteNaoEncontradoException

confirmarEnvioGuia

void confirmarEnvioGuia(Sessao sessao,
                        java.lang.Integer... codigosTramites)
                        throws ParametroInvalidoException,
                               ErroInternoException,
                               UsuarioSemPosseDocumentoException,
                               TramiteNaoEncontradoException
Confirma o envio (impressão) da(s) guia(s).

Parameters:
sessao - Sessão do usuário logado no sistema
codigosTramites - Código dos trâmites cujas guias foram enviadas
Throws:
ParametroInvalidoException
ErroInternoException
UsuarioSemPosseDocumentoException
TramiteNaoEncontradoException