Package br.com.davinti.vitruvio.spi

Interface ProcessoInstanciaService

All Known Implementing Classes:
ProcessoInstanciaServiceImpl
public interface ProcessoInstanciaService
Servico para lidar com instancias de processos ja carregados (em execucao ou ja finalizados). Concentra as operacoes de ciclo de vida da instancia (criar, salvar, cancelar, reativar, excluir), manipulacao de tarefas (atribuicao, expiracao, convocacao ativa), anexos, notas e formularios.

Este e um dos servicos expostos diretamente aos scripts dos usuarios, portanto o contrato de cada metodo deve permanecer estavel. Identificadores de instancia aparecem em duas formas ao longo da API: o processInstanceId (id da engine BPMN, do tipo String) e a businessKey / instanceId (id de negocio do Vitruvio, do tipo Long).

Author:
Eduardo Frazao

  • Method Details

    • atualizarStatus

      void atualizarStatus(String processInstanceId, Status newStatus)
      Atualiza o status de uma instancia identificada pelo id da engine BPMN.
      Parameters:
      processInstanceId - id da instancia na engine BPMN
      newStatus - novo status a ser aplicado

    • atualizarStatusByBusinessKey

      void atualizarStatusByBusinessKey(String businessKey, Status newStatus)

    • criarInstancia

      Instancia criarInstancia(String usuario, ProcessoVersao processo)
      Cria e inicia uma nova instancia do processo informado.

      Esta familia de metodos criarInstancia(...) oferece varias sobrecargas que permitem informar progressivamente: o formulario inicial (FormData), variaveis de processo, anexos e uma implementacao de formulario especifica (FormImplementation). Escolha a sobrecarga com os parametros relevantes ao seu caso; os demais assumem valores padrao.

      Parameters:
      usuario - login do usuario que inicia a instancia
      processo - versao do processo a ser instanciada
      Returns:
      a instancia recem-criada

    • criarInstancia

      Instancia criarInstancia(String usuario, ProcessoVersao processo, List<UploadedFile> attachments)

    • criarInstancia

      Instancia criarInstancia(String usuario, Processo processo)

    • criarInstancia

      Instancia criarInstancia(String usuario, Processo processo, FormImplementation impl)

    • criarInstancia

      Instancia criarInstancia(String usuario, String processKey)

    • criarInstancia

      Instancia criarInstancia(String usuario, Processo processo, List<UploadedFile> attachments)

    • criarInstancia

      Instancia criarInstancia(String usuario, ProcessoVersao processo, FormData formData)

    • criarInstancia

      Instancia criarInstancia(String usuario, ProcessoVersao processo, FormData formData, List<UploadedFile> attachments)

    • criarInstancia

      Instancia criarInstancia(String usuario, Processo processo, FormData formData)

    • criarInstancia

      Instancia criarInstancia(String usuario, Processo processo, FormData formData, List<UploadedFile> attachments)

    • criarInstancia

      Instancia criarInstancia(String usuario, ProcessoVersao processo, FormData formData, Map<String,Object> processVariables)

    • criarInstancia

      Instancia criarInstancia(String usuario, ProcessoVersao processo, FormData formData, Map<String,Object> processVariables, List<UploadedFile> attachments)

    • criarInstancia

      Instancia criarInstancia(String usuario, Processo processo, FormData formData, Map<String,Object> processVariables)

    • criarInstancia

      Instancia criarInstancia(String usuario, Processo processo, FormData formData, Map<String,Object> processVariables, FormImplementation impl)

    • criarInstancia

      Instancia criarInstancia(String usuario, Processo processo, FormData formData, Map<String,Object> processVariables, List<UploadedFile> attachments)

    • criarInstancia

      Instancia criarInstancia(String usuario, String processKey, FormData formData, Map<String,Object> processVariables)

    • criarInstancia

      Instancia criarInstancia(String usuario, String processKey, FormData formData, Map<String,Object> processVariables, List<UploadedFile> attachments)

    • salvarAlteracoesInstancia

      Instancia salvarAlteracoesInstancia(Instancia instancia)
      Persiste as alteracoes feitas em uma instancia ja existente (descricao, prioridade, empresa, marcadores, etc.).
      Parameters:
      instancia - instancia com os dados alterados
      Returns:
      a instancia persistida

    • excluirInstanciaDefinitivo

      void excluirInstanciaDefinitivo(Long processId, String motivo, String login)
      Exclui definitivamente uma instancia, removendo seus dados de forma irreversivel. O motivo e o autor sao registrados para auditoria.
      Parameters:
      processId - id de negocio (business key) da instancia
      motivo - justificativa da exclusao, registrada no historico
      login - login do usuario responsavel pela exclusao

    • excluirInstanciaDefinitivo

      void excluirInstanciaDefinitivo(String processInstanceId, String motivo, String login)

    • getInstanceByBPMNProcessInstanceId

      Instancia getInstanceByBPMNProcessInstanceId(String processInstanceId)

    • getInstanceById

      Instancia getInstanceById(Long processInstanceId)

    • getInstanceStatusByBPMNProcessInstanceId

      Status getInstanceStatusByBPMNProcessInstanceId(String processInstanceId)

    • getInstanceStatusById

      Status getInstanceStatusById(Long processInstanceId)

    • updateInstanceDescription

      void updateInstanceDescription(Long instanceId)

    • updateInstanceDescription

      void updateInstanceDescription(Long instanceId, String description)

    • updateInstanceDescription

      void updateInstanceDescription(String processInstanceId)

    • updateInstanceDescription

      void updateInstanceDescription(String processInstanceId, String description)

    • updateInstanceDueDateWithBusinessKey

      void updateInstanceDueDateWithBusinessKey(Long instanceId, Date date)

    • updateInstanceDueDate

      void updateInstanceDueDate(String processInstanceId, Date date)

    • updateInstancePriorityWithBusinessKey

      void updateInstancePriorityWithBusinessKey(Long instanceId, Prioridade prioridade)

    • updateInstancePriority

      void updateInstancePriority(String processInstanceId, Prioridade prioridade)

    • updateInstancePriorityWithBusinessKey

      void updateInstancePriorityWithBusinessKey(Long instanceId, int prioridade)

    • updateInstancePriority

      void updateInstancePriority(String processInstanceId, int prioridade)

    • definirEmpresa

      void definirEmpresa(String processInstanceId, Integer empresaId)

    • definirEmpresa

      void definirEmpresa(String processInstanceId, Integer empresaId, boolean acessoSomenteMembros)

    • definirEmpresaPorBusinessKey

      void definirEmpresaPorBusinessKey(String processInstanceId, Integer empresaId)

    • definirMarcador

      void definirMarcador(String processInstanceId, Integer marcadorId)

    • definirMarcador

      void definirMarcador(String processInstanceId, Marcador marcador)

    • definirMarcador

      void definirMarcador(Long instanceId, Integer marcadorId)

    • definirMarcador

      void definirMarcador(Long instanceId, Marcador marcador)

    • vincularPessoa

      void vincularPessoa(String processInstanceId, Integer pessoaId)

    • vincularPessoa

      void vincularPessoa(Long instanciaId, Integer pessoaId)

    • vincularPessoaPorBusinessKey

      void vincularPessoaPorBusinessKey(String businessKey, Integer pessoaId)

    • removerVinculoPessoa

      void removerVinculoPessoa(String processInstanceId, Integer pessoaId)

    • removerVinculoPessoa

      void removerVinculoPessoa(Long instanciaId, Integer pessoaId)

    • getPessoaPorId

      Pessoa getPessoaPorId(Integer id)

    • salvarFormularioCompletandoTarefa

      void salvarFormularioCompletandoTarefa(String usuario, String taskId, FormData formData, Map<String,Object> processVariables, FormImplementation impl)
      Salva os dados do formulario e completa a tarefa em uma unica operacao transacional, avancando o fluxo do processo para a proxima etapa.

      As variaveis de processo informadas ficam disponiveis para as condicoes de roteamento (gateways) do BPMN. As demais sobrecargas omitem o usuario, as variaveis ou a FormImplementation, assumindo o contexto corrente.

      Parameters:
      usuario - login do usuario que completa a tarefa
      taskId - id da tarefa a ser completada
      formData - dados preenchidos no formulario
      processVariables - variaveis a serem injetadas no processo
      impl - implementacao de formulario a ser utilizada na persistencia

    • salvarFormularioCompletandoTarefa

      void salvarFormularioCompletandoTarefa(String usuario, String taskId, FormData formData, Map<String,Object> processVariables)

    • salvarFormularioCompletandoTarefa

      void salvarFormularioCompletandoTarefa(String taskId, FormData formData, Map<String,Object> processVariables)

    • salvarFormularioCompletandoTarefa

      void salvarFormularioCompletandoTarefa(String usuario, String taskId, FormData formData)

    • salvarFormularioCompletandoTarefa

      void salvarFormularioCompletandoTarefa(String taskId, FormData formData)

    • salvarFormularioCompletandoTarefa

      void salvarFormularioCompletandoTarefa(String usuario, TaskInfo taskInstance, FormData formData, Map<String,Object> processVariables)

    • salvarFormulario

      void salvarFormulario(String taskId, FormData formData)
      Salva os dados do formulario sem completar a tarefa, mantendo-a aberta para edicao posterior.
      Parameters:
      taskId - id da tarefa cujo formulario sera salvo
      formData - dados preenchidos no formulario

    • salvarFormulario

      void salvarFormulario(String taskId, String userLogin, FormData formData)

    • salvarFormulario

      void salvarFormulario(String taskId, String userLogin, FormData formData, FormImplementation impl)

    • atualizarFormulario

      void atualizarFormulario(String usuario, String taskId, FormData formData)
      Atualiza os dados de um formulario de uma tarefa ja finalizada, registrando a alteracao no log de auditoria do formulario.
      Parameters:
      usuario - login do usuario responsavel pela alteracao
      taskId - id da tarefa ja finalizada
      formData - novos dados do formulario
      See Also:

    • atualizarFormulario

      void atualizarFormulario(String usuario, Form form, String taskId, FormData formData)

    • atualizarFormularioInicio

      void atualizarFormularioInicio(String usuario, String processInstanceId, FormData formData)

    • atualizarFormularioInicio

      void atualizarFormularioInicio(String usuario, Form form, String processInstanceId, FormData formData)

    • formularioPossuiLogUpdate

      boolean formularioPossuiLogUpdate(String taskId)

    • getLogsAlteracao

      List<FormularioLogAlteracao> getLogsAlteracao(String taskId)

    • formularioInicioPossuiLogUpdate

      boolean formularioInicioPossuiLogUpdate(String processInstanceId)

    • getLogsAlteracaoStartForm

      List<FormularioLogAlteracao> getLogsAlteracaoStartForm(String processInstanceId)

    • completarTarefa

      void completarTarefa(String taskId)

    • completarTarefa

      void completarTarefa(String login, String taskId, Map<String,Object> processVariables)
      Completa a tarefa informada sem salvar formulario, injetando as variaveis de processo informadas para o roteamento do fluxo.
      Parameters:
      login - login do usuario que completa a tarefa
      taskId - id da tarefa a ser completada
      processVariables - variaveis a serem injetadas no processo

    • buildAnexoFilter

      AnexoFilter buildAnexoFilter()
      Cria um filtro vazio para consulta de anexos, a ser configurado e passado para getAnexos(AnexoFilter) / getAnexos(AnexoFilter, int, int).
      Returns:
      novo filtro de anexos

    • getAnexos

      List<Anexo> getAnexos(AnexoFilter filter, int offset, int limit)

    • getAnexos

      List<Anexo> getAnexos(AnexoFilter filter)

    • getAnexosCount

      Long getAnexosCount(AnexoFilter filter)

    • getAnexos

      List<Anexo> getAnexos(String processInstanceId)

    • getAnexo

      Anexo getAnexo(String processInstanceId, Integer fileId)

    • getAnexos

      List<Anexo> getAnexos(String processInstanceId, String owner)

    • getAnexosCount

      Long getAnexosCount(String processInstanceId)

    • getAnexos

      List<Anexo> getAnexos(String processInstanceId, int offset, int limit)

    • getAnexos

      List<Anexo> getAnexos(Instancia instancia)

    • getAnexoByUUID

      Anexo getAnexoByUUID(String uuid)

    • adicionarAnexo

      Anexo adicionarAnexo(String processInstanceId, String descricao, Arquivo metaInformacoes, File arquivoTemporario)

    • adicionarAnexo

      Anexo adicionarAnexo(String processInstanceId, String descricao, Attachment especificacao, Arquivo metaInformacoes, File arquivoTemporario)
      Adiciona um anexo a instancia, vinculando-o a uma especificacao de anexo (Attachment) definida no formulario. O arquivo fisico temporario e persistido na estrutura de armazenamento e seus metadados sao gravados.
      Parameters:
      processInstanceId - id da instancia que recebera o anexo
      descricao - descricao livre do anexo
      especificacao - especificacao do anexo conforme definida no formulario
      metaInformacoes - metadados do arquivo (nome, tipo, etc.)
      arquivoTemporario - arquivo fisico ja gerado em area temporaria
      Returns:
      o anexo persistido

    • adicionarAnexo

      Anexo adicionarAnexo(Task task, String descricao, Attachment especificacao, Arquivo metaInformacoes, File arquivoTemporario)

    • adicionarAnexo

      Anexo adicionarAnexo(HistoricTaskInstance task, String descricao, Attachment especificacao, Arquivo metaInformacoes, File arquivoTemporario)

    • adicionarAnexoTarefa

      Anexo adicionarAnexoTarefa(String taskId, String descricao, Attachment especificacao, Arquivo metaInformacoes, File arquivoTemporario)

    • excluirAnexo

      void excluirAnexo(Anexo anexo)

    • persistirMetadadosAnexo

      Anexo persistirMetadadosAnexo(Anexo anexo)

    • existsAttachment

      boolean existsAttachment(String attachmentId, String taskId)

    • existsAttachmentForProcessInstance

      boolean existsAttachmentForProcessInstance(String attachmentId, String processInstanceId)

    • getAttachment

      Anexo getAttachment(String attachmentId, String taskId)

    • getProcessInstanceAttachment

      Anexo getProcessInstanceAttachment(String attachmentId, String processInstanceId)

    • existsAttachments

      boolean existsAttachments(String processInstanceId)

    • getAnexosTarefaPorTag

      List<Anexo> getAnexosTarefaPorTag(String taskId, String tag)

    • getCountAnexosTarefaPorTag

      Long getCountAnexosTarefaPorTag(String taskId, String tag)

    • getAnexosProcessoPorTag

      List<Anexo> getAnexosProcessoPorTag(String processInstanceId, String tag)

    • getCountAnexosProcessoPorTag

      Long getCountAnexosProcessoPorTag(String processInstanceId, String tag)

    • buildFilter

      ProcessoInstanciaFilter buildFilter()
      Cria um filtro vazio para consulta de instancias. Configure os criterios desejados e passe-o aos metodos getActiveHistoricInstances, getFinishedInstances, getCanceledInstances ou getDeletedInstances, sempre acompanhado do respectivo getCount para paginacao.
      Returns:
      novo filtro de instancias

    • getActiveHistoricInstances

      List<VitruvioHistoricProcessInstance> getActiveHistoricInstances(ProcessoInstanciaFilter filter, int offset, int limit)
      Retorna, de forma paginada, as instancias ativas que atendem ao filtro.
      Parameters:
      filter - filtro construido por buildFilter()
      offset - indice do primeiro registro (base 0)
      limit - quantidade maxima de registros retornados
      Returns:
      lista de instancias ativas correspondentes
      See Also:

    • getCountActiveHistoricInstances

      Long getCountActiveHistoricInstances(ProcessoInstanciaFilter filter)

    • getFinishedInstances

      List<VitruvioHistoricProcessInstance> getFinishedInstances(ProcessoInstanciaFilter filter, int offset, int limit)

    • getCountFinishedInstances

      Long getCountFinishedInstances(ProcessoInstanciaFilter filter)

    • getCanceledInstances

      List<VitruvioHistoricProcessInstance> getCanceledInstances(ProcessoInstanciaFilter filter, int offset, int limit)

    • getCountCanceledInstances

      Long getCountCanceledInstances(ProcessoInstanciaFilter filter)

    • getDeletedInstances

      List<VitruvioHistoricProcessInstance> getDeletedInstances(ProcessoInstanciaFilter filter, int offset, int limit)

    • getCountDeletedInstances

      Long getCountDeletedInstances(ProcessoInstanciaFilter filter)

    • getFiltros

      List<ProcessoFiltro> getFiltros(String login)

    • getFiltros

      List<ProcessoFiltro> getFiltros(String login, boolean compartilhados)

    • getFiltroConfig

      ProcessoFiltroConfig getFiltroConfig(ProcessoFiltro filtro)

    • salvarFiltro

      ProcessoFiltro salvarFiltro(ProcessoFiltro filtro, ProcessoFiltroConfig configFiltro)

    • excluirFiltro

      void excluirFiltro(ProcessoFiltro filtro)

    • cancelarProcessoDefinitivamente

      void cancelarProcessoDefinitivamente(String processInstanceId, String razao, String user)
      Cancela imediata e definitivamente a instancia, encerrando o fluxo. Ao contrario de cancelarProcesso(String, String, String), nao passa pelo estado intermediario de soft cancel.
      Parameters:
      processInstanceId - id da instancia na engine BPMN
      razao - justificativa do cancelamento, registrada no historico
      user - login do usuario responsavel

    • cancelarProcesso

      void cancelarProcesso(String processInstanceId, String razao, String user)
      Apenas suspende o processo (soft cancel), que sera cancelado definitivamente mais tarde por uma rotina em background.
      Parameters:
      processInstanceId - id da instancia na engine BPMN
      razao - justificativa do cancelamento, registrada no historico
      user - login do usuario responsavel

    • cancelarProcesso

      void cancelarProcesso(String processInstanceId, String razao, String user, boolean permiteCancelamentoAutomatico)
      Suspende o processo (soft cancel) controlando se ele podera ser cancelado definitivamente de forma automatica pela rotina de soft cancel.
      Parameters:
      processInstanceId - id da instancia na engine BPMN
      razao - justificativa do cancelamento, registrada no historico
      user - login do usuario responsavel
      permiteCancelamentoAutomatico - indica se a instancia pode ser cancelada automaticamente pela rotina de soft cancel

    • softCancelAllowAutoCancel

      void softCancelAllowAutoCancel(String processInstanceId, boolean permiteCancelamentoAutomatico)
      Altera, em uma instancia ja em soft cancel, a permissao de cancelamento automatico pela rotina de soft cancel.
      Parameters:
      processInstanceId - id da instancia na engine BPMN
      permiteCancelamentoAutomatico - nova permissao de cancelamento automatico

    • reativarProcesso

      void reativarProcesso(String processInstanceId, String user)
      Reativa uma instancia que se encontra em soft cancel, retornando-a ao fluxo normal de execucao.
      Parameters:
      processInstanceId - id da instancia na engine BPMN
      user - login do usuario responsavel

    • deletarProcesso

      void deletarProcesso(String processInstanceId, String razao, String user)

    • getHistoricProcessInstance

      HistoricProcessInstance getHistoricProcessInstance(String processInstanceId)

    • isTaskFinished

      boolean isTaskFinished(String taskId)

    • isTaskActive

      boolean isTaskActive(String taskId)

    • getCountActiveAprovalTasksForUser

      Long getCountActiveAprovalTasksForUser(UsuarioDTO logged)

    • getActiveAprovalTasksForUser

      List<Task> getActiveAprovalTasksForUser(UsuarioDTO logged)
      Retorna as tarefas de aprovacao ativas disponiveis para o usuario informado, considerando suas atribuicoes e grupos candidatos.
      Parameters:
      logged - usuario para o qual as tarefas serao buscadas
      Returns:
      lista de tarefas de aprovacao ativas

    • getActiveAprovalTasksForUser

      List<Task> getActiveAprovalTasksForUser(UsuarioDTO logged, TarefasAprovacao config)

    • getMobileTasksForUser

      List<Task> getMobileTasksForUser(UsuarioDTO logged, int offset, int limit, boolean modeConvocation)

    • getMobileTasksForUser

      List<Task> getMobileTasksForUser(UsuarioDTO logged)

    • getMobileTasksForUserWithSearchTag

      List<Task> getMobileTasksForUserWithSearchTag(UsuarioDTO logged, String searchTag)

    • getMobileTaskForUser

      Task getMobileTaskForUser(UsuarioDTO logged, String taskId)

    • getMobileTasksForUserForInstance

      List<Task> getMobileTasksForUserForInstance(UsuarioDTO logged, String processInstanceId)

    • getMobileTaskCountForUser

      Long getMobileTaskCountForUser(UsuarioDTO logged)

    • getActiveTasksCountForUser

      Long getActiveTasksCountForUser(UsuarioDTO logged)

    • getActiveTasksForUser

      List<VitruvioTask> getActiveTasksForUser(UsuarioDTO logged)

    • getActiveTasksForUser

      List<VitruvioTask> getActiveTasksForUser(UsuarioDTO logged, int offset, int limit)

    • createTaskFilter

      ActiveTaskFilter createTaskFilter()

    • getActiveTasksForUser

      List<VitruvioTask> getActiveTasksForUser(ActiveTaskFilter filter, int offset, int limit)

    • getActiveTasksCountForUser

      Long getActiveTasksCountForUser(ActiveTaskFilter filter)

    • fillWithActiveTasks

      void fillWithActiveTasks(Collection<VitruvioHistoricProcessInstance> instances)

    • fillWithActiveTasks

      void fillWithActiveTasks(Collection<VitruvioHistoricProcessInstance> instances, UsuarioDTO assignee)

    • activeTaskHasCandidateGroups

      boolean activeTaskHasCandidateGroups(String taskId)

    • getExpiryEligibleTasks

      List<VitruvioTask> getExpiryEligibleTasks(int limit)

    • setTaskState

      void setTaskState(String taskId, TaskState state)

    • getTaskState

      TaskState getTaskState(String taskId)

    • setRelaseDate

      void setRelaseDate(String taskId, Date date)

    • getReleaseDate

      Date getReleaseDate(String taskId)

    • openExpiredTask

      void openExpiredTask(String user, String taskId, Date newDueDate)
      Reabre uma tarefa expirada, definindo um novo prazo de vencimento.
      Parameters:
      user - login do usuario responsavel pela reabertura
      taskId - id da tarefa expirada
      newDueDate - novo prazo de vencimento

    • openExpiredTask

      void openExpiredTask(String user, String taskId, Date newDueDate, Date newReleaseDate)

    • setTaskAsignee

      @Deprecated void setTaskAsignee(String user, String taskId, String newAssignee)
      Deprecated.

    • setTaskAssignee

      void setTaskAssignee(String user, String taskId, String newAssignee)
      Atribui a tarefa a um responsavel (assignee), substituindo o responsavel atual.
      Parameters:
      user - login do usuario que executa a operacao
      taskId - id da tarefa
      newAssignee - login do novo responsavel

    • claimTask

      void claimTask(String user, String taskId)
      Reivindica a tarefa para o usuario informado, tornando-o seu responsavel. Tipicamente usado em tarefas oferecidas a um grupo de candidatos.
      Parameters:
      user - login do usuario que reivindica a tarefa
      taskId - id da tarefa

    • getTaskAssignee

      String getTaskAssignee(String taskId)

    • removeTaskAssignee

      void removeTaskAssignee(String user, String taskId)

    • removeAssigneeAndSetCandidateGroups

      void removeAssigneeAndSetCandidateGroups(String user, String taskId, Collection<String> groupIds)
      Remove o responsavel atual da tarefa e a oferece a um conjunto de grupos candidatos, devolvendo-a a fila desses grupos.
      Parameters:
      user - login do usuario que executa a operacao
      taskId - id da tarefa
      groupIds - ids dos grupos que passarao a ser candidatos

    • removeAssigneeAndSetCandidateUsers

      void removeAssigneeAndSetCandidateUsers(String user, String taskId, Collection<String> logins)

    • setTaskCandidateUsers

      void setTaskCandidateUsers(String user, String taskId, Collection<String> logins)

    • setTaskLogConvocation

      void setTaskLogConvocation(String user, String taskId, TipoAlteracaoTarefa action)

    • getLinkedRoles

      List<String> getLinkedRoles(String taskId)

    • getLinkedUsers

      List<String> getLinkedUsers(String taskId)

    • taskExpiresOnDueDate

      boolean taskExpiresOnDueDate(String taskId)

    • definirCoresTarefaUI

      void definirCoresTarefaUI(String taskId, String backgroundColor, String foreGroundColor)

    • definirCorFundoTarefaUI

      void definirCorFundoTarefaUI(String taskId, String backgroundColor)

    • definirCorFonteTarefaUI

      void definirCorFonteTarefaUI(String taskId, String foreGroundColor)

    • definirDescricaoTarefaUI

      void definirDescricaoTarefaUI(String taskId, String descricao)

    • definirCoresTarefaUI

      void definirCoresTarefaUI(DelegateTask task, String backgroundColor, String foreGroundColor)

    • definirCorFundoTarefaUI

      void definirCorFundoTarefaUI(DelegateTask task, String backgroundColor)

    • definirCorFonteTarefaUI

      void definirCorFonteTarefaUI(DelegateTask task, String foreGroundColor)

    • definirDescricaoTarefaUI

      void definirDescricaoTarefaUI(DelegateTask task, String descricao)

    • definirCoresProcessoUI

      void definirCoresProcessoUI(String processInstanceId, String backgroundColor, String foreGroundColor)

    • definirCorFundoProcessoUI

      void definirCorFundoProcessoUI(String processInstanceId, String backgroundColor)

    • definirCorFonteProcessoUI

      void definirCorFonteProcessoUI(String processInstanceId, String foreGroundColor)

    • definirDescricaoProcessoUI

      void definirDescricaoProcessoUI(String processInstanceId, String descricao)

    • definirCoresProcessoUI

      void definirCoresProcessoUI(Long businessKey, String backgroundColor, String foreGroundColor)

    • definirCorFundoProcessoUI

      void definirCorFundoProcessoUI(Long businessKey, String backgroundColor)

    • definirCorFonteProcessoUI

      void definirCorFonteProcessoUI(Long businessKey, String foreGroundColor)

    • definirDescricaoProcessoUI

      void definirDescricaoProcessoUI(Long businessKey, String descricao)

    • getNotes

      List<Nota> getNotes(Instancia instancia)

    • getNotes

      List<Nota> getNotes(Instancia instancia, String owner)

    • getNotes

      List<Nota> getNotes(String processInstanceId)

    • getNote

      Nota getNote(Integer noteId)

    • getNotes

      List<Nota> getNotes(String processInstanceId, int offset, int limit)

    • getNotesCount

      Long getNotesCount(String processInstanceId)

    • getNotesCount

      Long getNotesCount(NotaFilter filter)

    • getNotes

      List<Nota> getNotes(NotaFilter filter, int offset, int limit)

    • createNotaFilter

      NotaFilter createNotaFilter()

    • addNote

      Nota addNote(Nota nota)

    • addNote

      Nota addNote(Nota nota, boolean notifyProjects)

    • addNotes

      List<Nota> addNotes(Collection<Nota> notes)

    • deleteNote

      void deleteNote(Nota nota)

    • deleteNote

      void deleteNote(Integer id)

    • getDuracaoNotas

      Long getDuracaoNotas(Long instanciaId)

    • getEmailLog

      List<NotaEmailLog> getEmailLog(Integer notaId)

    • enviarPorEmail

      void enviarPorEmail(Integer notaId, String subject, Collection<String> loginDestintarios, boolean oneCopyPerReceiver)

    • enviarPorEmail

      void enviarPorEmail(Integer notaId, String senderLogin, String subject, Collection<String> loginDestintarios, boolean oneCopyPerReceiver)

    • enviarPorEmail

      void enviarPorEmail(Nota nota, String subject, Collection<String> loginDestintarios, boolean oneCopyPerReceiver)

    • enviarPorEmail

      void enviarPorEmail(Nota nota, String senderLogin, String subject, Collection<String> loginDestintarios, boolean oneCopyPerReceiver)

    • definirConvocacaoAtiva

      void definirConvocacaoAtiva(String taskId, String assignee, Integer peso)
      Marca a tarefa como sujeita a convocacao ativa, notificando o responsavel indicado para que aceite ou rejeite a tarefa. O peso influencia a ordem/ prioridade entre as convocacoes.
      Parameters:
      taskId - id da tarefa
      assignee - login do usuario convocado
      peso - peso da convocacao para fins de priorizacao

    • removerConvocacaoAtiva

      void removerConvocacaoAtiva(String taskId)

    • redefinirConvocacaoAtiva

      void redefinirConvocacaoAtiva(String taskId, String assignee, Integer peso)

    • isTarefaConvocacaoAtiva

      boolean isTarefaConvocacaoAtiva(String taskId)

    • aceitarConvocacaoAtiva

      NotificacaoConvocacaoAtiva aceitarConvocacaoAtiva(String taskId, String user)
      Registra o aceite da convocacao ativa pelo usuario, que passa a ser o responsavel pela tarefa.
      Parameters:
      taskId - id da tarefa convocada
      user - login do usuario que aceita
      Returns:
      notificacao de convocacao resultante do aceite

    • rejeitarConvocacaoAtiva

      NotificacaoConvocacaoAtiva rejeitarConvocacaoAtiva(String taskId, String user)
      Registra a rejeicao da convocacao ativa pelo usuario, liberando a tarefa para os demais convocados.
      Parameters:
      taskId - id da tarefa convocada
      user - login do usuario que rejeita
      Returns:
      notificacao de convocacao resultante da rejeicao

    • desconsiderarRejeicoesConvocacaoAtiva

      void desconsiderarRejeicoesConvocacaoAtiva(String taskId)

    • addProcessSearchFlag

      void addProcessSearchFlag(String processInstanceId, String value)

    • getProcessSearchFlags

      List<ProcessoFlagPesquisa> getProcessSearchFlags(String processInstanceId)

    • configureProcessSearchTagAutoLoad

      void configureProcessSearchTagAutoLoad(String processInstanceId, boolean autoLoad)

    • addTaskSearchFlag

      void addTaskSearchFlag(String taskId, String value)

    • getTaskSearchFlags

      List<TaskFlagPesquisa> getTaskSearchFlags(String taskId)

    • configureTaskSearchTagAutoLoad

      void configureTaskSearchTagAutoLoad(String taskId, boolean autoLoad)

    • getDiasExpiracaoPorBusinessKey

      Integer getDiasExpiracaoPorBusinessKey(String businessKey)

    • getDiasExpiracaoPorInstanceId

      Integer getDiasExpiracaoPorInstanceId(String processInstanceid)

    • getDataExpiracaoPorBusinessKey

      Date getDataExpiracaoPorBusinessKey(String businessKey)

    • getDataExpiracaoPorInstanceId

      Date getDataExpiracaoPorInstanceId(String processInstanceid)

    • getDataExpiracaoPorBusinessKey

      Date getDataExpiracaoPorBusinessKey(String businessKey, Date dataBase)

    • getDataExpiracaoPorInstanceId

      Date getDataExpiracaoPorInstanceId(String processInstanceid, Date dataBase)

    • setDataExpiracaoTaskPorMarcador

      void setDataExpiracaoTaskPorMarcador(String taskId)
      Calcula e define a data de expiracao da tarefa a partir do prazo configurado no marcador associado, usando a data atual como base.
      Parameters:
      taskId - id da tarefa

    • setDataExpiracaoTaskPorMarcador

      void setDataExpiracaoTaskPorMarcador(String taskId, Date dataBase)
      Calcula e define a data de expiracao da tarefa a partir do prazo configurado no marcador associado, usando a data base informada.
      Parameters:
      taskId - id da tarefa
      dataBase - data de referencia para o calculo do prazo

    • createTaskPermalink

      Permalink createTaskPermalink(TaskPermalinkParams params)
      Gera um permalink de acesso direto a uma tarefa, encapsulando os parametros informados em um token assinado.
      Parameters:
      params - parametros do permalink (tarefa, validade, etc.)
      Returns:
      permalink gerado, contendo o token de acesso
      See Also:

    • extractTaskPermalinkParams

      TaskPermalinkParams extractTaskPermalinkParams(String token)
      Decodifica e valida um token de permalink, retornando os parametros nele contidos.
      Parameters:
      token - token do permalink
      Returns:
      parametros originais do permalink

    • isTaskPermalinkTokenRevoked

      boolean isTaskPermalinkTokenRevoked(String token)

    • isTaskPermalinkTokenExpired

      boolean isTaskPermalinkTokenExpired(String token)

    • revokeAllTokensForTask

      int revokeAllTokensForTask(String taskId)
      Revoga todos os tokens de permalink emitidos para a tarefa, invalidando os acessos previamente gerados.
      Parameters:
      taskId - id da tarefa
      Returns:
      quantidade de tokens revogados

    • getJobsForRetry

      List<JobRetrySummary> getJobsForRetry(int batchSize)

    • getJobsForRetry

      List<JobRetrySummary> getJobsForRetry(int limit, int maxRetryCount)
      Retorna jobs de processo elegiveis para reprocessamento (retry), limitando o lote e desconsiderando jobs que ja excederam o numero maximo de tentativas.
      Parameters:
      limit - tamanho maximo do lote retornado
      maxRetryCount - numero maximo de tentativas; jobs acima desse limite sao ignorados
      Returns:
      lista de jobs elegiveis para retry

    • saveRetryLog

      ProcessJobRetryLog saveRetryLog(ProcessJobRetryLog log)

    • cleanTaskScopedExecutions

      void cleanTaskScopedExecutions(String taskId)

    • cleanProcessTaskScopedExecutions

      void cleanProcessTaskScopedExecutions(String processInstanceId)

    • isTaskLocked

      boolean isTaskLocked(String taskId)

    • getPendentesExpirados

      List<ProcessoPendenteCancelar> getPendentesExpirados()
      Retorna as instâncias em soft cancel prontas para serem canceladas definitivamente.

    • getPendentesExpirados

      List<ProcessoPendenteCancelar> getPendentesExpirados(int batchSize)
      Retorna as instâncias em soft cancel prontas para serem canceladas definitivamente, limitado ao batchSize;

    • removerSoftCancelPendente

      void removerSoftCancelPendente(String id)
      Remove uma unidade de ProcessoPendenteCancelar.

    • removerSoftCancelPendente

      void removerSoftCancelPendente(ProcessoPendenteCancelar ppc)
      Remove uma unidade de ProcessoPendenteCancelar.

    • removerSoftCancelPendentes

      void removerSoftCancelPendentes(List<ProcessoPendenteCancelar> ppc)
      Remove ProcessoPendenteCancelar em batch.

    • revokePermaLink

      void revokePermaLink(String token)