tutorial / directive

package com.xiniunet.erp.foundation.helper;

import com.xiniunet.data.request.*;
import com.xiniunet.data.response.*;
import com.xiniunet.foundation.request.*;
import com.xiniunet.foundation.response.*;
import com.xiniunet.framework.base.BaseResponse;
import com.xiniunet.framework.base.BaseURLResponse;
import com.xiniunet.framework.security.Passport;
import com.xiniunet.framework.util.excel.datatable.DataTable;
import com.xiniunet.log.request.ErrorLogCreateRequest;
import com.xiniunet.log.request.UserLogInsertRequest;
import com.xiniunet.log.response.ErrorLogCreateResponse;
import com.xiniunet.log.response.UserLogInsertResponse;

/**
 * Created by DEV001 on 2014/8/18.
 */
public interface FoundationHelper {

    FileUploadResponse upload(FileUploadRequest req, Passport passport);

    Long get();

    IdsGetResponse getNewIds(IdsGetRequest request);

    /**
     * 根据父地区ID取得地区列表
     *
     * @param req 根据父地区获取地区列表请求
     * @return 地区列表应答
     */
    AreasGetByPidResponse getAreaListByPid(AreasGetByPidRequest req);

    /**
     * 获取地址
     *
     * @param req 获取地址请求
     * @param passport 用户护照
     * @return 获取地址应答
     */
    LocationGetResponse getLocation(LocationGetRequest req, Passport passport);

	/**
	 * 创建地址
	 * @param request
	 * @param passport
	 * @return
	 */
	LocationCreateResponse createLocation(LocationCreateRequest request, Passport passport);

    /**
     * 更新地址
     *
     * @param req 更新地址请求
     * @param passport 用户护照
     * @return 更新地址应答
     */
    LocationUpdateResponse updateLocation(LocationUpdateRequest req, Passport passport);

    /**
     * 发送邮件
     *
     * @param req 发送邮件请求
     * @param passport 用户护照
     * @return 发送邮件应答
     */
    MailSendResponse sendMail(MailSendRequest req, Passport passport);

    /**
     * 获取消息列表(未读)
     *
     * @param req 获取消息列表请求
     * @param passport 用户护照
     * @return 消息列表应答
     */
    MessageGetUnreadListResponse getUnreadMessageList(MessageGetUnreadListRequest req, Passport passport);

    /**
     * 获取消息列表(已读)
     *
     * @param req 获取消息列表请求
     * @param passport 用户护照
     * @return 消息列表应答
     */
    MessageGetReadedListResponse getReadedMessageList(MessageGetReadedListRequest req, Passport passport);

    /**
     * 设置消息为已读
     *
     * @param req 设置消息已读请求
     * @param passport 用户护照
     */
    MessageReadResponse readMessage(MessageReadRequest req, Passport passport);

    /**
     * 获取消息信息
     *
     * @param req 获取消息内容请求
     * @param passport 用户护照
     * @return 消息信息应答
     */
    MessageGetResponse getMessage(MessageGetRequest req, Passport passport);

    /**
     * 插入行为日志
     * @param req 插入行为日志请求
     * @param passport 用户护照
     * @return 插入行为日志应答
     */
    UserLogInsertResponse insertUserLog(UserLogInsertRequest req, Passport passport);

    /**
     * 获取银行列表
     *
     * @param req 获取银行列表请求
     * @return 银行列表应答
     */
    BankGetListResponse getBankList(BankGetListRequest req);

    /**
     * 获取银行按ID
     *
     * @param req 获取银行按ID请求
     * @return 银行信息应答
     */
    BankGetResponse getBank(BankGetRequest req);

    /**
     * 获取银行按ID
     *
     * @param req 银行代码
     * @return 银行信息
     */
    BankGetByCodeResponse getBankByCode(BankGetByCodeRequest req);

    /**
     * 获取文件路径
     *
     * @param request
     * @return
     */
    FilePathGetResponse getFilePath(FilePathGetRequest request, Passport passport);

    /**
     * 获取文件列表
     *
     * @param request
     * @param passport
     * @return
     */
    AttachmentGetByBizInfoResponse getAttachmentsByBizInfo(AttachmentGetByBizInfoRequest request, Passport passport);

    /**
     * 获取出版社列表
     *
     * @param request
     * @return
     */
    PressGetListResponse getPressList(PressGetListRequest request);

    /**
     * 获取出版社
     *
     * @param request
     * @return
     */
    PressGetResponse getPress(PressGetRequest request);

    /**
     * 查询获取出版社列表
     *
     * @param request
     * @return
     */
     PressSearchResponse searchPress(PressSearchRequest request);


    /**
     * 上传附件
     * @param request
     * @param passport
     * @return
     */
     AttachmentUploadResponse uploadAttachment(AttachmentUploadRequest request, Passport passport);

    /**
     * 删除附件
     *
     * @param request
     * @param passport
     * @return
     */
    AttachmentDeleteResponse deleteAttachment(AttachmentDeleteRequest request, Passport passport);

    /**
     * 获取区域信息
     *
     * @param request
     * @return
     */
    AreaGetResponse getArea(AreaGetRequest request);

