Interface WorkflowAPIService

  • All Superinterfaces:
    BaseAPIService

    public interface WorkflowAPIService
    extends BaseAPIService
    Fornece acesso aos serviços de workflow.
    Since:
    1.5
    Author:
    vanei
    • Method Detail

      • getProcessVersion

        Integer getProcessVersion​(String processId)
                           throws com.fluig.sdk.api.common.SDKException
        Retorna a versão de um processo.
        Parameters:
        processId - ID do processo.
        Returns:
        Versão do processo.
        Throws:
        com.fluig.sdk.api.common.SDKException
        Since:
        1.5
      • getAvailableProcess

        List<ProcessVersionVO> getAvailableProcess​(long tenantId,
                                                   String userId)
                                            throws Exception
        Retorna uma lista de processos disponíveis para o usuário
        Parameters:
        tenantId - - ID do tenant
        userId - - ID do usuário
        Returns:
        lista de processos disponíveis para o usuário.
        Throws:
        Exception
        Since:
        1.5.6
      • getActiveTasks

        ProcessInstanceInfoVO getActiveTasks​(Integer processInstanceId)
                                      throws Exception
        Retorna uma lista das atividades pendentes de um processo
        Parameters:
        processInstanceId - - Numero da solicitação
        Returns:
        lista das atividades pendentes de um processo.
        Throws:
        Exception
        Since:
        1.5.11
      • createProcessObservation

        ProcessObservationVO createProcessObservation​(ProcessObservationVO processObservationVO)
                                               throws com.fluig.sdk.api.common.SDKException
        Insere um complemento em uma solicitação
        Parameters:
        processObservationVO - - Objeto com as informações do complemento
        Returns:
        processObservationVO - Objeto com as informações do complemento incluindo Id criado.
        Throws:
        com.fluig.sdk.api.common.SDKException
        Since:
        1.5.8
      • findObservations

        List<ProcessObservationVO> findObservations​(Integer processInstanceId,
                                                    Integer stateSequence,
                                                    Integer threadSequence)
        Retorna a lista de complementos em uma solicitação
        Parameters:
        processInstanceId - - Numero da solicitação
        stateSequence - - Código da atividade
        threadSequence - - Numero da thread
        Returns:
        processObservationVO - Lista com os complementos da solicitação.
        Since:
        1.5.8
      • assumeProcessTask

        ProcessTaskVO assumeProcessTask​(long companyId,
                                        String userId,
                                        int processInstanceId,
                                        int movementSequence,
                                        String replacementId)
                                 throws com.fluig.sdk.api.common.SDKException
        Faz com que o usuário repassado assuma a tarefa.
        Parameters:
        companyId - - Código da empresa.
        userId - - Matrícula do usuário que assumirá a tarefa.
        processInstanceId - - Código da Solicitação a ser assumida.
        movementSequence - - Código do movimento da tarefa que será assumida.
        replacementId - - Código do usuário logado que está assumindo para seu substituído (se houver).
        Throws:
        com.fluig.sdk.api.common.SDKException
        Since:
        1.5.11
      • resumeRequestsSLA

        ResumeRequestsSLAVO resumeRequestsSLA​(List<String> processes,
                                              Map<String,​String> cardFilters,
                                              List<String> countersRequiredList)
                                       throws Exception
        Recupera um resumo dos indicadores de SLA dos processos configurados.
        Parameters:
        processes - Lista de processos a considerar na pesquisa.
        cardFilters - Lista de filtros por campo de formulário para os processos específicos.
        countersRequiredList - Lista dos tipos de contadores a serem considerados, os demais virão nulos. Possíveis valores são: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests.
        Returns:
        ResumeRequestsSLAVO Objeto com os totalizadores em seu conteúdo.
        Throws:
        Exception
        Since:
        1.6.1
      • resumeRequestsSLA

        ResumeRequestsSLAVO resumeRequestsSLA​(List<String> processes,
                                              Map<String,​String> cardFilters,
                                              List<String> countersRequiredList,
                                              Date initialStartDate,
                                              Date finalStartDate,
                                              Date initialDeadlineDate,
                                              Date finalDeadlineDate,
                                              Date initialWarningDate,
                                              Date finalWarningDate,
                                              String requester,
                                              String assignee,
                                              String manager,
                                              List<String> requesterLocalsList,
                                              List<String> assigneeLocalsList)
                                       throws Exception
        Recupera um resumo dos indicadores de SLA dos processos configurados.
        Parameters:
        processes - Lista de processos a considerar na pesquisa.
        cardFilters - Lista de filtros por campo de formulário para os processos específicos.
        countersRequiredList - Lista dos tipos de contadores a serem considerados, os demais virão nulos. Possíveis valores são: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests.
        initialStartDate - Data inicial de início da solicitação considerada para o alcance da pesquisa.
        finalStartDate - Data final de início da solicitação considerada para o alcance da pesquisa.
        initialDeadlineDate - Data inicial de expiração da solicitação considerada para o alcance da pesquisa.
        finalDeadlineDate - Data final de expiração da solicitação considerada para o alcance da pesquisa.
        initialWarningDate - Data inicial de aviso da solicitação considerada para o alcance da pesquisa.
        finalWarningDate - Data final de aviso da solicitação considerada para o alcance da pesquisa.
        requester - Requisitante da solicitação.
        assignee - Responsável da solicitação.
        manager - Gestor da solicitação.
        requesterLocalsList - Local em que a solicitação foi iniciada, separados por vírgula.
        assigneeLocalsList - Local do responsável pela atividade, separados por vírgula.
        Returns:
        ResumeRequestsSLAVO Objeto com os totalizadores em seu conteúdo.
        Throws:
        Exception
        Since:
        1.6.1
      • resumeRequestsSLA

        ResumeRequestsSLAVO resumeRequestsSLA()
                                       throws Exception
        Recupera um resumo dos indicadores de SLA dos processos configurados.
        Returns:
        ResumeRequestsSLAVO Objeto com os totalizadores em seu conteúdo.
        Throws:
        Exception
        Since:
        1.6.1
      • resumeRequestsSLA

        ResumeRequestsSLAVO resumeRequestsSLA​(List<String> processes)
                                       throws Exception
        Recupera um resumo dos indicadores de SLA dos processos configurados.
        Parameters:
        processes - Lista de processos a considerar na pesquisa.
        Returns:
        ResumeRequestsSLAVO Objeto com os totalizadores em seu conteúdo.
        Throws:
        Exception
        Since:
        1.6.1
      • resumeRequestsSLA

        ResumeRequestsSLAVO resumeRequestsSLA​(List<String> processes,
                                              Map<String,​String> cardFilters)
                                       throws Exception
        Recupera um resumo dos indicadores de SLA dos processos configurados.
        Parameters:
        processes - Lista de processos a considerar na pesquisa.
        cardFilters - Lista de filtros por campo de formulário para os processos específicos.
        Returns:
        ResumeRequestsSLAVO Objeto com os totalizadores em seu conteúdo.
        Throws:
        Exception
        Since:
        1.6.1
      • resumeRequestsSLA

        ResumeRequestsSLAVO resumeRequestsSLA​(String processes,
                                              String cardFilters,
                                              String countersRequired,
                                              String initialStartDate,
                                              String finalStartDate,
                                              String initialDeadlineDate,
                                              String finalDeadlineDate,
                                              String initialWarningDate,
                                              String finalWarningDate,
                                              String requester,
                                              String assignee,
                                              String manager,
                                              String requesterLocals,
                                              String assigneeLocals)
                                       throws Exception
        Recupera um resumo dos indicadores de SLA dos processos configurados.
        Parameters:
        processes - Lista de processos a considerar na pesquisa. Separados por vírgula.
        cardFilters - Lista de filtros por campo de formulário para os processos específicos. Separados por vírgula, considerando o padrão chave:valor.
        countersRequired - Lista dos tipos de contadores a serem considerados, os demais virão nulos. Possíveis valores são: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests. Separados por vírgula.
        initialStartDate - Data inicial de início da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalStartDate - Data final de início da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        initialDeadlineDate - Data inicial de expiração da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalDeadlineDate - Data final de expiração da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        initialWarningDate - Data inicial de aviso da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalWarningDate - Data final de aviso da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        requester - Requisitante da solicitação.
        assignee - Responsável de uma das tarefas correntes da solicitação.
        manager - Gestor da solicitação.
        requesterLocals - Local em que a solicitação foi iniciada, separados por vírgula.
        Returns:
        ResumeRequestsSLAVO Objeto com os totalizadores em seu conteúdo.
        Throws:
        Exception
        Since:
        1.6.1
      • findRequestsSLA

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<RequestSLAVO> findRequestsSLA​(String processes,
                                                                                                               String cardFilters,
                                                                                                               String statusRequired,
                                                                                                               String initialStartDate,
                                                                                                               String finalStartDate,
                                                                                                               String initialDeadlineDate,
                                                                                                               String finalDeadlineDate,
                                                                                                               String initialWarningDate,
                                                                                                               String finalWarningDate,
                                                                                                               String expand,
                                                                                                               String requester,
                                                                                                               String assignee,
                                                                                                               String manager,
                                                                                                               String requesterLocals,
                                                                                                               String assigneeLocals,
                                                                                                               String order,
                                                                                                               String calculate,
                                                                                                               String page,
                                                                                                               String pageSize)
                                                                                                        throws Exception
        Recupera um resumo dos indicadores de SLA dos processos configurados.
        Parameters:
        processes - Lista de processos a considerar na pesquisa. Separados por vírgula.
        cardFilters - Lista de filtros por campo de formulário para os processos específicos. Separados por vírgula, considerando o padrão chave:valor.
        statusRequired - Lista dos tipos de status a serem considerados, os demais virão nulos. Possíveis valores são: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests. Separados por vírgula.
        initialStartDate - Data inicial de início da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalStartDate - Data final de início da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        initialDeadlineDate - Data inicial de expiração da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalDeadlineDate - Data final de expiração da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        initialWarningDate - Data inicial de aviso da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalWarningDate - Data final de aviso da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        requester - Requisitante da solicitação.
        assignee - Responsável de uma das tarefas correntes da solicitação.
        manager - Gestor da solicitação.
        requesterLocals - Local em que a solicitação foi iniciada, separados por vírgula.
        expand - Campos expansíveis, possíveis valores: actualTasks, cardFields
        order - Campos de ordenação, separados por vírgula, possíveis valores: processInstanceId, deadlineDate, processId, requesterCode, requesterName, startDate e endDate. Para ordenação decrescente, colocar menos (-) antes do campo.
        calculate - Se calcula as variáveis de tempo e percentual.
        page - Página da consulta.
        pageSize - Tamanho de cada página.
        Returns:
        Um LinkedHashSet de RequestSLAVO Objeto com os totalizadores em seu conteúdo.
        Throws:
        Exception
        Since:
        1.6.1
      • findRequestsSLA

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<RequestSLAVO> findRequestsSLA​(List<String> processes,
                                                                                                               Map<String,​String> cardFilters,
                                                                                                               List<String> statusRequiredList,
                                                                                                               Date initialStartDate,
                                                                                                               Date finalStartDate,
                                                                                                               Date initialDeadlineDate,
                                                                                                               Date finalDeadlineDate,
                                                                                                               Date initialWarningDate,
                                                                                                               Date finalWarningDate,
                                                                                                               boolean returnCurrentTasks,
                                                                                                               String requester,
                                                                                                               String assignee,
                                                                                                               String manager,
                                                                                                               List<String> requesterLocals,
                                                                                                               List<String> assigneeLocals,
                                                                                                               List<com.totvs.technology.foundation.sdk.service.vo.common.OrderParam> orderParams,
                                                                                                               boolean calculate,
                                                                                                               int page,
                                                                                                               int pageSize,
                                                                                                               boolean populateCardFields,
                                                                                                               boolean populateLocalsValue,
                                                                                                               boolean populateAssigneeLocalsValue)
                                                                                                        throws Exception
        Recupera uma lista das solicitações de SLA dos processos configurados.
        Parameters:
        processes - Lista de processos a considerar na pesquisa. Separados por vírgula.
        cardFilters - Lista de filtros por campo de formulário para os processos específicos. Separados por vírgula, considerando o padrão chave:valor.
        statusRequiredList - Lista dos tipos de status a serem considerados, os demais virão nulos. Possíveis valores são: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests. Separados por vírgula.
        initialStartDate - Data inicial de início da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalStartDate - Data final de início da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        initialDeadlineDate - Data inicial de expiração da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalDeadlineDate - Data final de expiração da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        initialWarningDate - Data inicial de aviso da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalWarningDate - Data final de aviso da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        requester - Requisitante da solicitação.
        assignee - Responsável de uma das tarefas correntes da solicitação.
        manager - Gestor da solicitação.
        locals - Local em que a solicitação foi iniciada, separados por vírgula.
        returnCurrentTasks - Se a lista "actualTasks" será retornada no objeto de retorno.
        orderParams - Lista de OrderParam para campos de ordenação, possíveis valores no campo field: processInstanceId, deadlineDate, processId, requesterCode, requesterName, startDate e endDate. Para ordenação decrescente, colocar menos (-) antes do campo.
        calculate - Se trará as variáveis calculadas de tempo e percentual.
        page - Página da consulta.
        pageSize - Tamanho de cada página.
        Returns:
        Um ResponseEnvelopeVO, contendo uma lista de items, o total da pesquisa sem paginação e se há próxima página.
        Throws:
        Exception
        Since:
        1.6.1
      • findRequestsSLA

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<RequestSLAVO> findRequestsSLA()
                                                                                                        throws Exception
        Recupera uma lista das solicitações de SLA dos processos configurados.
        Returns:
        Um ResponseEnvelopeVO, contendo uma lista de items, o total da pesquisa sem paginação e se há próxima página.
        Throws:
        Exception
        Since:
        1.6.1
      • findRequestsSLA

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<RequestSLAVO> findRequestsSLA​(List<String> processes)
                                                                                                        throws Exception
        Recupera uma lista das solicitações de SLA dos processos configurados.
        Parameters:
        processes - Lista de processos a considerar na pesquisa. Separados por vírgula.
        Returns:
        Um ResponseEnvelopeVO, contendo uma lista de items, o total da pesquisa sem paginação e se há próxima página.
        Throws:
        Exception
        Since:
        1.6.1
      • findRequestsSLA

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<RequestSLAVO> findRequestsSLA​(List<String> processes,
                                                                                                               List<String> statusRequiredList)
                                                                                                        throws Exception
        Recupera uma lista das solicitações de SLA dos processos configurados.
        Parameters:
        processes - Lista de processos a considerar na pesquisa. Separados por vírgula.
        statusRequiredList - Lista dos tipos de status a serem considerados, os demais virão nulos. Possíveis valores são: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests. Separados por vírgula.
        Returns:
        Um ResponseEnvelopeVO, contendo uma lista de items, o total da pesquisa sem paginação e se há próxima página.
        Throws:
        Exception
        Since:
        1.6.1
      • findRequestsSLA

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<RequestSLAVO> findRequestsSLA​(List<String> processes,
                                                                                                               List<String> statusRequiredList,
                                                                                                               boolean returnCurrentTasks)
                                                                                                        throws Exception
        Recupera uma lista das solicitações de SLA dos processos configurados.
        Parameters:
        processes - Lista de processos a considerar na pesquisa. Separados por vírgula.
        statusRequiredList - Lista dos tipos de status a serem considerados, os demais virão nulos. Possíveis valores são: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests. Separados por vírgula.
        returnCurrentTasks - Se a lista "actualTasks" será retornada no objeto de retorno.
        Returns:
        Um ResponseEnvelopeVO, contendo uma lista de items, o total da pesquisa sem paginação e se há próxima página.
        Throws:
        Exception
        Since:
        1.6.1
      • findRequestsSLA

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<RequestSLAVO> findRequestsSLA​(List<String> processes,
                                                                                                               Map<String,​String> cardFilters,
                                                                                                               List<String> statusRequiredList,
                                                                                                               boolean returnCurrentTasks)
                                                                                                        throws Exception
        Recupera uma lista das solicitações de SLA dos processos configurados.
        Parameters:
        processes - Lista de processos a considerar na pesquisa. Separados por vírgula.
        cardFilters - Lista de filtros por campo de formulário para os processos específicos. Separados por vírgula, considerando o padrão chave:valor.
        statusRequiredList - Lista dos tipos de status a serem considerados, os demais virão nulos. Possíveis valores são: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests. Separados por vírgula.
        returnCurrentTasks - Se a lista "actualTasks" será retornada no objeto de retorno.
        Returns:
        Um ResponseEnvelopeVO, contendo uma lista de items, o total da pesquisa sem paginação e se há próxima página.
        Throws:
        Exception
        Since:
        1.6.1
      • findMyRequestsSLA

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<RequestSLAVO> findMyRequestsSLA​(String processes,
                                                                                                                 String cardFilters,
                                                                                                                 String statusRequired,
                                                                                                                 String initialStartDate,
                                                                                                                 String finalStartDate,
                                                                                                                 String initialDeadlineDate,
                                                                                                                 String finalDeadlineDate,
                                                                                                                 String initialWarningDate,
                                                                                                                 String finalWarningDate,
                                                                                                                 String expand,
                                                                                                                 String assignee,
                                                                                                                 String manager,
                                                                                                                 String order,
                                                                                                                 String calculate,
                                                                                                                 String page,
                                                                                                                 String pageSize)
                                                                                                          throws Exception
        Recupera um resumo dos indicadores de SLA dos processos configurados considerando o usuário logado como requisitante.
        Parameters:
        processes - Lista de processos a considerar na pesquisa. Separados por vírgula.
        cardFilters - Lista de filtros por campo de formulário para os processos específicos. Separados por vírgula, considerando o padrão chave:valor.
        statusRequired - Lista dos tipos de status a serem considerados, os demais virão nulos. Possíveis valores são: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests. Separados por vírgula.
        initialStartDate - Data inicial de início da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalStartDate - Data final de início da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        initialDeadlineDate - Data inicial de expiração da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalDeadlineDate - Data final de expiração da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        initialWarningDate - Data inicial de aviso da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalWarningDate - Data final de aviso da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        assignee - Responsável de uma das tarefas correntes da solicitação.
        expand - Campos expansíveis, possíveis valores: actualTasks, cardFields
        calculate - Se calcula as variáveis de tempo e percentual.
        order - Campos de ordenação, separados por vírgula, possíveis valores: processInstanceId, deadlineDate, processId, requesterCode, requesterName, startDate e endDate. Para ordenação decrescente, colocar menos (-) antes do campo.
        page - Página da consulta.
        pageSize - Tamanho de cada página.
        manager - Gestor da solicitação.
        Returns:
        Um ResponseEnvelopeVO, contendo uma lista de items, o total da pesquisa sem paginação e se há próxima página.
        Throws:
        Exception
        Since:
        1.6.1
      • findRequestsSLAAssignedToMe

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<RequestSLAVO> findRequestsSLAAssignedToMe​(String processes,
                                                                                                                           String cardFilters,
                                                                                                                           String statusRequired,
                                                                                                                           String initialStartDate,
                                                                                                                           String finalStartDate,
                                                                                                                           String initialDeadlineDate,
                                                                                                                           String finalDeadlineDate,
                                                                                                                           String initialWarningDate,
                                                                                                                           String finalWarningDate,
                                                                                                                           String expand,
                                                                                                                           String requester,
                                                                                                                           String manager,
                                                                                                                           String requesterLocals,
                                                                                                                           String assigneeLocals,
                                                                                                                           String order,
                                                                                                                           String calculate,
                                                                                                                           String page,
                                                                                                                           String pageSize)
                                                                                                                    throws Exception
        Recupera um resumo dos indicadores de SLA dos processos configurados considerando o usuário logado como responsável.
        Parameters:
        processes - Lista de processos a considerar na pesquisa. Separados por vírgula.
        cardFilters - Lista de filtros por campo de formulário para os processos específicos. Separados por vírgula, considerando o padrão chave:valor.
        statusRequired - Lista dos tipos de status a serem considerados, os demais virão nulos. Possíveis valores são: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests. Separados por vírgula.
        initialStartDate - Data inicial de início da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalStartDate - Data final de início da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        initialDeadlineDate - Data inicial de expiração da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalDeadlineDate - Data final de expiração da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        initialWarningDate - Data inicial de aviso da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalWarningDate - Data final de aviso da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        expand - Campos expansíveis, possíveis valores: actualTasks, cardFields
        calculate - Se calcula as variáveis de tempo e percentual.
        order - Campos de ordenação, separados por vírgula, possíveis valores: processInstanceId, deadlineDate, processId, requesterCode, requesterName, startDate e endDate. Para ordenação decrescente, colocar menos (-) antes do campo.
        page - Página da consulta.
        pageSize - Tamanho de cada página.
        requester - Requisitante da solicitação.
        manager - Gestor da solicitação.
        requesterLocals - Local em que a solicitação foi iniciada, separados por vírgula.
        Returns:
        Um ResponseEnvelopeVO, contendo uma lista de items, o total da pesquisa sem paginação e se há próxima página.
        Throws:
        Exception
        Since:
        1.6.1
      • resumeMyRequestsSLA

        ResumeRequestsSLAVO resumeMyRequestsSLA​(String processes,
                                                String cardFilters,
                                                String countersRequired,
                                                String initialStartDate,
                                                String finalStartDate,
                                                String initialDeadlineDate,
                                                String finalDeadlineDate,
                                                String initialWarningDate,
                                                String finalWarningDate,
                                                String assignee,
                                                String manager)
                                         throws Exception
        Recupera um resumo dos indicadores de SLA dos processos configurados considerando o usuário logado como requisitante.
        Parameters:
        processes - Lista de processos a considerar na pesquisa. Separados por vírgula.
        cardFilters - Lista de filtros por campo de formulário para os processos específicos. Separados por vírgula, considerando o padrão chave:valor.
        countersRequired - Lista dos tipos de contadores a serem considerados, os demais virão nulos. Possíveis valores são: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests. Separados por vírgula.
        initialStartDate - Data inicial de início da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalStartDate - Data final de início da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        initialDeadlineDate - Data inicial de expiração da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalDeadlineDate - Data final de expiração da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        initialWarningDate - Data inicial de aviso da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalWarningDate - Data final de aviso da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        assignee - Responsável de uma das tarefas correntes da solicitação.
        manager - Gestor da solicitação.
        Returns:
        ResumeRequestsSLAVO Objeto com os totalizadores em seu conteúdo.
        Throws:
        Exception
        Since:
        1.6.1
      • resumeRequestsSLAAssignedToMe

        ResumeRequestsSLAVO resumeRequestsSLAAssignedToMe​(String processes,
                                                          String cardFilters,
                                                          String countersRequired,
                                                          String initialStartDate,
                                                          String finalStartDate,
                                                          String initialDeadlineDate,
                                                          String finalDeadlineDate,
                                                          String initialWarningDate,
                                                          String finalWarningDate,
                                                          String requester,
                                                          String manager,
                                                          String requesterLocals,
                                                          String assigneeLocals)
                                                   throws Exception
        Recupera um resumo dos indicadores de SLA dos processos configurados considerando o usuário logado como responsável.
        Parameters:
        processes - Lista de processos a considerar na pesquisa. Separados por vírgula.
        cardFilters - Lista de filtros por campo de formulário para os processos específicos. Separados por vírgula, considerando o padrão chave:valor.
        countersRequired - Lista dos tipos de contadores a serem considerados, os demais virão nulos. Possíveis valores são: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests. Separados por vírgula.
        initialStartDate - Data inicial de início da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalStartDate - Data final de início da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        initialDeadlineDate - Data inicial de expiração da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalDeadlineDate - Data final de expiração da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        initialWarningDate - Data inicial de aviso da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalWarningDate - Data final de aviso da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        requester - Requisitante da solicitação.
        manager - Gestor da solicitação.
        requesterLocals - Local em que a solicitação foi iniciada, separados por vírgula.
        Returns:
        ResumeRequestsSLAVO Objeto com os totalizadores em seu conteúdo.
        Throws:
        Exception
        Since:
        1.6.1
      • findRequestSLAByProcessInstanceId

        RequestSLAVO findRequestSLAByProcessInstanceId​(int processInstanceId,
                                                       boolean populateCurrentTasks,
                                                       boolean calculate,
                                                       boolean populateCardFields,
                                                       boolean populateLocals,
                                                       boolean assigneeLocals)
                                                throws Exception
        Recupera um resumo dos indicadores de SLA dos processos configurados considerando o usuário logado como responsável.
        Parameters:
        processInstanceId - Código da solicitação.
        populateCurrentTasks - Se retorna as tarefas da solicitação.
        populateCardFields - Se retorna os campos de formulário.
        populateLocals - Se retorna o local do usuário solicitante.
        assigneeLocals - Se retorna o local do usuário responsável.
        calculate - Se calcula as variáveis de tempo e percentual.
        Returns:
        RequestSLAVO
        Throws:
        Exception
        Since:
        1.6.1
      • findRequestSLAByProcessInstanceId

        RequestSLAVO findRequestSLAByProcessInstanceId​(String processInstanceId,
                                                       String expand,
                                                       String calculate)
                                                throws Exception
        Recupera um resumo dos indicadores de SLA dos processos configurados considerando o usuário logado como responsável.
        Parameters:
        processInstanceId - Código da solicitação.
        expand - Campos expansíveis
        calculate - Se calcula as variáveis de tempo e percentual.
        Returns:
        RequestSLAVO
        Throws:
        Exception
        Since:
        1.6.1
      • findRequestsSLAManagedByMe

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<RequestSLAVO> findRequestsSLAManagedByMe​(String processes,
                                                                                                                          String cardFilters,
                                                                                                                          String statusRequired,
                                                                                                                          String initialStartDate,
                                                                                                                          String finalStartDate,
                                                                                                                          String initialDeadlineDate,
                                                                                                                          String finalDeadlineDate,
                                                                                                                          String initialWarningDate,
                                                                                                                          String finalWarningDate,
                                                                                                                          String expand,
                                                                                                                          String requester,
                                                                                                                          String assignee,
                                                                                                                          String requesterLocals,
                                                                                                                          String assigneeLocals,
                                                                                                                          String order,
                                                                                                                          String calculate,
                                                                                                                          String page,
                                                                                                                          String pageSize)
                                                                                                                   throws Exception
        Recupera um resumo dos indicadores de SLA dos processos configurados considerando o usuário logado como gestor.
        Parameters:
        processes - Lista de processos a considerar na pesquisa. Separados por vírgula.
        cardFilters - Lista de filtros por campo de formulário para os processos específicos. Separados por vírgula, considerando o padrão chave:valor.
        statusRequired - Lista dos tipos de status a serem considerados, os demais virão nulos. Possíveis valores são: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests. Separados por vírgula.
        initialStartDate - Data inicial de início da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalStartDate - Data final de início da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        initialDeadlineDate - Data inicial de expiração da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalDeadlineDate - Data final de expiração da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        initialWarningDate - Data inicial de aviso da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalWarningDate - Data final de aviso da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        expand - Campos expansíveis, possíveis valores: actualTasks, cardFields
        calculate - Se calcula as variáveis de tempo e percentual.
        order - Campos de ordenação, separados por vírgula, possíveis valores: processInstanceId, deadlineDate, processId, requesterCode, requesterName, startDate e endDate. Para ordenação decrescente, colocar menos (-) antes do campo.
        page - Página da consulta.
        pageSize - Tamanho de cada página.
        requester - Requisitante da solicitação.
        assignee - Responsável da solicitação.
        requesterLocals - Local em que a solicitação foi iniciada, separados por vírgula.
        Returns:
        Um ResponseEnvelopeVO, contendo uma lista de items, o total da pesquisa sem paginação e se há próxima página.
        Throws:
        Exception
        Since:
        1.6.1
      • resumeRequestsSLAManagedByMe

        ResumeRequestsSLAVO resumeRequestsSLAManagedByMe​(String processes,
                                                         String cardFilters,
                                                         String countersRequired,
                                                         String initialStartDate,
                                                         String finalStartDate,
                                                         String initialDeadlineDate,
                                                         String finalDeadlineDate,
                                                         String initialWarningDate,
                                                         String finalWarningDate,
                                                         String requester,
                                                         String assignee,
                                                         String requesterLocals,
                                                         String assigneeLocals)
                                                  throws Exception
        Recupera um resumo dos indicadores de SLA dos processos configurados considerando o usuário logado como gestor.
        Parameters:
        processes - Lista de processos a considerar na pesquisa. Separados por vírgula.
        cardFilters - Lista de filtros por campo de formulário para os processos específicos. Separados por vírgula, considerando o padrão chave:valor.
        countersRequired - Lista dos tipos de contadores a serem considerados, os demais virão nulos. Possíveis valores são: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests. Separados por vírgula.
        initialStartDate - Data inicial de início da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalStartDate - Data final de início da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        initialDeadlineDate - Data inicial de expiração da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalDeadlineDate - Data final de expiração da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        initialWarningDate - Data inicial de aviso da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        finalWarningDate - Data final de aviso da solicitação considerada para o alcance da pesquisa. Padrão yyyy-MM-dd.
        requester - Requisitante da solicitação.
        assignee - Responsável da solicitação.
        requesterLocals - Local em que a solicitação foi iniciada, separados por vírgula.
        Returns:
        ResumeRequestsSLAVO Objeto com os totalizadores em seu conteúdo.
        Throws:
        Exception
        Since:
        1.6.1
      • resumeMyRequestsTasks

        ResumeProcessTaskVO resumeMyRequestsTasks​(String processId,
                                                  String startDate,
                                                  String endDate,
                                                  String assignee,
                                                  String manager)
                                           throws Exception
        Parameters:
        processId -
        startDate -
        endDate -
        assignee -
        manager -
        Returns:
        ResumeProcessTaskVO objeto com o total de tarefas com base no processo
        Throws:
        Exception
      • resumeAssignedToMeTasks

        ResumeProcessTaskVO resumeAssignedToMeTasks​(String processId,
                                                    String startDate,
                                                    String endDate,
                                                    String requester,
                                                    String manager)
                                             throws Exception
        Parameters:
        processId -
        startDate -
        endDate -
        requester -
        manager -
        Returns:
        ResumeProcessTaskVO objeto com o total de tarefas com base no processo
        Throws:
        Exception
      • resumeManagedByMeTasks

        ResumeProcessTaskVO resumeManagedByMeTasks​(String processId,
                                                   String startDate,
                                                   String endDate,
                                                   String requester,
                                                   String assignee)
                                            throws Exception
        Parameters:
        processId -
        startDate -
        endDate -
        requester -
        assignee -
        Returns:
        ResumeProcessTaskVO objeto com o total de tarefas com base no processo
        Throws:
        Exception
      • findMyRequestsTasks

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<RequestProcessTaskVO> findMyRequestsTasks​(String processId,
                                                                                                                           String initialStartDate,
                                                                                                                           String finalStartDate,
                                                                                                                           String assignee,
                                                                                                                           String manager,
                                                                                                                           String page,
                                                                                                                           String pageSize,
                                                                                                                           String statusTypeTaskRequest,
                                                                                                                           String calculate,
                                                                                                                           String expand,
                                                                                                                           String cardFilters)
                                                                                                                    throws Exception
        Parameters:
        processId -
        initialStartDate -
        finalStartDate -
        assignee -
        manager -
        page -
        pageSize -
        statusTypeTaskRequest - 1 onTime; 2 warning, 3 Expired
        Returns:
        ResponseEnvelopeVO objeto com os dados do processo com base na tarefa
        Throws:
        Exception
      • findAssignedToMeTasks

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<RequestProcessTaskVO> findAssignedToMeTasks​(String processId,
                                                                                                                             String initialStartDate,
                                                                                                                             String finalStartDate,
                                                                                                                             String requester,
                                                                                                                             String manager,
                                                                                                                             String page,
                                                                                                                             String pageSize,
                                                                                                                             String statusTypeTaskRequest,
                                                                                                                             String calculate,
                                                                                                                             String expand,
                                                                                                                             String cardFilters)
                                                                                                                      throws Exception
        Parameters:
        processId -
        initialStartDate -
        finalStartDate -
        requester -
        manager -
        page -
        pageSize -
        statusTypeTaskRequest - 1 onTime; 2 warning, 3 Expired
        Returns:
        ResponseEnvelopeVO objeto com os dados do processo com base na tarefa
        Throws:
        Exception
      • findManagedByMeTasks

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<RequestProcessTaskVO> findManagedByMeTasks​(String processId,
                                                                                                                            String initialStartDate,
                                                                                                                            String finalStartDate,
                                                                                                                            String assignee,
                                                                                                                            String requester,
                                                                                                                            String page,
                                                                                                                            String pageSize,
                                                                                                                            String statusTypeTaskRequest,
                                                                                                                            String calculate,
                                                                                                                            String expand,
                                                                                                                            String cardFilters)
                                                                                                                     throws Exception
        Parameters:
        processId -
        initialStartDate -
        finalStartDate -
        assignee -
        requester -
        page -
        pageSize -
        statusTypeTaskRequest - 1 onTime; 2 warning, 3 Expired
        Returns:
        ResponseEnvelopeVO objeto com os dados do processo com base na tarefa
        Throws:
        Exception
      • findProcessVersions

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<BPMProcessVersionVO> findProcessVersions​(String processId,
                                                                                                                          Integer version)
                                                                                                                   throws Exception
        Listagem de versões de um processo
        Parameters:
        processId - Identificador do processo (Obrigatório)
        version - Versão do processo (Obrigatório)
        Returns:
        ResponseEnvelopeVO objeto com os dados do processo
        Throws:
        Exception
        Since:
        1.6.5
      • findProcessVersions

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<BPMProcessVersionVO> findProcessVersions​(String processId,
                                                                                                                          Integer page,
                                                                                                                          Integer pageSize,
                                                                                                                          List<String> order,
                                                                                                                          List<String> expand,
                                                                                                                          Integer version,
                                                                                                                          Integer formId,
                                                                                                                          Boolean formExistent,
                                                                                                                          Boolean editing,
                                                                                                                          Boolean active,
                                                                                                                          Boolean blocked,
                                                                                                                          Boolean requiresPassword,
                                                                                                                          Integer bpmnVersion,
                                                                                                                          Boolean inheritFormSecurity,
                                                                                                                          Boolean mobileReady)
                                                                                                                   throws Exception
        Listagem de versões de um processo
        Parameters:
        processId - Identificador do processo (Obrigatório)
        page - numero da pagina
        pageSize - numero de registros por pagina
        order - lista de ordenação (java.util.ArrayList)
        expand - Campos expansíveis (java.util.ArrayList)
        version - Versão do processo (Obrigatório)
        formId - id do fomulário
        formExistent - caso exista formulários
        editing - somente em edição
        active - Atividades ativas (true ou false) default = true
        blocked - considerar versões bloqueadas
        requiresPassword - requer senha
        bpmnVersion - procurar pelo numero da verão bpmn
        inheritFormSecurity - progurar em versões com segurança de documento
        mobileReady - procurar versões que possam ser usadas no celular
        Returns:
        ResponseEnvelopeVO objeto com os dados do processo
        Throws:
        Exception
        Since:
        1.6.5
      • findActivities

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<BPMProcessActivityVO> findActivities​(Set<Integer> processInstanceId,
                                                                                                                      Integer movementSequence,
                                                                                                                      Boolean active,
                                                                                                                      Set<String> slaStatus,
                                                                                                                      String processId,
                                                                                                                      String requester,
                                                                                                                      String requesterName,
                                                                                                                      String manager,
                                                                                                                      String initialDeadlineDate,
                                                                                                                      String finalDeadlineDate,
                                                                                                                      String initialStartDate,
                                                                                                                      String finalStartDate,
                                                                                                                      String initialWarningDate,
                                                                                                                      String finalWarningDate,
                                                                                                                      String initialEndDate,
                                                                                                                      String finalEndDate,
                                                                                                                      Integer processVersion,
                                                                                                                      Integer stateSequence,
                                                                                                                      Integer page,
                                                                                                                      Integer pageSize,
                                                                                                                      List<String> expand,
                                                                                                                      List<String> order,
                                                                                                                      Set<String> formFields,
                                                                                                                      List<Long> requesterLocal,
                                                                                                                      List<Long> assigneeLocal)
                                                                                                               throws Exception
        Lista as atividades de uma versão de um processo
        Parameters:
        processInstanceId - Identificador da solicitação (java.util.HashSet)
        movementSequence - Identificador do movimento atrelado a tarefa
        active - Atividades ativas (true ou false) default = true
        slaStatus - Estado do prazo (ON_TIME,WARNING,EXPIRED) (java.util.HashSet)
        processId - Identificador do processo (Obrigatório)
        requester - Matrícula do requisitante
        requesterName - Nome do requisitante
        manager - Matrícula do gestor do processo
        initialDeadlineDate - Prazo a partir de (yyyy-MM-ddTHH:mm:ssZ")
        finalDeadlineDate - Prazo até (yyyy-MM-ddTHH:mm:ssZ")
        initialStartDate - Início a partir de (yyyy-MM-ddTHH:mm:ssZ")
        finalStartDate - Início até (yyyy-MM-ddTHH:mm:ssZ")
        initialWarningDate - Aviso de expiração a partir de (yyyy-MM-ddTHH:mm:ssZ")
        finalWarningDate - Aviso de expiração até (yyyy-MM-ddTHH:mm:ssZ")
        initialEndDate - Encerramento a partir de (yyyy-MM-ddTHH:mm:ssZ")
        finalEndDate - Encerramento até (yyyy-MM-ddTHH:mm:ssZ")
        processVersion - Versão do processo (Obrigatório)
        stateSequence - Identificador de sequência do estado do processo
        page - numero da pagina
        pageSize - numero de registros por pagina
        expand - Campos expansíveis (java.util.ArrayList)
        order - lista de ordenação (java.util.ArrayList)
        formFields - Campos de formulário para pesquisa, seguindo o padrão Campo:Valor ((java.util.HashSet))
        requesterLocal - Identificador do local do requisitante (java.util.ArrayList)
        assigneeLocal - Identificador do local do responsável (java.util.ArrayList)
        Returns:
        ResponseEnvelopeVO objeto com os dados das atividades do processo
        Throws:
        Exception
        Since:
        1.6.5
      • findActivities

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<BPMProcessActivityVO> findActivities​(String processId,
                                                                                                                      Integer processVersion)
                                                                                                               throws Exception
        Lista as atividades de uma versão de um processo
        Parameters:
        processId - Identificador do processo (Obrigatório)
        processVersion - Versão do processo (Obrigatório)
        Returns:
        ResponseEnvelopeVO objeto com os dados das atividades do processo
        Throws:
        Exception
        Since:
        1.6.5
      • findActivities

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<BPMProcessActivityVO> findActivities​(String processId,
                                                                                                                      Integer processVersion,
                                                                                                                      Boolean active)
                                                                                                               throws Exception
        Lista as atividades de uma versão de um processo
        Parameters:
        processId - Identificador do processo (Obrigatório)
        processVersion - Versão do processo (Obrigatório)
        active - Atividades ativas (true ou false) default = true
        Returns:
        ResponseEnvelopeVO objeto com os dados das atividades do processo
        Throws:
        Exception
        Since:
        1.6.5
      • findRequests

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<BPMRequestVO> findRequests​(Set<Integer> processInstanceId,
                                                                                                            Integer initialProcessInstanceId,
                                                                                                            Integer finalProcessInstanceId,
                                                                                                            String assignee,
                                                                                                            Set<String> participants,
                                                                                                            Set<String> completeColleagueIds,
                                                                                                            Set<String> status,
                                                                                                            Set<String> slaStatus,
                                                                                                            String processId,
                                                                                                            String requester,
                                                                                                            String assigneeName,
                                                                                                            String requesterName,
                                                                                                            String manager,
                                                                                                            String initialDeadlineDate,
                                                                                                            String finalDeadlineDate,
                                                                                                            String initialStartDate,
                                                                                                            String finalStartDate,
                                                                                                            String initialWarningDate,
                                                                                                            String finalWarningDate,
                                                                                                            String initialEndDate,
                                                                                                            String finalEndDate,
                                                                                                            Integer processVersion,
                                                                                                            Integer stateSequence,
                                                                                                            Integer page,
                                                                                                            Integer pageSize,
                                                                                                            List<String> expand,
                                                                                                            List order,
                                                                                                            Set<String> formFields,
                                                                                                            List<Long> requesterLocal,
                                                                                                            List<Long> assigneeLocal)
                                                                                                     throws Exception
        Listagem de solicitações de uma determinada versão de um processo
        Parameters:
        processInstanceId - Identificador da solicitação (java.util.HashSet)
        initialProcessInstanceId - intervalo inicial do processo
        finalProcessInstanceId - intervalo final do processo
        assignee - Matrícula do responsável
        participants - participantes da tarefa (java.util.HashSet)
        completeColleagueIds - Tarefa concluída com gerente ou substituto (java.util.HashSet)
        status - status da tarefa (java.util.HashSet) OPEN,CANCELED,FINALIZED
        slaStatus - Estado do prazo (ON_TIME,WARNING,EXPIRED) (java.util.HashSet)
        processId - Identificador do processo (Obrigatório)
        requester - Matrícula do requisitante
        assigneeName - Nome do responsável
        requesterName - Nome do requisitante
        manager - Matrícula do gestor do processo
        initialDeadlineDate - Prazo a partir de (yyyy-MM-ddTHH:mm:ssZ")
        finalDeadlineDate - Prazo até (yyyy-MM-ddTHH:mm:ssZ")
        initialStartDate - Início a partir de (yyyy-MM-ddTHH:mm:ssZ")
        finalStartDate - Início até (yyyy-MM-ddTHH:mm:ssZ")
        initialWarningDate - Aviso de expiração a partir de (yyyy-MM-ddTHH:mm:ssZ")
        finalWarningDate - Aviso de expiração até (yyyy-MM-ddTHH:mm:ssZ")
        initialEndDate - Encerramento a partir de (yyyy-MM-ddTHH:mm:ssZ")
        finalEndDate - Encerramento até (yyyy-MM-ddTHH:mm:ssZ")
        processVersion - Versão do processo (Obrigatório)
        stateSequence - Identificador de sequência do estado do processo
        page - numero da pagina
        pageSize - numero de registros por pagina
        expand - Campos expansíveis (java.util.ArrayList)
        order - lista de ordenação (java.util.ArrayList)
        formFields - Campos de formulário para pesquisa, seguindo o padrão Campo:Valor ((java.util.HashSet))
        requesterLocal - Identificador do local do requisitante (java.util.ArrayList)
        assigneeLocal - Identificador do local do responsável (java.util.ArrayList)
        Returns:
        ResponseEnvelopeVO objeto com os dados da solicitações do processo
        Throws:
        Exception
        Since:
        1.6.5
      • findRequests

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<BPMRequestVO> findRequests​(String processId,
                                                                                                            Integer processVersion,
                                                                                                            Set<String> status)
                                                                                                     throws Exception
        Listagem de solicitações de uma determinada versão de um processo
        Parameters:
        processId - Identificador do processo (Obrigatório)
        processVersion - Versão do processo (Obrigatório)
        status - status da tarefa (java.util.HashSet) OPEN,CANCELED,FINALIZED
        Returns:
        ResponseEnvelopeVO objeto com os dados da solicitações do processo
        Throws:
        Exception
        Since:
        1.6.5
      • findRequests

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<BPMRequestVO> findRequests​(String processId,
                                                                                                            Integer processVersion)
                                                                                                     throws Exception
        Listagem de solicitações de uma determinada versão de um processo
        Parameters:
        processId - Identificador do processo (Obrigatório)
        processVersion - Versão do processo (Obrigatório)
        Returns:
        ResponseEnvelopeVO objeto com os dados da solicitações do processo
        Throws:
        Exception
        Since:
        1.6.5
      • findProcessVersionsStates

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<BPMProcessStateVO> findProcessVersionsStates​(String processId,
                                                                                                                              Integer processVersion,
                                                                                                                              Integer stateSequence,
                                                                                                                              Integer page,
                                                                                                                              Integer pageSize,
                                                                                                                              String stateType,
                                                                                                                              String bpmnType,
                                                                                                                              String stateName,
                                                                                                                              String stateDescription,
                                                                                                                              Boolean interactives)
                                                                                                                       throws Exception
        Listagem de estados de um processo
        Parameters:
        processId - Identificador do processo (Obrigatório)
        processVersion - Versão do processo (Obrigatório)
        stateSequence - Identificador de sequência do estado do processo
        page - numero da pagina
        pageSize - numero de registros por pagina
        stateType - tipo do estado SIMPLE,AUTOMATIC,SUBPROCESS,FORK,JOIN
        bpmnType - BPM tipo : START_EVENT_NORMAL START_EVENT_MESSAGE START_EVENT_TIMER START_EVENT_CONDITIONAL START_EVENT_SIGNAL START_EVENT_PARALLEL_MULTIPLE START_EVENT_MULTIPLE INTERMEDIATE_EVENT_NORMAL INTERMEDIATE_EVENT_MESSAGE INTERMEDIATE_EVENT_TIMER INTERMEDIATE_EVENT_ESCALATION INTERMEDIATE_EVENT_COMPENSATE INTERMEDIATE_EVENT_CONDITIONAL INTERMEDIATE_EVENT_LINK INTERMEDIATE_EVENT_SIGNAL INTERMEDIATE_EVENT_PARALLEL_MULTIPLE INTERMEDIATE_EVENT_MULTIPLE INTERMEDIATE_EVENT_MESSAGE_RECEIVE INTERMEDIATE_EVENT_SIGNAL_RECEIVE INTERMEDIATE_EVENT_LINK_RECEIVE INTERMEDIATE_EVENT_ERROR END_EVENT_NORMAL END_EVENT_MESSAGE END_EVENT_ESCALATION END_EVENT_ERROR END_EVENT_SIGNAL END_EVENT_CANCEL END_EVENT_MULTIPLE END_EVENT_COMPENSATE END_EVENT_TERMINATE TASK_NORMAL TASK_USER TASK_SERVICE TASK_RECEIVE TASK_MAIL TASK_MANUAL TASK_BUSINESS_RULE TASK_SCRIPT SUBPROCESS_NORMAL SUBPROCESS_ADHOC GATEWAY_EXCLUSIVE GATEWAY_INCLUSIVE GATEWAY_EVENT GATEWAY_EXCLUSIVE_EVENT GATEWAY_PARALLEL_EVENT GATEWAY_COMPLEX GATEWAY_PARALLEL GATEWAY_JOIN LOOP_NONE LOOP_DEFAULT LOOP_MULTI_THREAD"
        stateName - Nome do estado
        stateDescription - descrição do estado
        interactives - Retorna apenas estados interativos, aqueles que exigem interação do usuário
        Returns:
        ResponseEnvelopeVO objeto com os dados dos estados do processo
        Throws:
        Exception
        Since:
        1.6.5
      • findProcessVersionsStates

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<BPMProcessStateVO> findProcessVersionsStates​(String processId,
                                                                                                                              Integer processVersion,
                                                                                                                              String bpmnType)
                                                                                                                       throws Exception
        Listagem de estados de um processo
        Parameters:
        processId - Identificador do processo (Obrigatório)
        processVersion - Versão do processo (Obrigatório)
        bpmnType - BPM tipo : START_EVENT_NORMAL START_EVENT_MESSAGE START_EVENT_TIMER START_EVENT_CONDITIONAL START_EVENT_SIGNAL START_EVENT_PARALLEL_MULTIPLE START_EVENT_MULTIPLE INTERMEDIATE_EVENT_NORMAL INTERMEDIATE_EVENT_MESSAGE INTERMEDIATE_EVENT_TIMER INTERMEDIATE_EVENT_ESCALATION INTERMEDIATE_EVENT_COMPENSATE INTERMEDIATE_EVENT_CONDITIONAL INTERMEDIATE_EVENT_LINK INTERMEDIATE_EVENT_SIGNAL INTERMEDIATE_EVENT_PARALLEL_MULTIPLE INTERMEDIATE_EVENT_MULTIPLE INTERMEDIATE_EVENT_MESSAGE_RECEIVE INTERMEDIATE_EVENT_SIGNAL_RECEIVE INTERMEDIATE_EVENT_LINK_RECEIVE INTERMEDIATE_EVENT_ERROR END_EVENT_NORMAL END_EVENT_MESSAGE END_EVENT_ESCALATION END_EVENT_ERROR END_EVENT_SIGNAL END_EVENT_CANCEL END_EVENT_MULTIPLE END_EVENT_COMPENSATE END_EVENT_TERMINATE TASK_NORMAL TASK_USER TASK_SERVICE TASK_RECEIVE TASK_MAIL TASK_MANUAL TASK_BUSINESS_RULE TASK_SCRIPT SUBPROCESS_NORMAL SUBPROCESS_ADHOC GATEWAY_EXCLUSIVE GATEWAY_INCLUSIVE GATEWAY_EVENT GATEWAY_EXCLUSIVE_EVENT GATEWAY_PARALLEL_EVENT GATEWAY_COMPLEX GATEWAY_PARALLEL GATEWAY_JOIN LOOP_NONE LOOP_DEFAULT LOOP_MULTI_THREAD"
        Throws:
        Exception
        Since:
        1.6.5
      • findProcessVersionsStates

        com.totvs.technology.foundation.sdk.service.vo.common.ResponseEnvelopeVO<BPMProcessStateVO> findProcessVersionsStates​(String processId,
                                                                                                                              Integer processVersion)
                                                                                                                       throws Exception
        Listagem de estados de um processo
        Parameters:
        processId - Identificador do processo (Obrigatório)
        processVersion - Versão do processo (Obrigatório)
        Throws:
        Exception
        Since:
        1.6.5
      • convertProcess

        List<String> convertProcess​(List<Integer> processInstanceIds,
                                    Integer newVersion,
                                    List<Integer> actualStates,
                                    List<Integer> newStates)
                             throws Exception
        Converte as solicitaçõe de um processos para uma nova versão.
        Parameters:
        processInstanceIds - lista de processos a serem convertidos (java.util.ArrayList)
        newVersion - versão que os processos serão convertidos (Integer)
        actualStates - lista das atividades dos processos (java.util.ArrayList)
        newStates - lista das novas atividades após a conversão (java.util.ArrayList)
        Returns:
        Lista com as informações da socitações convertidas e não concertidas
        Throws:
        Exception
        Since:
        1.6.5
      • releaseVersion

        boolean releaseVersion​(String processId,
                               Integer version)
                        throws Exception
        Libera uma versão do processo
        Parameters:
        processId - nome do processo (*obrigatório, String)
        version - versão do processo (*obrigatório, Integer)
        Returns:
        Boolean true ou false;
        Throws:
        Exception
        Since:
        1.6.5
      • releaseLatestVersion

        boolean releaseLatestVersion​(String processId)
                              throws Exception
        Libera a ultima versão do processo
        Parameters:
        processId - nome do processo (*obrigatório, String)
        Returns:
        Boolean true ou false;
        Throws:
        Exception
        Since:
        1.6.5
      • importProcess

        boolean importProcess​(String xml,
                              String processId,
                              Integer formId,
                              Boolean release)
                       throws Exception
        Importa um processo via XML
        Parameters:
        xml - aquivo xml com o processo (* Obrigatório)
        processId - id (Nome) do processo (* Obrigatório)
        formId - id do fomulário
        release - libera a versão (true ou false)
        Returns:
        Throws:
        Exception
        Since:
        1.6.5
      • importProcess

        boolean importProcess​(String xml,
                              String processId,
                              Boolean release)
                       throws Exception
        Importa um processo via XML
        Parameters:
        xml - aquivo xml com o processo (* Obrigatório)
        processId - id (Nome) do processo (* Obrigatório)
        release - libera a versão (true ou false)
        Returns:
        Throws:
        Exception
        Since:
        1.6.5