tutorial / directive

package com.xiniunet.my.foundation.helper;

import com.xiniunet.foundation.request.*;
import com.xiniunet.foundation.response.*;
import com.xiniunet.foundation.service.FoundationService;
import com.xiniunet.framework.security.Passport;
import com.xiniunet.transpation.request.CarrierGetAllListRequest;
import com.xiniunet.transpation.response.CarrierGetAllListResponse;

/**
 *
 * Created on 2014/8/18.
 * @author 吕浩
 * @version 1.0.0
 */
public interface FoundationHelper{

    FileUploadResponse upload(FileUploadRequest 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);

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

    /**
     * 获取地址
     */
    LocationGetResponse getLocation(LocationGetRequest request,Passport passport);

    /**
     * 编辑地址
     */
    LocationUpdateResponse updateLocation(LocationUpdateRequest request,Passport passport);

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

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

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

    /**
     * 管理员同意用户开通网盘，为其分配空间（将磁盘的大小改为512）
     * @param request     网盘ID
     * @param passport    护照信息
     * @return          开通的结果
     */
    DiskOpenResponse openDisk(DiskOpenRequest request, Passport passport);

    /**
     * 管理员删除网络磁盘
     *
     * @param request 删除网络磁盘请求
     * @param passport 用户护照
     * @return 删除网络磁盘应答
     */
    DiskDeleteResponse deleteDisk(DiskDeleteRequest request, Passport passport);

    /**
     * 更新网络磁盘描述
     *
     * @param request 更新网络磁盘请求
     * @param passport 用户护照
     * @return 更新网络磁盘应答
     */
    DiskUpdateResponse updateDisk(DiskUpdateRequest request, Passport passport);

    /**
     * 根据Id获取网络磁盘信息
     *
     * @param request 获取网络磁盘请求
     * @param passport 用户护照
     * @return 获取网络磁盘应答
     */
    DiskGetResponse getDisk(DiskGetRequest request, Passport passport);

    /**
     * 高级查询网络磁盘
     *
     * @param request 高级查询网络磁盘请求
     * @param passport 用户护照
     * @return 高级查询应答
     */
    DiskFindResponse findDisk(DiskFindRequest request, Passport passport);

    /**
     * 根据Id获取文件夹文件
     *
     * @param request 获取文件夹文件请求
     * @param passport 用户护照
     * @return 获取文件夹文件应答
     */
    FolderFileGetResponse getFolderFile(FolderFileGetRequest request, Passport passport);

    /**
     * 模糊查询文件夹文件
     *
     * @param request 模糊查询文件夹文件请求
     * @param passport 用户护照
     * @return 模糊查询文件夹文件应答
     */
    FolderFileSearchResponse searchFolderFile(FolderFileSearchRequest request, Passport passport);

    /**
     * 高级查询文件夹文件
     *
     * @param request 高级查询文件夹文件请求
     * @param passport 用户护照
     * @return 高级查询应答
     */
    FolderFileFindResponse findFolderFile(FolderFileFindRequest request, Passport passport);

    /**
     * 创建文件夹文件
     *
     * @param request 创建文件夹文件请求
     * @param passport 用户护照
     * @return 创建文件夹文件应答
     */
    FolderFileCreateResponse createFolderFile(FolderFileCreateRequest request, Passport passport);

    /**
     * 更新文件夹文件
     *
     * @param request 更新文件夹文件请求
     * @param passport 用户护照
     * @return 更新文件夹文件应答
     */
    FolderFileUpdateResponse updateFolderFile(FolderFileUpdateRequest request, Passport passport);

    /**
     * 移动文件夹文件
     * @param request   参数信息
     * @param passport  护照信息
     * @return          移动的结果
     */
    FolderFileMoveResponse moveFolderFile(FolderFileMoveRequest request, Passport passport);

    /**
     * 删除文件夹文件
     *
     * @param request 删除文件夹文件请求
     * @param passport 用户护照
     * @return 删除文件夹文件应答
     */
    FolderFileDeleteResponse deleteFolderFile(FolderFileDeleteRequest request, Passport passport);

    /**
     * 根据Id获取文件夹信息
     *
     * @param request 获取文件夹请求
     * @param passport 用户护照
     * @return 获取文件夹应答
     */
    FolderGetResponse getFolder(FolderGetRequest request, Passport passport);

    /**
     * 模糊查询文件夹
     *
     * @param request 模糊查询文件夹请求
     * @param passport 用户护照
     * @return 模糊查询文件夹应答
     */
    FolderSearchResponse searchFolder(FolderSearchRequest request, Passport passport);

    /**
     * 高级查询文件夹
     *
     * @param request 高级查询文件夹请求
     * @param passport 用户护照
     * @return 高级查询应答
     */
    FolderFindResponse findFolder(FolderFindRequest request, Passport passport);

    /**
     * 创建文件夹
     *
     * @param request 创建文件夹请求
     * @param passport 用户护照
     * @return 创建文件夹应答
     */
    FolderCreateResponse createFolder(FolderCreateRequest request, Passport passport);

    /**
     * 更新文件夹
     *
     * @param request 更新文件夹请求
     * @param passport 用户护照
     * @return 更新文件夹应答
     */
    FolderUpdateResponse updateFolder(FolderUpdateRequest request, Passport passport);

    /**
     * 移动文件夹
     * @param request   参数信息
     * @param passport  护照信息
     * @return          移动的结果
     */
    FolderMoveResponse moveFolder(FolderMoveRequest request, Passport passport);

    /**
     * 删除文件夹
     *
     * @param request 删除文件夹请求
     * @param passport 用户护照
     * @return 删除文件夹应答
     */
    FolderDeleteResponse deleteFolder(FolderDeleteRequest request, Passport passport);

    MessageCreateResponse createMessage(MessageCreateRequest messageCreateRequest, Passport passport);

    /**
     * 获取附件列表
     *
     * @param req      获取附件列表请求
     * @param passport 用户护照
     * @return 附件列表应答
     */
    AttachmentGetByBizInfoResponse getAttachmentsByBizInfo(AttachmentGetByBizInfoRequest req, Passport passport);

    /**
     * 绑定附件和文件ID
     * @param req
     * @param passport
     * @return
     */
    AttachmentUploadByFileIdResponse uploadAttachmentByFileId(AttachmentUploadByFileIdRequest req, Passport passport);


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

    /**
     * 批量获取文件路径
     *
     * @param request
     * @param passport
     * @return
     */
    FilePathListGetResponse getFilePathList(FilePathListGetRequest request,Passport passport);

}