org.snaker.engine.IQueryService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of snaker-core Show documentation
snaker-core as open source.
There is a newer version: 2.5.1
/* Copyright 2012-2013 the original author or authors.
 *
 * 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.snaker.engine;

import java.util.List;

import org.snaker.engine.access.Page;
import org.snaker.engine.entity.HistoryOrder;
import org.snaker.engine.entity.HistoryTask;
import org.snaker.engine.entity.Order;
import org.snaker.engine.entity.Task;
import org.snaker.engine.entity.WorkItem;

/**
 * 流程相关的查询服务
 * @author yuqs
 * @version 1.0
 */
public interface IQueryService {
	/**
	 * 根据流程实例ID获取流程实例对象
	 * @param orderId
	 * @return
	 */
	Order getOrder(String orderId);
	/**
	 * 根据流程实例ID获取历史流程实例对象
	 * @param orderId
	 * @return
	 */
	HistoryOrder getHistOrder(String orderId);
	/**
	 * 根据任务ID获取任务对象
	 * @param taskId
	 * @return
	 */
	Task getTask(String taskId);
	/**
	 * 根据任务ID获取历史任务对象
	 * @param taskId
	 * @return
	 */
	HistoryTask getHistTask(String taskId);
	/**
	 * 根据任务ID获取任务参与者数组
	 * @param taskId
	 * @return
	 */
	String[] getTaskActorsByTaskId(String taskId);
	/**
	 * 根据任务ID获取历史任务参与者数组
	 * @param taskId
	 * @return
	 */
	String[] getHistoryTaskActorsByTaskId(String taskId);
	/**
	 * 根据参与者获取任务集合
	 * @param actorIds
	 * @return
	 */
	List getActiveTasksByActors(String... actorIds);
	
	/**
	 * 根据流程实例ID、任务名称查询所有活动任务列表
	 * @param orderId
	 * @param taskNames
	 * @return
	 */
	List getActiveTasks(String orderId, String... taskNames);
	
	/**
	 * 根据流程实例ID、排除的任务ID、任务名称查询所有活动任务列表
	 * @param orderId
	 * @param taskNames
	 * @return
	 */
	List getActiveTasks(String orderId, String excludedTaskId, String... taskNames);
	
	/**
	 * 分页查询活动任务
	 * @param page
	 * @param actorIds
	 * @return
	 */
	List getActiveTasks(Page page, String... actorIds);
	
	/**
	 * 根据流程定义ID查询流程实例列表
	 * @param processId
	 * @return
	 */
	List getActiveOrders(String... processIds);
	
	/**
	 * 根据父流程实例ID，查询所有活动的子流程
	 * @param parentId
	 * @return
	 */
	List getActiveOrdersByParentId(String parentId, String... excludedId);
	
	/**
	 * 根据流程定义ID分页查询order
	 * @param page
	 * @param processIds
	 * @return
	 */
	List getActiveOrders(Page page, String... processIds);
	
	/**
	 * 根据给定的分页对象page、流程定义processId、参与者ID列表，查询工作项（包含process、order、task三个实体的字段集合）
	 * @param page
	 * @param processId
	 * @param actorIds
	 * @return
	 */
	List getWorkItems(Page page, String processId, String... actorIds);
	
	/**
	 * 分页查询历史流程实例
	 * @param page
	 * @param processIds
	 * @return
	 */
	List getHistoryOrders(Page page, String... processIds);
	
	/**
	 * 根据父流程ID查询子流程实例集合
	 * @param parentId
	 * @return
	 */
	List getHistoryOrdersByParentId(String parentId);
	
	/**
	 * 根据流程实例ID查询所有已完成的任务
	 * @param orderId
	 * @return
	 */
	List getHistoryTasks(String orderId);
	
	/**
	 * 根据参与者分页查询已完成的历史任务
	 * @param page
	 * @param actorIds
	 * @return
	 */
	List getHistoryTasks(Page page, String... actorIds);
	
	/**
	 * 根据流程定义ID、参与者分页查询已完成的历史任务项
	 * @param page
	 * @param processId
	 * @param actorIds
	 * @return
	 */
	List getHistoryWorkItems(Page page, String processId, String... actorIds);
}