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

All Known Implementing Classes:
AbstractAssociacaoPecaFacade, AssociacaoPecaDelegate, AssociacaoPecaFacadeSession

public interface AssociacaoPeca

Version:
1.0
Author:
Percilia Marino

Method Summary
 AssociacaoPeca anexarDocumento(java.lang.Integer codigoDocumentoPai, java.lang.Integer codigoDocumentoAnexo, Sessao sessao)
          Anexa um documento a outro processo ou documento
 AssociacaoPeca anexarProcesso(java.lang.Integer codigoDocumentoPai, java.lang.Integer codigoDocumentoAnexo, Sessao sessao)
          Anexa um processo a outro processo
 AssociacaoPeca apensarProcesso(java.lang.Integer codigoDocumentoPai, java.lang.Integer codigoDocumentoApenso, Sessao sessao)
          Apensa um processo a outro processo
 HistoricoAssociacaoPeca desapensarProcesso(java.lang.Integer codigoDocumentoPai, java.lang.Integer codigoDocumentoApenso, Sessao sessao)
          Desapensa um processo de outro processo
 HistoricoAssociacaoPeca desentranharPeca(java.lang.Integer codigoDocumentoPai, java.lang.Integer codigoDocumentoDesentranhar, Sessao sessao)
          Desentranhar uma peça de um Processo.
 java.util.List<HistoricoAssociacaoPeca> desmembrarPecas(java.util.List<java.lang.Integer> codigoDocumentosDesmembrar, java.util.List<DocumentoVinculoPK> codigoVinculosDesmembrar, Sessao sessao)
          Desmembrar peças de um documento
 DocumentoNo getArvoreAssociacoesPorDocumento(java.lang.Integer codigoDocumento)
          Retorna um DocumentoNo para geração da árvore de associações de um documento/processo
 java.util.List<DocumentoNo> getArvoreDesmembramentoPorDocumentos(java.lang.Integer... codigosDocumentos)
          Retorna uma coleção de DocumentoNo para geração da árvore de documentos anexados
 AssociacaoPeca getAssociacaoPeca(java.lang.Integer codigoAssociacao)
          Pesquisar Associações de peça de um documento
 java.util.List<AssociacaoPeca> getAssociacoesPeca(AssociacaoPeca associacaoPeca)
          Pesquisar associações por um exemplo
 java.util.List<AssociacaoPeca> getAssociacoesPeca(java.lang.Integer codigoDocumento)
          Pesquisar Associações de peça de um documento
 java.util.List<HistoricoAssociacaoPeca> getDesassociacoesPorDocumento(java.lang.Integer codigoDocumento)
          Pesquisar todas as retiradas de um documento/processo
 java.util.List<DocumentoVinculo> getDesvinculacoesPorDocumento(java.lang.Integer codigoDocumento)
          Pesquisar todas as desvinculações de um documento/processo
 Documento getDocumentoRaizPorDocumentoAssociado(java.lang.Integer codigoDocumentoAssociacaoPeca)
          Verifica qual o documento raiz de uma peça associada
 Documento getDocumentoRaizPorVinculo(DocumentoVinculo documentoVinculo)
          Verifica qual o documento raiz de um vínculo
 java.util.List<DocumentoVO> getDocumentosPossiveisAssociacoes(java.lang.Integer codigoDocumentoPrincipal, ProcessoUtil.TipoAssociacao tipoAssociacao, Sessao sessao)
          Retorna a lista de todos os documentos possíveis para uma associação
 java.util.List<DocumentoVinculo> getDocumentosVinculos(DocumentoVinculo documentoVinculo)
          Pesquisar vinculos por um exemplo
 java.util.List<DocumentoVinculo> getDocumentosVinculos(java.lang.Integer codigoDocumento)
          Pesquisar vinculos de um documento
 DocumentoVinculo getDocumentoVinculo(DocumentoVinculoPK documentoVinculoPK)
          Retorna o DocumentoVinculo da chave associada
 HistoricoAssociacaoPeca getHistoricoAssociacaoPeca(java.lang.Integer codigoHistoricoPeca)
          Retornar o Histórico de uma AssociacaoPeca
 DocumentoVinculo inserirDocumentoVinculo(DocumentoVinculo documentoVinculo, Sessao sessao)
          Insere um vínculo
 java.lang.Boolean verificarDocumentoAssociado(java.lang.Integer codigoDocumento)
          Verifica se um documento está juntado a outro
 

