io.camunda.tasklist.store.TaskStore Maven / Gradle / Ivy

Go to download
/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH under
 * one or more contributor license agreements. See the NOTICE file distributed
 * with this work for additional information regarding copyright ownership.
 * Licensed under the Camunda License 1.0. You may not use this file
 * except in compliance with the Camunda License 1.0.
 */
package io.camunda.tasklist.store;

import io.camunda.tasklist.queries.TaskQuery;
import io.camunda.tasklist.views.TaskSearchView;
import io.camunda.webapps.schema.descriptors.tasklist.template.TaskTemplate;
import io.camunda.webapps.schema.entities.tasklist.TaskEntity;
import java.util.List;
import java.util.Map;

public interface TaskStore {
  String DEFAULT_SORT_FIELD = TaskTemplate.CREATION_TIME;

  /**
   * Zeebe User Task priority is defined as a number between 0 and 100. The default assigned
   * priority is 50.
   */
  String DEFAULT_PRIORITY = "50";

  TaskEntity getTask(final String id);

  List getTaskIdsByProcessInstanceId(String processInstanceId);

  Map getTaskIdsWithIndexByProcessDefinitionId(String processDefinitionId);

  List getTasks(TaskQuery query);

  /**
   * Persist that task is completed even before the corresponding events are imported from Zeebe.
   */
  TaskEntity persistTaskCompletion(final TaskEntity taskBefore);

  TaskEntity rollbackPersistTaskCompletion(final TaskEntity taskBefore);

  TaskEntity persistTaskClaim(TaskEntity taskBefore, String assignee);

  TaskEntity persistTaskUnclaim(TaskEntity task);

  List getTasksById(List ids);

  default TaskEntity makeCopyOf(final TaskEntity taskBefore) {
    return new TaskEntity()
        .setId(taskBefore.getId())
        .setKey(taskBefore.getKey())
        .setPartitionId(taskBefore.getPartitionId())
        .setBpmnProcessId(taskBefore.getBpmnProcessId())
        .setProcessDefinitionId(taskBefore.getProcessDefinitionId())
        .setFlowNodeBpmnId(taskBefore.getFlowNodeBpmnId())
        .setFlowNodeInstanceId(taskBefore.getFlowNodeInstanceId())
        .setProcessInstanceId(taskBefore.getProcessInstanceId())
        .setCreationTime(taskBefore.getCreationTime())
        .setCompletionTime(taskBefore.getCompletionTime())
        .setState(taskBefore.getState())
        .setAssignee(taskBefore.getAssignee())
        .setCandidateGroups(taskBefore.getCandidateGroups())
        .setCandidateUsers(taskBefore.getCandidateUsers())
        .setFormKey(taskBefore.getFormKey())
        .setFormId(taskBefore.getFormId())
        .setFormVersion(taskBefore.getFormVersion())
        .setIsFormEmbedded(taskBefore.getIsFormEmbedded())
        .setTenantId(taskBefore.getTenantId())
        .setImplementation(taskBefore.getImplementation())
        .setExternalFormReference(taskBefore.getExternalFormReference())
        .setCustomHeaders(taskBefore.getCustomHeaders())
        .setProcessDefinitionVersion(taskBefore.getProcessDefinitionVersion())
        .setPriority(taskBefore.getPriority());
  }
}