com.seeyon.apps.plan.api

接口 PlanApi

所有已知实现类:

AbstractPlanApi

public interface PlanApi

Title: 计划接口

Description: 计划接口

Plugin:plan

Copyright: Copyright (c) 2012

Company: seeyon.com

从以下版本开始:

CTP2.0

方法概要

限定符和类型	方法和说明
void	deletePlanRefRelationsBySourceIds(java.util.List<java.lang.Long> sourceIds) 根据来源id集合删除计划参照关系 正常: 1、传入参照了其他计划的计划来源id集合，能删除计划的参照关系 2、传入参照了任务的计划来源id集合，能删除计划的参照关系 3、传入参照了会议的计划来源id集合，能删除计划的参照关系
void	deletePlanRefRelationsByToIds(java.util.List<java.lang.Long> toIds) 根据自身业务id集合删除计划参照关系 正常: 1、传入参照了其他计划的参照关系id集合，能删除计划的参照关系 2、传入参照了任务的参照关系id集合，能删除计划的参照关系 3、传入参照了会议的参照关系id集合，能删除计划的参照关系
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	findOtherPlanByMembers(java.util.List<java.lang.Long> memberIds, java.util.Date startDate, java.util.Date endDate, java.util.List<java.lang.String> states) 获取当前登录人员参与的他人计划(memberIds创建,当前登录人员参与的计划) 正常: 1、传入正确的人员id、状态、开始时间小于结束时间且时间段内有任务，返回会议列表 2、传入正确的人员id、状态、开始时间小于结束时间且时间段内无任务，返回空会议列表（返回size=0的list实体） 异常: 3、所有参数传入null，抛异常
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	findPartPlanByMembers(java.util.List<java.lang.Long> memberId, java.util.Date beginDate, java.util.Date endDate, java.util.List<java.lang.String> states) 获取人员参与的计划(我是主送或者抄送人员) 正常: 1、传入正确的人员id、开始时间小于结束时间且时间段内有计划，返回计划列表 2、传入正确的人员id、开始时间小于结束时间且时间段内无计划，返回空计划列表（返回size=0的list实体） 异常: 3、所有参数传入null，抛异常
java.util.List<PlanBO>	findPlans4Calendar(java.lang.Long memberId, java.util.Date beginDate, java.util.Date endDate, java.util.List<java.lang.String> states) 获取时间视图中的计划 正常: 1、传入正确的人员id、开始时间小于结束时间且时间段内有计划，返回计划列表 2、传入正确的人员id、开始时间小于结束时间且时间段内无计划，返回空计划列表（返回size=0的list实体） 异常: 3、所有参数传入null，抛异常
java.util.List<PlanBO>	findPlans4Project(java.lang.Long memberId, java.lang.Long projectId, java.lang.Long phaseId, java.lang.Integer size) 获取项目的计划 正常: 1、传入正确的人员id、项目id、阶段id为空、条数为5（计划条数大于5），返回前5条所有项目阶段计划列表 2、传入正确的人员id、项目id、阶段id为空、条数为5(计划条数不足5)，返回所有计划 异常: 3、有参数传入null，抛异常
java.util.List<PlanBO>	findPlans4Relate(java.lang.Long memberId, java.lang.Long relateId, java.lang.Integer size) 获关联人员的计划 正常: 1、所有参数传入正确值且关联人员有计划、条数为5(计划条数大于5)，返回前5条计划列表 2、所有参数传入正确值且关联人员有计划、条数为5(计划条数不足5)，返回所有计划 3、所有参数传入正确但关联人员没有计划，返回空 异常: 4、所有参数传入null，抛异常
java.util.List<PlanBO>	findProjectPlanByCondition(java.lang.Long memberId, java.lang.Long projectId, java.lang.Long phaseId, java.lang.String conditionType, java.lang.String conditionValue) 获取项目对应的计划列表 正常: 1、传入正确的人员id、项目id、项目阶段id、查询条件类型、查询条件的内容匹配对应计划，返回该项目该阶段所需查询的计划列表 2、传入正确的人员id、项目id、项目阶段id、查询条件类型为空字符、查询条件的内容为空字符，返回该项目该阶段所有计划列表 3、传入正确的人员id、项目id、项目阶段id值为1、查询条件类型为空字符、查询条件的内容为空字符，返回项目下所有计划列表 4、传入正确的人员id、项目id、项目阶段id、查询条件类型、查询条件的内容找不到匹配的计划，返回空计划列表（返回size=0的list实体） 异常: 5、所有参数传入null值，抛异常
PlanBO	getPlan(java.lang.Long id) 获取计划 正常: 1、传入正确的计划id，能获取到计划的实体
boolean	hasViewPermission(java.lang.Long memberId, java.lang.Long planId) 判断人员是否有计划的查看权限 正常: 1、传入正确的人员id、计划id且该人员在计划发送范围，返回true 2、传入正确的人员id、计划id且该人员是计划发起人，返回true 3、传入正确的人员id、计划id且该人员不是计划发起人也不是计划发送范围内人员也不是计划查询模板管理员，返回false 异常: 4、所有参数传入null，抛异常
void	sendPlanTransferOtherMessage(java.lang.Integer tranType, java.lang.Long planId, java.lang.Long objectId, java.lang.String title) [计划转其它模块]发送消息 如：计划转日程事件、计划转任务 正常: 1、模块id传入日程、其他参数传入正确值，成功发送计划转日程消息,不抛出异常即可 2、模块id传入任务、其他参数传入正确值，成功发送计划转任务消息,不抛出异常即可 异常: 3、所有参数传入null，抛异常