Method Detail

desentranharPeca

HistoricoAssociacaoPeca desentranharPeca(java.lang.Integer codigoDocumentoPai,
                                         java.lang.Integer codigoDocumentoDesentranhar,
                                         Sessao sessao)
                                         throws ParametroInvalidoException,
                                                ErroInternoException,
                                                DocumentoNaoEncontradoException,
                                                UsuarioSemPosseDocumentoException,
                                                AcessoNegadoException,
                                                DocumentoNaoAnexadoException,
                                                ModuloSistemaSemPosseDocumentoException,
                                                DocumentoAssociadoException
Desentranhar uma peça de um Processo.

Parameters:
codigoDocumentoPai - codigo do documento o qual a peça está associada
codigoDocumentoDesentranhar - codigo do documento que será desentranhado
sessao - sessao do usuario logado no sistema
Returns:
HistoricoAssociacaoPeca classe contendo os dados da desassociação
Throws:
ParametroInvalidoException
ErroInternoException
DocumentoNaoEncontradoException
UsuarioSemPosseDocumentoException
AcessoNegadoException
DocumentoNaoAnexadoException
ModuloSistemaSemPosseDocumentoException
DocumentoAssociadoException

getHistoricoAssociacaoPeca

HistoricoAssociacaoPeca getHistoricoAssociacaoPeca(java.lang.Integer codigoHistoricoPeca)
                                                   throws ParametroInvalidoException,
                                                          ErroInternoException,
                                                          HistoricoPecaNaoEncontradoException
Retornar o Histórico de uma AssociacaoPeca

Parameters:
codigoHistoricoPeca -
Returns:
Throws:
ParametroInvalidoException
ErroInternoException
DocumentoNaoEncontradoException
HistoricoPecaNaoEncontradoException

desmembrarPecas

java.util.List<HistoricoAssociacaoPeca> desmembrarPecas(java.util.List<java.lang.Integer> codigoDocumentosDesmembrar,
                                                        java.util.List<DocumentoVinculoPK> codigoVinculosDesmembrar,
                                                        Sessao sessao)
                                                        throws ParametroInvalidoException,
                                                               ErroInternoException,
                                                               DocumentoNaoEncontradoException,
                                                               UsuarioSemPosseDocumentoException,
                                                               AcessoNegadoException,
                                                               DocumentoNaoAnexadoException,
                                                               AssociacaoPecaJaCadastradaException,
                                                               DocumentoVinculoNaoEncontradoException,
                                                               DocumentoAssociadoException,
                                                               DocumentoSemDataEmissaoException,
                                                               ModuloSistemaSemPosseDocumentoException,
                                                               AssociacaoPecaNaoEncontradaException
Desmembrar peças de um documento

Parameters:
codigoDocumentosDesmembrar - lista de codigos dos documentos desmembrados
codigoVinculosDesmembrar - lista de vínculos a serem desmembrados
sessao - sessao do usuario logado no sistema
Returns:
List lista contendo todos os dados das desassociação
Throws:
ParametroInvalidoException
ErroInternoException
DocumentoNaoEncontradoException
UsuarioSemPosseDocumentoException
AcessoNegadoException
DocumentoNaoAnexadoException
AssociacaoPecaJaCadastradaException
DocumentoVinculoNaoEncontradoException
DocumentoAssociadoException
DocumentoSemDataEmissaoException
ModuloSistemaSemPosseDocumentoException
AssociacaoPecaNaoEncontradaException

apensarProcesso

AssociacaoPeca apensarProcesso(java.lang.Integer codigoDocumentoPai,
                               java.lang.Integer codigoDocumentoApenso,
                               Sessao sessao)
                               throws ParametroInvalidoException,
                                      ErroInternoException,
                                      DocumentoNaoEncontradoException,
                                      DocumentoNaoIndicaProcessoException,
                                      UsuarioSemPosseDocumentoException,
                                      DocumentoAssociacaoMaisAntigoException,
                                      DocumentoAssociadoException,
                                      AcessoNegadoException,
                                      AssociacaoPecaJaCadastradaException,
                                      DocumentoSemDataEmissaoException,
                                      ModuloSistemaSemPosseDocumentoException
