Interface DocumentService

  • All Superinterfaces:
    BaseAPIService

    public interface DocumentService
    extends BaseAPIService
    Fornece acesso aos serviços de documentos (GED).
    Since:
    1.5
    Author:
    vanei
    • Method Detail

      • getActive

        DocumentVO getActive​(Integer documentId)
                      throws com.fluig.sdk.api.common.SDKException
        Retorna o documento ativo passado o ID do mesmo.
        Parameters:
        documentId - ID do documento.
        Returns:
        Dados do documento encontrado.
        Throws:
        com.fluig.sdk.api.common.SDKException
      • getUserPermissions

        Integer getUserPermissions​(Integer documentId,
                                   Integer version,
                                   String user)
                            throws com.fluig.sdk.api.common.SDKException
        Retorna a permissão do usuário em um documento.
        Parameters:
        documentId - ID do documento.
        version - Versão do documento.
        user - Matrícula do usuário.
        Returns:
        Permissão do usuário. Os valores possíveis são: -1 - Sem permissão, 0 - Leitura, 1 - Gravação, 2 - Modificação, 3 - Controle Total
        Throws:
        com.fluig.sdk.api.common.SDKException - Falha buscando permissão.
      • getCurrentUserPermission

        SolvedPermissionVO getCurrentUserPermission​(Integer documentId)
                                             throws com.fluig.sdk.api.common.SDKException
        Throws:
        com.fluig.sdk.api.common.SDKException
      • createPrivateDocument

        DocumentVO createPrivateDocument​(Long companyId,
                                         String userId,
                                         String fileName,
                                         String filePath)
                                  throws com.fluig.sdk.api.common.SDKException
        Cria uma documento privado
        Parameters:
        companyId - ID da empresa
        userId - ID do usuário
        fileName - Nome do arquivo
        filePath - Caminho do arquivo
        Returns:
        DocumentVO
        Throws:
        com.fluig.sdk.api.common.SDKException
      • createPrivateDocument

        DocumentVO createPrivateDocument​(Long companyId,
                                         String userId,
                                         String fileName,
                                         File file)
                                  throws com.fluig.sdk.api.common.SDKException
        Cria uma documento privado
        Parameters:
        companyId - ID da empresa
        userId - ID do usuário
        fileName - Nome do arquivo
        file - Arquivo file
        Returns:
        DocumentVO
        Throws:
        com.fluig.sdk.api.common.SDKException
      • getAllocatedDocument

        AllocatedDocumentVO getAllocatedDocument​(int documentId,
                                                 int version)
                                          throws com.fluig.sdk.api.common.SDKException
        Retorna documento com as informações de checkout
        Parameters:
        documentId - Id do documento
        version - Versão do documento
        Throws:
        com.fluig.sdk.api.common.SDKException
        Since:
        1.5.12
      • getDownloadURL

        String getDownloadURL​(Integer documentId)
                       throws com.fluig.sdk.api.common.SDKException
        Retorna a url do documento
        Parameters:
        documentVO - Objeto do documento
        Throws:
        com.fluig.sdk.api.common.SDKException
        Since:
        1.5.12
      • createDocument

        DocumentVO createDocument​(DocumentVO documentVO)
                           throws com.fluig.sdk.api.common.SDKException
        Cria o documento com permissões e aprovadors
        Parameters:
        documentVO - Objeto do documento
        Throws:
        com.fluig.sdk.api.common.SDKException
        Since:
        1.5.12
      • deleteDocument

        void deleteDocument​(int documentId)
                     throws com.fluig.sdk.api.common.SDKException
        Remove o documento
        Parameters:
        documentId - ID do documento
        Throws:
        com.fluig.sdk.api.common.SDKException
        Since:
        1.5.12
      • copyDocumentToUploadArea

        String[] copyDocumentToUploadArea​(int documentId)
                                   throws com.fluig.sdk.api.common.SDKException
        Copia o documento que esta na área de uplaod
        Parameters:
        documentId - ID do documento
        Returns:
        Array de bytes documento
        Throws:
        com.fluig.sdk.api.common.SDKException
        Since:
        1.5.12
      • setDocumentPermissions

        void setDocumentPermissions​(int documentId,
                                    List<DocumentPermissionVO> permissions)
                             throws com.fluig.sdk.api.common.SDKException
        Determina as permissões do documento
        Parameters:
        documentId - ID do documento
        permissions - Lista de permissões do documento
        Throws:
        com.fluig.sdk.api.common.SDKException
        Since:
        1.5.12
      • getDocumentPermissions

        List<DocumentPermissionVO> getDocumentPermissions​(int documentId,
                                                          int version)
                                                   throws com.fluig.sdk.api.common.SDKException
        Retorna as permissões do documento
        Parameters:
        documentId - ID do documento
        version - Versão do documento
        Returns:
        Listas de permissões do documento
        Throws:
        com.fluig.sdk.api.common.SDKException
        Since:
        1.5.12
      • approveDocument

        void approveDocument​(int documentId,
                             int version,
                             boolean approved,
                             String observation)
                      throws com.fluig.sdk.api.common.SDKException
        Aprova ou reprova um documento.
        Parameters:
        companyId - ID da empresa
        documentId - ID do documento.
        version - Versão do documento.
        approved - passar true para aprovador e false para reprovado.
        observation - Observação do document.
        Throws:
        com.fluig.sdk.api.common.SDKException - Falha na aprovação.
        Since:
        1.5.12
      • getDocumentApprovers

        List<DocumentApproverVO> getDocumentApprovers​(int documentId)
                                               throws com.fluig.sdk.api.common.SDKException
        Retrieve all document approvers and yours status.
        Parameters:
        documentId - ID do documento.
        Throws:
        com.fluig.sdk.api.common.SDKException - Falha na aprovação.
        Since:
        1.5.12
      • getDocumentApprovers

        List<DocumentApproverVO> getDocumentApprovers​(int documentId,
                                                      boolean checkInheritance)
                                               throws com.fluig.sdk.api.common.SDKException
        Retrieve all document approvers and yours status.
        Parameters:
        documentId - ID do documento.
        checkInheritance - Caso true, tenta buscar os aprovadores no pai
        Throws:
        com.fluig.sdk.api.common.SDKException - Falha na aprovação.
        Since:
        1.7.0
      • updateFile

        DocumentVO updateFile​(DocumentVO docVO)
                       throws com.fluig.sdk.api.common.SDKException
        Update file
        Parameters:
        docVO - Documento objeto
        Returns:
        Documento Objeto
        Throws:
        com.fluig.sdk.api.common.SDKException - 1.5.12
      • setDocumentApprovers

        void setDocumentApprovers​(Long companyId,
                                  DocumentSecurityVO documentSecurityVO)
                           throws com.fluig.sdk.api.common.SDKException
        Set Approvers for a specific document
        Parameters:
        Long - companyId
        DocumentSecurityVO - documentSecurityVO
        Throws:
        Exception
        com.fluig.sdk.api.common.SDKException
        Since:
        1.5.11
      • getDocumentApprovalHistory

        List<DocumentApprovementHistoryVO> getDocumentApprovalHistory​(int documentId)
                                                               throws com.fluig.sdk.api.common.SDKException
        Return the approvements history of the document
        Parameters:
        int - documentId
        Throws:
        com.fluig.sdk.api.common.SDKException
        Since:
        1.5.12
      • validateDocumentPublicUrlConfiguration

        void validateDocumentPublicUrlConfiguration​(Long tenantId,
                                                    int documentId,
                                                    int version)
                                             throws Exception
        Valida configurações de documento
        Parameters:
        tenantId -
        documentId -
        version -
        Throws:
        Exception