org.activiti5.engine.HistoryService Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of activiti5-engine Show documentation
The newest version!
/*
 * 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.activiti5.engine;

import java.util.List;

import org.activiti.engine.task.IdentityLink;
import org.activiti5.engine.history.HistoricActivityInstance;
import org.activiti5.engine.history.HistoricActivityInstanceQuery;
import org.activiti5.engine.history.HistoricDetail;
import org.activiti5.engine.history.HistoricDetailQuery;
import org.activiti5.engine.history.HistoricIdentityLink;
import org.activiti5.engine.history.HistoricProcessInstance;
import org.activiti5.engine.history.HistoricProcessInstanceQuery;
import org.activiti5.engine.history.HistoricTaskInstance;
import org.activiti5.engine.history.HistoricTaskInstanceQuery;
import org.activiti5.engine.history.HistoricVariableInstance;
import org.activiti5.engine.history.HistoricVariableInstanceQuery;
import org.activiti5.engine.history.NativeHistoricActivityInstanceQuery;
import org.activiti5.engine.history.NativeHistoricDetailQuery;
import org.activiti5.engine.history.NativeHistoricProcessInstanceQuery;
import org.activiti5.engine.history.NativeHistoricTaskInstanceQuery;
import org.activiti5.engine.history.NativeHistoricVariableInstanceQuery;
import org.activiti5.engine.history.ProcessInstanceHistoryLog;
import org.activiti5.engine.history.ProcessInstanceHistoryLogQuery;

/** 
 * Service exposing information about ongoing and past process instances.  This is different
 * from the runtime information in the sense that this runtime information only contains 
 * the actual runtime state at any given moment and it is optimized for runtime 
 * process execution performance.  The history information is optimized for easy 
 * querying and remains permanent in the persistent storage.
 * 
 * @author Christian Stettler
 * @author Tom Baeyens
 * @author Joram Barrez
 */
public interface HistoryService {

  /** Creates a new programmatic query to search for {@link HistoricProcessInstance}s. */
  HistoricProcessInstanceQuery createHistoricProcessInstanceQuery();

  /** Creates a new programmatic query to search for {@link HistoricActivityInstance}s. */
  HistoricActivityInstanceQuery createHistoricActivityInstanceQuery();
  
  /** Creates a new programmatic query to search for {@link HistoricTaskInstance}s. */
  HistoricTaskInstanceQuery createHistoricTaskInstanceQuery();

  /** Creates a new programmatic query to search for {@link HistoricDetail}s. */
  HistoricDetailQuery createHistoricDetailQuery();

  /**
   * Returns a new {@link org.activiti5.engine.query.NativeQuery} for process definitions.
   */
  NativeHistoricDetailQuery createNativeHistoricDetailQuery();
  
  /** Creates a new programmatic query to search for {@link HistoricVariableInstance}s. */
  HistoricVariableInstanceQuery createHistoricVariableInstanceQuery();

  /**
   * Returns a new {@link org.activiti5.engine.query.NativeQuery} for process definitions.
   */
  NativeHistoricVariableInstanceQuery createNativeHistoricVariableInstanceQuery();

  /** Deletes historic task instance.  This might be useful for tasks that are 
   * {@link TaskService#newTask() dynamically created} and then {@link TaskService#complete(String) completed}. 
   * If the historic task instance doesn't exist, no exception is thrown and the 
   * method returns normal.*/
  void deleteHistoricTaskInstance(String taskId);
  
  /**
   * Deletes historic process instance. All historic activities, historic task and
   * historic details (variable updates, form properties) are deleted as well.
   */
  void deleteHistoricProcessInstance(String processInstanceId);

  /**
   * creates a native query to search for {@link HistoricProcessInstance}s via SQL
   */
  NativeHistoricProcessInstanceQuery createNativeHistoricProcessInstanceQuery();

  /**
   * creates a native query to search for {@link HistoricTaskInstance}s via SQL
   */
  NativeHistoricTaskInstanceQuery createNativeHistoricTaskInstanceQuery();

  /**
   * creates a native query to search for {@link HistoricActivityInstance}s via SQL
   */
  NativeHistoricActivityInstanceQuery createNativeHistoricActivityInstanceQuery();
  
  /**
   * Retrieves the {@link HistoricIdentityLink}s associated with the given task.
   * Such an {@link IdentityLink} informs how a certain identity (eg. group or user)
   * is associated with a certain task (eg. as candidate, assignee, etc.), even if the
   * task is completed as opposed to {@link IdentityLink}s which only exist for active
   * tasks.
   */
  List getHistoricIdentityLinksForTask(String taskId);
  
  /**
   * Retrieves the {@link HistoricIdentityLink}s associated with the given process instance.
   * Such an {@link IdentityLink} informs how a certain identity (eg. group or user)
   * is associated with a certain process instance, even if the instance is completed as 
   * opposed to {@link IdentityLink}s which only exist for active instances.
   */
  List getHistoricIdentityLinksForProcessInstance(String processInstanceId);
  
  /**
   * Allows to retrieve the {@link ProcessInstanceHistoryLog} for one process instance.
   */
  ProcessInstanceHistoryLogQuery createProcessInstanceHistoryLogQuery(String processInstanceId);
  
}