Apensa um processo a outro processo

Parameters:
codigoDocumentoPai - codigo do documento o qual a peça será associada
codigoDocumentoApenso - codigo do documento a ser apensado
sessao - sessao do usuario logado no sistema
Returns:
AssociacaoPeca classe contendo os dados da associação
Throws:
ParametroInvalidoException
ErroInternoException
DocumentoNaoEncontradoException
DocumentoNaoIndicaProcessoException
UsuarioSemPosseDocumentoException
DocumentoAssociacaoMaisAntigoException
DocumentoAssociadoException
AcessoNegadoException
AssociacaoPecaJaCadastradaException
DocumentoSemDataEmissaoException
ModuloSistemaSemPosseDocumentoException

anexarProcesso

AssociacaoPeca anexarProcesso(java.lang.Integer codigoDocumentoPai,
                              java.lang.Integer codigoDocumentoAnexo,
                              Sessao sessao)
                              throws ParametroInvalidoException,
                                     ErroInternoException,
                                     DocumentoNaoEncontradoException,
                                     DocumentoAssociadoException,
                                     DocumentoNaoIndicaProcessoException,
                                     UsuarioSemPosseDocumentoException,
                                     DocumentoAssociacaoMaisAntigoException,
                                     AcessoNegadoException,
                                     AssociacaoPecaJaCadastradaException,
                                     DocumentoSemDataEmissaoException,
                                     ModuloSistemaSemPosseDocumentoException
Anexa um processo a outro processo

Parameters:
codigoDocumentoPai - codigo do documento o qual a peça será associada
codigoDocumentoAnexo - codigo do documento a ser anexado
sessao - sessao do usuario logado no sistema
Returns:
AssociacaoPeca classe contendo os dados da associação
Throws:
ParametroInvalidoException
ErroInternoException
DocumentoNaoEncontradoException
DocumentoAssociadoException
DocumentoNaoIndicaProcessoException
UsuarioSemPosseDocumentoException
DocumentoAssociacaoMaisAntigoException
AcessoNegadoException
AssociacaoPecaJaCadastradaException
DocumentoSemDataEmissaoException
ModuloSistemaSemPosseDocumentoException

anexarDocumento

AssociacaoPeca anexarDocumento(java.lang.Integer codigoDocumentoPai,
                               java.lang.Integer codigoDocumentoAnexo,
                               Sessao sessao)
                               throws ParametroInvalidoException,
                                      ErroInternoException,
                                      DocumentoNaoEncontradoException,
                                      DocumentoAssociadoException,
                                      UsuarioSemPosseDocumentoException,
                                      DocumentoAssociacaoMaisAntigoException,
                                      AcessoNegadoException,
                                      AssociacaoPecaJaCadastradaException,
                                      DocumentoSemDataEmissaoException,
                                      ModuloSistemaSemPosseDocumentoException
Anexa um documento a outro processo ou documento

Parameters:
codigoDocumentoPai - codigo do documento o qual a peça será associada
codigoDocumentoAnexo - codigo do documento a ser anexado
sessao - sessao do usuario logado no sistema
Returns:
AssociacaoPeca classe contendo os dados da associação
Throws:
ParametroInvalidoException
ErroInternoException
DocumentoNaoEncontradoException
DocumentoAssociadoException
UsuarioSemPosseDocumentoException
DocumentoAssociacaoMaisAntigoException
AcessoNegadoException
AssociacaoPecaJaCadastradaException
DocumentoSemDataEmissaoException
ModuloSistemaSemPosseDocumentoException

desapensarProcesso

HistoricoAssociacaoPeca desapensarProcesso(java.lang.Integer codigoDocumentoPai,
                                           java.lang.Integer codigoDocumentoApenso,
                                           Sessao sessao)
                                           throws ParametroInvalidoException,
                                                  ErroInternoException,
                                                  DocumentoNaoEncontradoException,
                                                  DocumentoNaoApensadoException,
                                                  UsuarioSemPosseDocumentoException,
                                                  AcessoNegadoException,
                                                  ModuloSistemaSemPosseDocumentoException,
                                                  DocumentoAssociadoException
Desapensa um processo de outro processo

