/**
 * Copyright 1996-2014 FoxBPM ORG.
 *
 * 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.
 * 
 * @author kenshin
 */
package org.foxbpm.engine;

import org.foxbpm.engine.impl.ExternalContent;
import org.foxbpm.engine.impl.ProcessEngineConfigurationImpl;

public interface ProcessEngine {

	/**
	 * FoxBPM引擎的版本号
	 */
	public static String VERSION = "6.0";

	/**
	 * 默认名称为 'default'
	 */
	String getName();

	/**
	 * 获取模型服务 (主要作用是用于管理流程部署的操作服务)
	 * 
	 * @return 模型服务
	 */
	ModelService getModelService();

	/**
	 * 获取运行时服务 (用于管理运行时流程实例的操作)
	 * 
	 * @return 运行时服务
	 */
	RuntimeService getRuntimeService();

	/**
	 * 获取表单服务 (主要作用是用于管理任务表单的操作)
	 * 
	 * @return 表单服务
	 */
	FormService getFormService();

	/**
	 * 获取任务服务 (主要作用是用于管理运行时任务的操作)
	 * 
	 * @return 任务服务
	 */
	TaskService getTaskService();

	/**
	 * 获取历史数据服务 (主要作用是用于管理流程实例、任务实例等历史数据的操作)
	 * 
	 * @return 历史数据服务
	 */
	HistoryService getHistoryService();

	/**
	 * 获取组织结构服务 (主要作用是用于管理组织结构的操作)
	 * 
	 * @return 组织结构服务
	 */
	IdentityService getIdentityService();

	/**
	 * 获取定时任务服务 (主要作用是用于管理定时任务的操作)
	 * 
	 * @return 定时任务
	 */
	ScheduleService getScheduleService();

	/**
	 * 流程管理服务 (用于对流程干预)
	 * 
	 * @return
	 */
	ManagementService getManagementService();

	/**
	 * 关闭流程引擎 (关注销引擎对象、关闭定时服务、数据库连接、脚本语言)
	 */
	void closeEngine();

	/**
	 * 设置引擎使用的外部数据库连接
	 * 
	 * @param connection
	 */
	void setExternalContent(ExternalContent externalContent);

	/**
	 * 获取流程引擎配置
	 * 
	 * @return
	 */
	ProcessEngineConfigurationImpl getProcessEngineConfiguration();
	
	/**
	 * 获取外部注册的service
	 * @param interfaceClass
	 * @return
	 */
	public  <T> T getService(Class<T> interfaceClass);

}