Activiti5CompatibilityHandler.java

/* Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.activiti.engine.compatibility;

import java.io.InputStream;
import java.util.Collection;
import java.util.Date;
import java.util.List;
import java.util.Map;

import org.activiti.bpmn.model.BpmnModel;
import org.activiti.bpmn.model.MapExceptionEntry;
import org.activiti.engine.delegate.BpmnError;
import org.activiti.engine.delegate.DelegateExecution;
import org.activiti.engine.impl.persistence.entity.JobEntity;
import org.activiti.engine.impl.persistence.entity.SignalEventSubscriptionEntity;
import org.activiti.engine.impl.persistence.entity.TaskEntity;
import org.activiti.engine.impl.repository.DeploymentBuilderImpl;
import org.activiti.engine.repository.Deployment;
import org.activiti.engine.repository.ProcessDefinition;
import org.activiti.engine.runtime.Clock;
import org.activiti.engine.runtime.Job;
import org.activiti.engine.runtime.ProcessInstance;
import org.activiti.engine.task.Attachment;
import org.activiti.engine.task.Comment;

import com.fasterxml.jackson.databind.node.ObjectNode;

/**
 * @author Joram Barrez
 * @author Tijs Rademakers
 */
public interface Activiti5CompatibilityHandler {

  public static final String ACTIVITI_5_ENGINE_TAG = "activiti-5";
  
  ProcessDefinition getProcessDefinition(String processDefinitionId);
  
  ProcessDefinition getProcessDefinitionByKey(String processDefinitionKey);
  
  org.activiti.bpmn.model.Process getProcessDefinitionProcessObject(String processDefinitionId);
  
  BpmnModel getProcessDefinitionBpmnModel(String processDefinitionId);
  
  ObjectNode getProcessDefinitionInfo(String processDefinitionId);
  
  void saveProcessDefinitionInfo(String processDefinitionId, ObjectNode infoNode);
  
  void addCandidateStarter(String processDefinitionId, String userId, String groupId);
  
  void deleteCandidateStarter(String processDefinitionId, String userId, String groupId);
  
  void suspendProcessDefinition(String processDefinitionId, String processDefinitionKey, boolean suspendProcessInstances, Date suspensionDate, String tenantId);

  void activateProcessDefinition(String processDefinitionId, String processDefinitionKey, boolean activateProcessInstances, Date activationDate, String tenantId);
  
  void setProcessDefinitionCategory(String processDefinitionId, String category);
  
  Deployment deploy(DeploymentBuilderImpl deploymentBuilder);
  
  void setDeploymentCategory(String deploymentId, String category);
  
  void changeDeploymentTenantId(String deploymentId, String newTenantId);
  
  void deleteDeployment(String deploymentId, boolean cascade);
  
  ProcessInstance startProcessInstance(String processDefinitionKey, String processDefinitionId, Map<String, Object> variables, String businessKey, String tenantId, String processInstanceName);
  
  ProcessInstance startProcessInstanceByMessage(String messageName, Map<String, Object> variables, String businessKey, String tenantId);
  
  Object getExecutionVariable(String executionId, String variableName, boolean isLocal);
  
  Map<String, Object> getExecutionVariables(String executionId, Collection<String> variableNames, boolean isLocal);
  
  void setExecutionVariables(String executionId, Map<String, ? extends Object> variables, boolean isLocal);
  
  void removeExecutionVariables(String executionId, Collection<String> variableNames, boolean isLocal);
  
  void updateBusinessKey(String processInstanceId, String businessKey);
  
  void suspendProcessInstance(String processInstanceId);
  
  void activateProcessInstance(String processInstanceId);
  
  void addIdentityLinkForProcessInstance(String processInstanceId, String userId, String groupId, String identityLinkType);
  
  void deleteIdentityLinkForProcessInstance(String processInstanceId, String userId, String groupId, String identityLinkType);
  
  void deleteProcessInstance(String processInstanceId, String deleteReason);
  
  void deleteHistoricProcessInstance(String processInstanceId);
  
  void completeTask(TaskEntity taskEntity, Map<String, Object> variables, boolean localScope);
  
  void claimTask(String taskId, String userId);
  
  void setTaskVariables(String taskId, Map<String, ? extends Object> variables, boolean isLocal);
  
  void removeTaskVariables(String taskId, Collection<String> variableNames, boolean isLocal);
  
  void setTaskDueDate(String taskId, Date dueDate);
  
  void setTaskPriority(String taskId, int priority);
  
  void deleteTask(String taskId, String deleteReason, boolean cascade);
  
  void deleteHistoricTask(String taskId);
  
  ProcessInstance submitStartFormData(String processDefinitionId, String businessKey, Map<String, String> properties);
  
  void submitTaskFormData(String taskId, Map<String, String> properties, boolean completeTask);
  
  void saveTask(TaskEntity task);
  
  void addIdentityLink(String taskId, String identityId, int identityIdType, String identityType);
  
  void deleteIdentityLink(String taskId, String userId, String groupId, String identityLinkType);
  
  Comment addComment(String taskId, String processInstanceId, String type, String message);
  
  void deleteComment(String commentId, String taskId, String processInstanceId);
  
  Attachment createAttachment(String attachmentType, String taskId, String processInstanceId, String attachmentName, String attachmentDescription, InputStream content, String url);
  
  void saveAttachment(Attachment attachment);
  
  void deleteAttachment(String attachmentId);
  
  void trigger(String executionId, Map<String, Object> processVariables);
  
  void messageEventReceived(String messageName, String executionId, Map<String, Object> processVariables, boolean async);
  
  void signalEventReceived(String signalName, String executionId, Map<String, Object> processVariables, boolean async, String tenantId);
  
  void signalEventReceived(SignalEventSubscriptionEntity signalEventSubscriptionEntity, Object payload, boolean async);

  void executeJob(Job job);
  
  void executeJobWithLockAndRetry(JobEntity job);
  
  void handleFailedJob(JobEntity job, Throwable exception);
  
  void deleteJob(String jobId);
  
  void setJobRetries(String jobId, int retries);
  
  void leaveExecution(DelegateExecution execution);
  
  void propagateError(BpmnError bpmnError, DelegateExecution execution);
  
  boolean mapException(Exception camelException, DelegateExecution execution, List<MapExceptionEntry> mapExceptions);
  
  Map<String, Object> getVariableValues(ProcessInstance processInstance);
  
  Object getScriptingEngineValue(String payloadExpressionValue, String languageValue, DelegateExecution execution);
  
  void addEventListener(Object listener);
  
  void removeEventListener(Object listener);
  
  void setClock(Clock clock);
  
  void resetClock();
  
  Object getRawProcessEngine();
  
  Object getRawProcessConfiguration();
  
  Object getRawCommandExecutor();
  
  Object getCamelContextObject(String camelContextValue);
}