Parameters:
codigoDocumentoPai - codigo do documento o qual a peça está associada
codigoDocumentoApenso - codigo do documento apensado
sessao - sessao do usuario logado no sistema
Returns:
HistoricoAssociacaoPeca classe contendo todos os dados das desassociação
Throws:
ParametroInvalidoException
ErroInternoException
DocumentoNaoEncontradoException
DocumentoNaoApensadoException
UsuarioSemPosseDocumentoException
AcessoNegadoException
ModuloSistemaSemPosseDocumentoException
DocumentoAssociadoException

getAssociacaoPeca

AssociacaoPeca getAssociacaoPeca(java.lang.Integer codigoAssociacao)
                                 throws ParametroInvalidoException,
                                        ErroInternoException,
                                        AssociacaoPecaNaoEncontradaException
Pesquisar Associações de peça de um documento

Parameters:
codigoAssociacao - codigo da associação a ser pesquisada
Returns:
List lista das associações do documento
Throws:
ParametroInvalidoException
ErroInternoException
AssociacaoPecaNaoEncontradaException

getAssociacoesPeca

java.util.List<AssociacaoPeca> getAssociacoesPeca(java.lang.Integer codigoDocumento)
                                                  throws ParametroInvalidoException,
                                                         ErroInternoException
Pesquisar Associações de peça de um documento

Parameters:
codigoDocumento - codigo do documento a ser pesquisada as associacoes
Returns:
List lista das associações do documento
Throws:
ParametroInvalidoException
ErroInternoException

getAssociacoesPeca

java.util.List<AssociacaoPeca> getAssociacoesPeca(AssociacaoPeca associacaoPeca)
                                                  throws ParametroInvalidoException,
                                                         ErroInternoException
Pesquisar associações por um exemplo

Parameters:
associacaoPeca - associacaoPeca de exemplo para pesquisa
Returns:
List lista das associações do documento
Throws:
ParametroInvalidoException
ErroInternoException

verificarDocumentoAssociado

java.lang.Boolean verificarDocumentoAssociado(java.lang.Integer codigoDocumento)
                                              throws ParametroInvalidoException,
                                                     ErroInternoException
Verifica se um documento está juntado a outro

Parameters:
codigoDocumento - codigo do documento a ser verificado
Returns:
retorna true se ele está associado a outro, ou false se ele é o documento ou processo principal
Throws:
ParametroInvalidoException
ErroInternoException

getDocumentosVinculos

java.util.List<DocumentoVinculo> getDocumentosVinculos(java.lang.Integer codigoDocumento)
                                                       throws ParametroInvalidoException,
                                                              ErroInternoException
Pesquisar vinculos de um documento

Parameters:
codigoDocumento - codigo do documento a ser pesquisado os vinculos
Returns:
List
Throws:
ParametroInvalidoException
ErroInternoException

getDesassociacoesPorDocumento

java.util.List<HistoricoAssociacaoPeca> getDesassociacoesPorDocumento(java.lang.Integer codigoDocumento)
                                                                      throws ParametroInvalidoException,
                                                                             ErroInternoException
Pesquisar todas as retiradas de um documento/processo

Parameters:
codigoDocumento - codigo do documento a ser pesquisada as retiradas
Returns:
List lista contendo o histórico de todas as desassociações de um documento
Throws:
ParametroInvalidoException
ErroInternoException

getDesvinculacoesPorDocumento

java.util.List<DocumentoVinculo> getDesvinculacoesPorDocumento(java.lang.Integer codigoDocumento)
                                                               throws ParametroInvalidoException,
                                                                      ErroInternoException
Pesquisar todas as desvinculações de um documento/processo

Parameters:
codigoDocumento - codigo do documento a ser pesquisada as desvinculações
Returns:
List lista com os vínculos de um documento
Throws:
ParametroInvalidoException
ErroInternoException

getDocumentosVinculos

java.util.List<DocumentoVinculo> getDocumentosVinculos(DocumentoVinculo documentoVinculo)
                                                       throws ParametroInvalidoException,
                                                              ErroInternoException
Pesquisar vinculos por um exemplo

Parameters:
documentoVinculo - vinculo informativo de exemplo para pesquisa
Returns:
List lista de vínculos de um documento
Throws:
ParametroInvalidoException
ErroInternoException

inserirDocumentoVinculo

