ars.database.service.WorkflowService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ars-database Show documentation
Ars framework database
There is a newer version: 2.0.0
package ars.database.service;

import java.util.Map;
import java.util.List;
import java.io.IOException;

import org.activiti.engine.ProcessEngine;

import ars.util.Nfile;
import ars.invoke.local.Api;
import ars.invoke.request.Requester;
import ars.database.model.Model;
import ars.database.service.Service;
import ars.database.activiti.ActivityNode;

/**
 * 工作流业务操作接口
 * 
 * @author yongqiangwu
 * 
 * @param 
 *            数据模型
 */
public interface WorkflowService extends Service {
	/**
	 * 设置工作流引擎
	 * 
	 * @param processEngine
	 *            工作流引擎
	 */
	public void setProcessEngine(ProcessEngine processEngine);

	/**
	 * 启动流程
	 * 
	 * @param requester
	 *            请求对象
	 * @param parameters
	 *            请求参数
	 */
	@Api("start")
	public void start(Requester requester, Map parameters);

	/**
	 * 完成任务
	 * 
	 * @param requester
	 *            请求对象
	 * @param parameters
	 *            附加参数
	 */
	@Api("complete")
	public void complete(Requester requester, Map parameters);

	/**
	 * 获取当前用户任务量
	 * 
	 * @param requester
	 *            请求对象
	 * @param parameters
	 *            过滤参数
	 * @return 任务量
	 */
	@Api("workload")
	public int workload(Requester requester, Map parameters);

	/**
	 * 获取当前用户任务列表
	 * 
	 * @param requester
	 *            请求对象
	 * @param parameters
	 *            过滤参数
	 * @return 对象实例列表
	 */
	@Api("tasks")
	public List tasks(Requester requester, Map parameters);

	/**
	 * 获取当前用户任务进度（已完成任务量）
	 * 
	 * @param requester
	 *            请求对象
	 * @param parameters
	 *            过滤参数
	 * @return 已完成任务量
	 */
	@Api("progress")
	public int progress(Requester requester, Map parameters);

	/**
	 * 获取当前用户历史任务
	 * 
	 * @param requester
	 *            请求对象
	 * @param parameters
	 *            过滤参数
	 * @return 对象实例列表
	 */
	@Api("histories")
	public List histories(Requester requester, Map parameters);

	/**
	 * 获取流程图（如果参数为空则获取部署流程图，如果参数不为空则获取实例流程图）
	 * 
	 * @param requester
	 *            请求对象
	 * @param parameters
	 *            过滤参数
	 * @return 流程图文件
	 * @throws IOException IO操作异常
	 */
	@Api("diagram")
	public Nfile diagram(Requester requester, Map parameters)
			throws IOException;

	/**
	 * 获取节点列表
	 * 
	 * @param requester
	 *            请求对象
	 * @param parameters
	 *            请求参数
	 * @return 状态列表
	 */
	@Api("nodes")
	public List nodes(Requester requester,
			Map parameters);

}