方法详细资料

getPlan

PlanBO getPlan(java.lang.Long id)
        throws com.seeyon.ctp.common.exceptions.BusinessException

获取计划
正常:
1、传入正确的计划id，能获取到计划的实体

参数:

id - 需要获取计划的id

返回:

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

findPlans4Relate

java.util.List<PlanBO> findPlans4Relate(java.lang.Long memberId,
                                        java.lang.Long relateId,
                                        java.lang.Integer size)
                                 throws com.seeyon.ctp.common.exceptions.BusinessException

获关联人员的计划
正常:
1、所有参数传入正确值且关联人员有计划、条数为5(计划条数大于5)，返回前5条计划列表
2、所有参数传入正确值且关联人员有计划、条数为5(计划条数不足5)，返回所有计划
3、所有参数传入正确但关联人员没有计划，返回空
异常:
4、所有参数传入null，抛异常

参数:

memberId - 人员id

relateId - 关联人员id

size - 条数

返回:

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

findPlans4Project

java.util.List<PlanBO> findPlans4Project(java.lang.Long memberId,
                                         java.lang.Long projectId,
                                         java.lang.Long phaseId,
                                         java.lang.Integer size)
                                  throws com.seeyon.ctp.common.exceptions.BusinessException

获取项目的计划
正常:
1、传入正确的人员id、项目id、阶段id为空、条数为5（计划条数大于5），返回前5条所有项目阶段计划列表
2、传入正确的人员id、项目id、阶段id为空、条数为5(计划条数不足5)，返回所有计划
异常:
3、有参数传入null，抛异常

参数:

projectId - 项目id

phaseId - 阶段id

size - 条数条数

返回:

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

findProjectPlanByCondition

java.util.List<PlanBO> findProjectPlanByCondition(java.lang.Long memberId,
                                                  java.lang.Long projectId,
                                                  java.lang.Long phaseId,
                                                  java.lang.String conditionType,
                                                  java.lang.String conditionValue)
                                           throws com.seeyon.ctp.common.exceptions.BusinessException

获取项目对应的计划列表
正常:
1、传入正确的人员id、项目id、项目阶段id、查询条件类型、查询条件的内容匹配对应计划，返回该项目该阶段所需查询的计划列表
2、传入正确的人员id、项目id、项目阶段id、查询条件类型为空字符、查询条件的内容为空字符，返回该项目该阶段所有计划列表
3、传入正确的人员id、项目id、项目阶段id值为1、查询条件类型为空字符、查询条件的内容为空字符，返回项目下所有计划列表
4、传入正确的人员id、项目id、项目阶段id、查询条件类型、查询条件的内容找不到匹配的计划，返回空计划列表（返回size=0的list实体）
异常:
5、所有参数传入null值，抛异常

参数:

memberId - 人员id

projectId - 项目id

phaseId - 项目阶段ID

conditionType - 查询条件类型（title、creater、date_time）

conditionValue - 查询条件内容（xxxxx、xxxxxxx、2015-08-11,2015-08-15）

返回:

项目计划列表

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

findPlans4Calendar

java.util.List<PlanBO> findPlans4Calendar(java.lang.Long memberId,
                                          java.util.Date beginDate,
                                          java.util.Date endDate,
                                          java.util.List<java.lang.String> states)
                                   throws com.seeyon.ctp.common.exceptions.BusinessException

获取时间视图中的计划
正常:
1、传入正确的人员id、开始时间小于结束时间且时间段内有计划，返回计划列表
2、传入正确的人员id、开始时间小于结束时间且时间段内无计划，返回空计划列表（返回size=0的list实体）
异常:
3、所有参数传入null，抛异常

参数:

memberId - 人员id

beginDate - 开始时间