DocumentoVinculo inserirDocumentoVinculo(DocumentoVinculo documentoVinculo,
                                         Sessao sessao)
                                         throws ParametroInvalidoException,
                                                ErroInternoException,
                                                DocumentoVinculoJaCadastradoException,
                                                UsuarioSemPosseDocumentoException,
                                                AcessoNegadoException,
                                                DocumentoNaoEncontradoException,
                                                DocumentoAssociadoException
Insere um vínculo

Parameters:
documentoVinculo - documento vínculo a ser inserido
sessao - sessao do usuario logado no sistema
Returns:
DocumentoVinculo documento vínculo inserido
Throws:
ParametroInvalidoException
ErroInternoException
DocumentoVinculoJaCadastradoException
UsuarioSemPosseDocumentoException
AcessoNegadoException
DocumentoNaoEncontradoException
DocumentoAssociadoException

getDocumentoRaizPorDocumentoAssociado

Documento getDocumentoRaizPorDocumentoAssociado(java.lang.Integer codigoDocumentoAssociacaoPeca)
                                                throws ParametroInvalidoException,
                                                       ErroInternoException,
                                                       DocumentoNaoEncontradoException
Verifica qual o documento raiz de uma peça associada

Parameters:
codigoDocumentoAssociacaoPeca - codigo do documento associado
Returns:
Documento documento raiz de uma peça
Throws:
ParametroInvalidoException
ErroInternoException
DocumentoNaoEncontradoException

getDocumentoRaizPorVinculo

Documento getDocumentoRaizPorVinculo(DocumentoVinculo documentoVinculo)
                                     throws ParametroInvalidoException,
                                            ErroInternoException,
                                            DocumentoNaoEncontradoException
Verifica qual o documento raiz de um vínculo

Parameters:
documentoVinculo - codigo do vinculo associado
Returns:
Documento documento raiz de um vínculo
Throws:
ParametroInvalidoException
ErroInternoException
DocumentoNaoEncontradoException

getArvoreAssociacoesPorDocumento

DocumentoNo getArvoreAssociacoesPorDocumento(java.lang.Integer codigoDocumento)
                                             throws ErroInternoException,
                                                    DocumentoNaoEncontradoException,
                                                    ParametroInvalidoException
Retorna um DocumentoNo para geração da árvore de associações de um documento/processo

Parameters:
codigoDocumento - codigo do documento a ser gerada a árvore
Returns:
DocumentoNo documento para montar a árvore com todas as associações de um documento
Throws:
ErroInternoException
DocumentoNaoEncontradoException
ParametroInvalidoException

getArvoreDesmembramentoPorDocumentos

java.util.List<DocumentoNo> getArvoreDesmembramentoPorDocumentos(java.lang.Integer... codigosDocumentos)
                                                                 throws ErroInternoException,
                                                                        DocumentoNaoEncontradoException,
                                                                        DocumentoNaoIndicaProcessoException,
                                                                        ParametroInvalidoException
Retorna uma coleção de DocumentoNo para geração da árvore de documentos anexados

Parameters:
codigosDocumentos - codigoDocumento codigos dos documentos a serem gerados a árvore
Returns:
List documento para montar a árvore com todas as associações de um documento, inclusive vínculos.
Throws:
ErroInternoException
DocumentoNaoEncontradoException
DocumentoNaoIndicaProcessoException
ParametroInvalidoException

getDocumentosPossiveisAssociacoes

java.util.List<DocumentoVO> getDocumentosPossiveisAssociacoes(java.lang.Integer codigoDocumentoPrincipal,
                                                              ProcessoUtil.TipoAssociacao tipoAssociacao,
                                                              Sessao sessao)
                                                              throws ErroInternoException,
                                                                     ParametroInvalidoException
Retorna a lista de todos os documentos possíveis para uma associação

Parameters:
codigoDocumentoPrincipal - processo/documento principal
tipoAssociacao - tipo de associação
sessao - sessao do usuario logado no sistema
Returns:
List lista com todos os documentos que podem ser associados a um documento ou processo.
Throws:
ErroInternoException
ParametroInvalidoException

getDocumentoVinculo

DocumentoVinculo getDocumentoVinculo(DocumentoVinculoPK documentoVinculoPK)
                                     throws ParametroInvalidoException,
                                            ErroInternoException
Retorna o DocumentoVinculo da chave associada

Parameters:
documentoVinculoPK -
Returns:
Throws:
ParametroInvalidoException
ErroInternoException