PLTWEB.git - Gitblit

package ${servicePackage};
 
 
import ${voPackage}.${className}VO;
import ${dtoPackage}.${className}DTO;
import ${doPackage}.${doClassName};
import ${mapperPackage}.${className}DaoI;
import ${servicePackage}.${className}ServiceI;
    #if(${lcStatusFullClassName} !="")
    import ${lcStatusFullClassName};
    #end
import com.vci.starter.web.exception.VciBaseException;
import com.vci.starter.web.pagemodel.*;
import com.vci.starter.web.util.*;
import com.vci.starter.web.wrapper.*;
 
 
import java.util.*;
 
import static com.vci.constant.FrameWorkLangCodeConstant.*;
/**
 * ${comments}服务接口
 *
 * @author ${author}
 * @date ${datetime}
 */
public interface ${className}ServiceI {
#if(!${hasParentField})
    /**
     * 查询所有的${comments}
     * @param conditionMap 查询条件
     * @param pageHelper 分页和排序
     * @return 执行结果
     * @throws VciBaseException 查询条件和分页出错的时候会抛出异常
     */
    DataGrid<${className}VO> grid${className}(Map<String, String> conditionMap, PageHelper pageHelper) throws VciBaseException;
 
#else
    /**
     * 查询${comments} 树
     * @param treeQueryObject 树查询对象
     * @return ${comments} 显示树
     * @throws VciBaseException 查询条件不符合要求的时候会抛出异常
     */
    List<Tree> tree${className}(TreeQueryObject treeQueryObject) throws VciBaseException;
    /**
      * 根据树形查询对象来查询数据对象
      *
      * @param treeQueryObject 树形查询对象
      * @return 查询结果,数据对象
      */
    List<${className}DO> select${className}DOByTree(TreeQueryObject treeQueryObject);
#end
 
    /**
     * 批量数据对象转换为显示对象
     * @param ${classNameFristLowwer}DOs 数据对象列表
     * @return 显示对象
     * @throws VciBaseException 参数为空或者不存在的时候会抛出异常
     */
    List<${className}VO> ${classNameFristLowwer}DO2VOs(Collection<${className}DO>  ${classNameFristLowwer}DOs) throws VciBaseException;
 
    /**
     * 数据对象转换为显示对象
     * @param  ${classNameFristLowwer}DO 数据对象
     * @return 显示对象
     * @throws VciBaseException 拷贝属性出错的时候会抛出异常
     */
    ${className}VO ${classNameFristLowwer}DO2VO(${className}DO ${classNameFristLowwer}DO) throws VciBaseException;
 
    /**
     * 增加${comments}
     * @param ${classNameFristLowwer}DTO ${comments}数据传输对象
     * @return 执行结果
     * @throws VciBaseException 参数为空，唯一项，必输项不通过时会抛出异常
     */
    ${className}VO addSave(${className}DTO ${classNameFristLowwer}DTO) throws VciBaseException;
 
    /**
     * 修改${comments}
     * @param ${classNameFristLowwer}DTO ${comments}数据传输对象
     * @return 执行结果
     * @throws VciBaseException 参数为空，唯一项，必输项不通过时会抛出异常
     */
    ${className}VO editSave(${className}DTO ${classNameFristLowwer}DTO) throws VciBaseException;
 
#if(${hasParentField})
    /**
     * 检查 ${comments}是否删除
     * @param ${classNameFristLowwer}DTO ${comments}数据传输对象，必须要有oid和ts属性
     * @return 执行结果 success为true为可以删除，false表示有数据引用，obj为true表示有下级
     * @throws VciBaseException 参数为空，被引用时抛出异常
     */
    BaseResult checkIsCanDelete(${className}DTO ${classNameFristLowwer}DTO) throws VciBaseException;
 
    /**
     * 检查是否有下级是否关联了数据
     *
     * @param oid 主键
     * @return true 表示有引用，false表示没有引用
     * @throws VciBaseException 参数为空和有引用的时候会抛出异常
     */
     boolean checkChildIsLinked(String oid) throws VciBaseException;
 
    /**
      * 校验是否有下级节点，不校验是否关联了数据
      *
      * @param oid 主键
      * @return true表示有下级，false表示没有下级
      * @throws VciBaseException 参数错误，或者数据不存在的时候会抛出异常
      */
    boolean checkHasChild(String oid) throws VciBaseException;
#end
 
    /**
     * 删除${comments}
     * @param ${classNameFristLowwer}DTO ${comments}数据传输对象，oid和ts需要传输
     * @return 删除结果反馈：：success：成功，fail：失败
     * @throws VciBaseException 参数为空，被引用时抛出异常
     */
    BaseResult delete${className}(${className}DTO ${classNameFristLowwer}DTO) throws VciBaseException;
 
    /**
    * 主键获取${comments}
    * @param oid 主键
    * @return ${comments}显示对象
    * @throws VciBaseException 参数为空，数据不存在时会抛出异常
    */
    ${className}VO getObjectByOid(String oid) throws VciBaseException;
 
    /**
     * 主键批量获取${comments}
     * @param oidCollections 主键集合，但是受性能影响，建议一次查询不超过10000个
     * @return ${comments}显示对象
     * @throws VciBaseException 查询出现异常时会抛出
     */
    Collection<${className}VO> list${className}ByOids(Collection<String> oidCollections) throws VciBaseException;
 
#if(${hasEnable})
    /**
     * 启用${comments}
     * @param ${classNameFristLowwer}DTO ${comments}数据传输对象，oid和ts需要传输
#if(${hasParentField})
     * @param cascade 级联启用
#end
     * @return 启用结果反馈：：success：成功，fail：失败
     * @throws VciBaseException 执行出现异常时会抛出
     */
    BaseResult enable${className}(${className}DTO ${classNameFristLowwer}DTO#if(${hasParentField}),boolean cascade #end) throws VciBaseException;
 
    /**
     * 停用{comments}
     * @param ${classNameFristLowwer}DTO ${comments}数据传输对象，oid和ts需要传输
#if(${hasParentField})
     * @param cascade 级联停用
#end
     * @return 停用结果反馈：：success：成功，fail：失败
     * @throws VciBaseException 执行出现异常时会抛出
     */
    BaseResult disable${className}(${className}DTO ${classNameFristLowwer}DTO#if(${hasParentField}),boolean cascade #end) throws VciBaseException;
#end
 
 
#if(!${hasParentField})
    /**
     * 参照${comments}列表
     * @param conditionMap 查询条件
     * @param pageHelper 分页和排序
     * @return ${comments}显示对象列表，生效的内容
     * @throws VciBaseException 查询条件和分页出错的时候会抛出异常
     */
     DataGrid<${className}VO> refDataGrid${className}(Map<String, String> conditionMap, PageHelper pageHelper) throws VciBaseException;
#else
    /**
     * 参照树 ${comments}
     * @param treeQueryObject 树形查询对象
     * @return ${comments}显示树
     * @throws VciBaseException 查询条件和分页出错的时候会抛出异常
     */
     List<Tree> referTree(TreeQueryObject treeQueryObject)  throws VciBaseException;
#end
}