package org.speedframework.engine;

import org.speedframework.exception.SpeedFrameworkException;

import java.io.Serializable;

import java.sql.Connection;

import java.util.List;

/**
 * Class Engine
 * 引擎類
 * @author <a href="mailto:santafeng@gmail.com"> lizf </a>
 * @version $Revision:1.0.0, $Date: 2007-10-10 4:17:28 $
 */
public interface Engine {

	/**
	 * Method setApplicationID
	 * 
	 * @param applicationID speed.cfg.xml connection-factory配置id
	 */
	public void setApplicationID(String applicationID);

	/**
	 * Method getDateBaseVersion
	 *
	 * @return 數據庫類型或版本信息
	 * @throws SpeedFrameworkException
	 */
	public String getDateBaseVersion() throws SpeedFrameworkException;

	/**
	 * Method save
	 *
	 * @param pojo 表對象實體域 參考表對象域模型
	 * @return 執行后表對象實體域
	 * @throws SpeedFrameworkException
	 */
	public Object save(Object pojo) throws SpeedFrameworkException;

	/**
	 * Method update
	 *
	 * @param pojo 表對象實體域 參考表對象域模型
	 * @return 執行后表對象實體域
	 * @throws SpeedFrameworkException
	 */
	public Object update(Object pojo) throws SpeedFrameworkException;

	/**
	 * Method delete
	 *
	 * @param pojo 表對象實體域 參考表對象域模型
	 * @throws SpeedFrameworkException
	 */
	public void delete(Object pojo) throws SpeedFrameworkException;

	/**
	 * Method load
	 *
	 * @param pojo_class 表對象實體域Class 參考表對象域模型
	 * @param id 主鍵列表
	 * @return
	 * @throws SpeedFrameworkException
	 */
	public Object load(Class pojo_class, Serializable id)
			throws SpeedFrameworkException;

	/**
	 * Method getConnection
	 *
	 * @param commit 是否自動提交
	 * @return JDBC連接
	 * @throws SpeedFrameworkException
	 */
	public Connection getConnection(boolean commit)
			throws SpeedFrameworkException;

	/**
	 * Method commit
	 *
	 * @throws SpeedFrameworkException
	 */
	public void commit() throws SpeedFrameworkException;

	/**
	 * Method rollback
	 *
	 * @throws SpeedFrameworkException
	 */
	public void rollback() throws SpeedFrameworkException;

	/**
	 * Method closeEngine
	 *
	 * @throws SpeedFrameworkException
	 */
	public void closeEngine() throws SpeedFrameworkException;

	/**
	 * Method getQuery
	 *
	 * @return 對象隊列查詢器
	 */
	public Query getQuery();

	/**
	 * Method setUseCacheStatus
	 *
	 * @param status 緩存開關 默認true
	 */
	public void setUseCacheStatus(boolean status);

	/**
	 * Method getUseCacheStatus
	 *
	 * @return
	 */
	public boolean getUseCacheStatus();

	/**
	 * Method executeBatch
	 *
	 * @param SQL SQL串
	 * @param params 參數
	 * @throws SpeedFrameworkException
	 */
	public void executeBatch(String SQL, Object[][] params)
			throws SpeedFrameworkException;

	/**
	 * Method executeSpecialSQL
	 *
	 * @param SQL SQL串
	 * @param params 參數
	 * @throws SpeedFrameworkException
	 */
	public void executeSpecialSQL(String SQL, Object[] params)
			throws SpeedFrameworkException;

	/**
	 * Method executeProcedureCall
	 *
	 * @param SQL SQL串
	 * @param params 參數
	 * @param voclass 承載對象實體Class 詳見視圖對象域模型
	 * @return
	 * @throws SpeedFrameworkException
	 */
	public List executeProcedureCall(String SQL, Object[] params, Class voclass)
			throws SpeedFrameworkException;

	/**
	 * Method executeProcedureCall
	 *
	 * @param SQL SQL串
	 * @param params 參數
	 * @throws SpeedFrameworkException
	 */
	public void executeProcedureCall(String SQL, Object[] params)
			throws SpeedFrameworkException;

	/**
	 * Method executeFunctionCall
	 *
	 * @param SQL SQL串
	 * @param params  參數
	 * @param returnType 定義返回類型
	 * @return 單個對象或集合對象 集合對象通過List封裝Map
	 * @throws SpeedFrameworkException
	 */
	public Object executeFunctionCall(String SQL, Object[] params,
			int returnType) throws SpeedFrameworkException;

	/**
	 * Method getSequences
	 *
	 * @param SeqName 序列名稱
	 * @return 序列值
	 * @throws SpeedFrameworkException
	 */
	public String getSequences(String SeqName) throws SpeedFrameworkException;
}