com.gitee.hengboy.mybatis.enhance.dsl.delete.Deleteable Maven / Gradle / Ivy

Go to download
package com.gitee.hengboy.mybatis.enhance.dsl.delete;

import com.gitee.hengboy.mybatis.enhance.dsl.expression.ColumnExpression;
import com.gitee.hengboy.mybatis.enhance.dsl.expression.TableExpression;
import com.gitee.hengboy.mybatis.enhance.dsl.where.Whereable;
import com.gitee.hengboy.mybatis.enhance.dsl.where.filter.WhereFilter;
import com.gitee.hengboy.mybatis.enhance.exception.EnhanceFrameworkException;

/**
 * 动态删除接口定义
 *
 * @author：于起宇 
 * ================================
 * Created with IDEA.
 * Date：2018/8/10
 * Time：2:40 PM
 * 简书：http://www.jianshu.com/u/092df3f77bca
 * 码云：https://gitee.com/hengboy
 * GitHub：https://github.com/hengyuboy
 * ================================
 * 
 */
public interface Deleteable
        extends Whereable {
    /**
     * 设置所需删除的数据表表达式
     *
     * @param tableExpression 表达式
     * @return 本接口对象实例
     * @throws EnhanceFrameworkException 框架异常
     */
    Deleteable delete(TableExpression tableExpression) throws EnhanceFrameworkException;


    /**
     * 查询条件 and
     *
     * @param firstFilter 第一个查询条件
     * @param filters     多个查询条件
     * @return 本接口对象实例
     * @throws EnhanceFrameworkException 框架异常
     */
    Deleteable where(WhereFilter firstFilter, WhereFilter... filters) throws EnhanceFrameworkException;

    /**
     * 查询条件and
     * v1.0.3编写方式
     *
     * @param columnExpression  列表达式
     * @param columnExpressions 列表达式列表
     * @return 本接口对象实例
     * @throws EnhanceFrameworkException 框架异常
     */
    Deleteable where(ColumnExpression columnExpression, ColumnExpression... columnExpressions) throws EnhanceFrameworkException;

    /**
     * 添加一个and查询条件
     *
     * @param filters     多个查询条件
     * @param whereFilter 查询条件
     * @return 本接口对象实例
     * @throws EnhanceFrameworkException 框架异常
     */
    Deleteable and(WhereFilter whereFilter, WhereFilter... filters) throws EnhanceFrameworkException;

    /**
     * 添加一个and查询条件
     * v1.0.4编写方式
     *
     * @param columnExpression  列表达式
     * @param columnExpressions 列表达式集合
     * @return 本接口对象实例
     * @throws EnhanceFrameworkException 框架异常
     */
    Deleteable and(ColumnExpression columnExpression, ColumnExpression... columnExpressions) throws EnhanceFrameworkException;

    /**
     * 根据sql进行and拼接
     * 该方法后期会被替换
     * 暂时用于解决复杂SQL问题
     *
     * @param sql 执行sql
     * @return 本接口对象实例
     * @throws EnhanceFrameworkException 框架异常
     */
    Deleteable and(String sql) throws EnhanceFrameworkException;

    /**
     * 查询条件 or
     *
     * @param firstFilter 查询条件
     * @param filters     多个查询条件
     * @return 本接口对象实例
     * @throws EnhanceFrameworkException 框架异常
     */
    Deleteable or(WhereFilter firstFilter, WhereFilter... filters) throws EnhanceFrameworkException;

    /**
     * 添加or查询条件
     * v1.0.4编写方式
     *
     * @param columnExpression  列表达式
     * @param columnExpressions 列表达式集合
     * @return 本接口对象实例
     * @throws EnhanceFrameworkException 框架异常
     */
    Deleteable or(ColumnExpression columnExpression, ColumnExpression... columnExpressions) throws EnhanceFrameworkException;

    /**
     * 执行删除
     *
     * @throws EnhanceFrameworkException 框架异常
     */
    void execute() throws EnhanceFrameworkException;
}