endDate - 结束时间

states - 计划的状态(计划状态:1.未开始 2.进行中 3.已完成 4.已取消 5.已推迟 PlanStatusEnum)

返回:

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

hasViewPermission

boolean hasViewPermission(java.lang.Long memberId,
                          java.lang.Long planId)
                   throws com.seeyon.ctp.common.exceptions.BusinessException

判断人员是否有计划的查看权限
正常:
1、传入正确的人员id、计划id且该人员在计划发送范围，返回true
2、传入正确的人员id、计划id且该人员是计划发起人，返回true
3、传入正确的人员id、计划id且该人员不是计划发起人也不是计划发送范围内人员也不是计划查询模板管理员，返回false
异常:
4、所有参数传入null，抛异常

参数:

memberId - 人员id

planId - 计划id

返回:

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

deletePlanRefRelationsBySourceIds

void deletePlanRefRelationsBySourceIds(java.util.List<java.lang.Long> sourceIds)
                                throws com.seeyon.ctp.common.exceptions.BusinessException

根据来源id集合删除计划参照关系
正常:
1、传入参照了其他计划的计划来源id集合，能删除计划的参照关系
2、传入参照了任务的计划来源id集合，能删除计划的参照关系
3、传入参照了会议的计划来源id集合，能删除计划的参照关系

参数:

sourceIds - 来源id集合

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

deletePlanRefRelationsByToIds

void deletePlanRefRelationsByToIds(java.util.List<java.lang.Long> toIds)
                            throws com.seeyon.ctp.common.exceptions.BusinessException

根据自身业务id集合删除计划参照关系
正常:
1、传入参照了其他计划的参照关系id集合，能删除计划的参照关系
2、传入参照了任务的参照关系id集合，能删除计划的参照关系
3、传入参照了会议的参照关系id集合，能删除计划的参照关系

参数:

toIds - 自身业务id集合，即参照关系id

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

sendPlanTransferOtherMessage

void sendPlanTransferOtherMessage(java.lang.Integer tranType,
                                  java.lang.Long planId,
                                  java.lang.Long objectId,
                                  java.lang.String title)
                           throws com.seeyon.ctp.common.exceptions.BusinessException

[计划转其它模块]发送消息
如：计划转日程事件、计划转任务
正常:
1、模块id传入日程、其他参数传入正确值，成功发送计划转日程消息,不抛出异常即可
2、模块id传入任务、其他参数传入正确值，成功发送计划转任务消息,不抛出异常即可
异常:
3、所有参数传入null，抛异常

参数:

tranType - 其它模块枚举类型com.seeyon.apps.plan.enums.TransferTypeEnum

planId - 计划ID

objectId - 其它模块ID（如转日程则传日程的ID，转任务则传任务的ID）

title - 所转模块的标题

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

findPartPlanByMembers

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> findPartPlanByMembers(java.util.List<java.lang.Long> memberId,
                                                                                       java.util.Date beginDate,
                                                                                       java.util.Date endDate,
                                                                                       java.util.List<java.lang.String> states)
                                                                                throws com.seeyon.ctp.common.exceptions.BusinessException

获取人员参与的计划(我是主送或者抄送人员)
正常:
1、传入正确的人员id、开始时间小于结束时间且时间段内有计划，返回计划列表
2、传入正确的人员id、开始时间小于结束时间且时间段内无计划，返回空计划列表（返回size=0的list实体）
异常:
3、所有参数传入null，抛异常

参数:

memberIds - 人员id

beginDate - 开始时间

endDate - 结束时间

states - 计划的状态(计划状态:1.未开始 2.进行中 3.已完成 4.已取消 5.已推迟 PlanStatusEnum)

返回:

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

findOtherPlanByMembers

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> findOtherPlanByMembers(java.util.List<java.lang.Long> memberIds,
                                                                                        java.util.Date startDate,
                                                                                        java.util.Date endDate,
                                                                                        java.util.List<java.lang.String> states)

获取当前登录人员参与的他人计划(memberIds创建,当前登录人员参与的计划)
正常:
1、传入正确的人员id、状态、开始时间小于结束时间且时间段内有任务，返回会议列表
2、传入正确的人员id、状态、开始时间小于结束时间且时间段内无任务，返回空会议列表（返回size=0的list实体）
异常:
3、所有参数传入null，抛异常

参数:

memberIds - 人员id集合

beginDate - 开始时间

endDate - 结束时间

states - 状态 ({计划状态:1.未开始 2.进行中 3.已完成 4.已取消 5.已推迟 @link com.seeyon.apps.plan.enums.PlanStatusEnum})

返回:

抛出:

com.seeyon.ctp.common.exceptions.BusinessException