    /**
     * 获取民族列表
     *
     * @param request
     * @return
     */
    NationGetListResponse getNationList(NationGetListRequest request);

    /**
     * 删除地址
     *
     * @param request
     * @param passport
     * @return
     */
    LocationDeleteResponse deleteLocation(LocationDeleteRequest request, Passport passport);


    /**
     * 获取民族
     *
     * @param request
     * @return
     */
    NationGetResponse getNation(NationGetRequest request);

    /**
     * 获取企业性质
     *
     * @param request
     * @return
     */
    BusinessNatureFindResponse findBusinessNature(BusinessNatureFindRequest request);


    /**
     * 获取行业列表
     *
     * @param request
     * @return
     */
    BusinessTradeFindResponse findBusinessTrade(BusinessTradeFindRequest request);

    /**
     * 获取企业性质
     *
     * @param request
     * @return
     */
    BusinessNatureGetResponse getBusinessNature(BusinessNatureGetRequest request);


    /**
     * 获取行业列表
     *
     * @param request
     * @return
     */
    BusinessTradeGetResponse getBusinessTrade(BusinessTradeGetRequest request);

    /**
     * 更新附件businessId
     */
    AttachmentUpdateBusinessResponse updateAttachmentBusiness(AttachmentUpdateBusinessRequest request,Passport passport);

    FileUploadResponse uploadFile(FileUploadRequest request, Passport passport);

    BaseURLResponse uploadDataTable(DataTable dataTable, Passport passport) ;


    /**
     * 根据Id获取食品分类表
     *
     * @param request 获取食品分类表请求
     * @param passport 用户护照
     * @return 获取食品分类表应答
     */
    FoodCategoryGetResponse getFoodCategory(FoodCategoryGetRequest request, Passport passport);



    /**
     * 模糊查询食品分类表
     *
     * @param request 模糊查询食品分类表请求
     * @param passport 用户护照
     * @return 模糊查询食品分类表应答
     */
    FoodCategorySearchResponse searchFoodCategory(FoodCategorySearchRequest request, Passport passport);

    /**
     * 高级查询食品分类表
     *
     * @param request 高级查询食品分类表请求
     * @param passport 用户护照
     * @return 高级查询应答
     */
    FoodCategoryFindResponse findFoodCategory(FoodCategoryFindRequest request, Passport passport);

    MessageCreateResponse createMessage(MessageCreateRequest messageCreateRequest, Passport passport);

    /**
     * 创建异常日志
     * @param request 创建异常日志请求
     * @param passport 护照
     * @return 创建异常日志
     */
    ErrorLogCreateResponse createErrorLog(ErrorLogCreateRequest request, Passport passport);

    DiskGetResponse getDisk(DiskGetRequest request, Passport passport);

    FolderFileFindResponse findFolderFile(FolderFileFindRequest request, Passport passport);

    FolderFileCreateByPathResponse createFolderFileByPath(FolderFileCreateByPathRequest request, Passport passport);


    /**
     * 根据Id获取外部商场
     *
     * @param request 获取外部商场请求
     * @param passport 用户护照
     * @return 获取外部商场应答
     */
    MallGetResponse getMall(MallGetRequest request, Passport passport);

    /**
     * 模糊查询外部商场
     *
     * @param request 模糊查询外部商场请求
     * @param passport 用户护照
     * @return 模糊查询外部商场应答
     */
    MallSearchResponse searchMall(MallSearchRequest request, Passport passport);

    /**
     * 高级查询外部商场
     *
     * @param request 高级查询外部商场请求
     * @param passport 用户护照
     * @return 高级查询应答
     */
    MallFindResponse findMall(MallFindRequest request, Passport passport);

    /**
     * 获取所有外部商场列表
     *
     * @param request 获取所有外部商场列表请求
     * @param passport 用户护照
     * @return 获取所有外部商场列表应答
     */
    MallGetAllListResponse getMallAllList(MallGetAllListRequest request, Passport passport);

    /**
     * 创建外部商场
     *
     * @param request 创建外部商场请求
     * @param passport 用户护照
     * @return 创建外部商场应答
     */
    MallCreateResponse createMall(MallCreateRequest request, Passport passport);

    /**
     * 更新外部商场
     *
     * @param request 更新外部商场请求
     * @param passport 用户护照
     * @return 更新外部商场应答
     */
    MallUpdateResponse updateMall(MallUpdateRequest request, Passport passport);

    /**
     * 删除外部商场
     *
     * @param request 删除外部商场请求
     * @param passport 用户护照
     * @return 删除外部商场应答
     */
    MallDeleteResponse deleteMall(MallDeleteRequest request, Passport passport);

    /**
     * 创建文件夹
     * @param createRequest
     * @param passport
     * @return
     */
    BaseResponse createFolderFile(FolderFileCreateRequest createRequest, Passport passport);
    /**
     * 用户向管理员申请开通网络磁盘（创建大小为0的磁盘）
     * @param request     网盘信息
     * @param passport    护照信息
     * @return          开通网盘的ID
     */
    DiskApplyResponse applyDisk(DiskApplyRequest request, Passport passport);
}