io.camunda.operate.store.ProcessStore 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.operate.store;

import io.camunda.operate.entities.ProcessEntity;
import io.camunda.operate.entities.listview.ProcessInstanceForListViewEntity;
import io.camunda.operate.entities.listview.ProcessInstanceState;
import java.io.IOException;
import java.util.*;
import org.springframework.lang.Nullable;

public interface ProcessStore {

  // General methods -> TODO: refactor to upper interface?
  Optional getDistinctCountFor(final String fieldName);

  void refreshIndices(String... indices);

  // ProcessStore
  ProcessEntity getProcessByKey(final Long processDefinitionKey);

  String getDiagramByKey(final Long processDefinitionKey);

  Map> getProcessesGrouped(
      String tenantId, @Nullable Set allowedBPMNprocessIds);

  Map getProcessesIdsToProcessesWithFields(
      @Nullable Set allowedBPMNIds, int maxSize, String... fields);

  long deleteProcessDefinitionsByKeys(Long... processDefinitionKeys);

  /// Process instance methods
  ProcessInstanceForListViewEntity getProcessInstanceListViewByKey(Long processInstanceKey);

  Map getCoreStatistics(@Nullable Set allowedBPMNids);

  String getProcessInstanceTreePathById(final String processInstanceId);

  List> createCallHierarchyFor(
      List processInstanceIds, final String currentProcessInstanceId);

  long deleteDocument(final String indexName, final String idField, String id) throws IOException;

  void deleteProcessInstanceFromTreePath(String processInstanceKey);

  List getProcessInstancesByProcessAndStates(
      long processDefinitionKey,
      Set states,
      int size,
      String[] includeFields);

  List getProcessInstancesByParentKeys(
      Set parentProcessInstanceKeys, int size, String[] includeFields);

  long deleteProcessInstancesAndDependants(Set processInstanceKeys);

  class ProcessKey {
    private String bpmnProcessId;
    private String tenantId;

    public ProcessKey(String bpmnProcessId, String tenantId) {
      this.bpmnProcessId = bpmnProcessId;
      this.tenantId = tenantId;
    }

    public String getBpmnProcessId() {
      return bpmnProcessId;
    }

    public ProcessKey setBpmnProcessId(String bpmnProcessId) {
      this.bpmnProcessId = bpmnProcessId;
      return this;
    }

    public String getTenantId() {
      return tenantId;
    }

    public ProcessKey setTenantId(String tenantId) {
      this.tenantId = tenantId;
      return this;
    }

    @Override
    public int hashCode() {
      return Objects.hash(bpmnProcessId, tenantId);
    }

    @Override
    public boolean equals(Object o) {
      if (this == o) {
        return true;
      }
      if (o == null || getClass() != o.getClass()) {
        return false;
      }
      final ProcessKey that = (ProcessKey) o;
      return Objects.equals(bpmnProcessId, that.bpmnProcessId)
          && Objects.equals(tenantId, that.tenantId);
    }
  }
}