接口设计说明_QXPT (2).doc

QXPT2.0接口详细设计说明书总页数生效日期： 年 月 日编制：审核：批准：目录1.概述11.1目标11.2使用对象11.3接口设计说明12.接口详细设计22.1制定校历22.1.1数据接口122.1.2数据接口222.2教学进度22.3教学反思21. 概述 1.1 目标通过前端开发人员和后端开发人员共同约定接口设计规范，提高前端和后端开发效率，降低开发过程中的沟通成本。同时也有利于公用接口的开发和代码的复用。1.2 使用对象编码开发人员。1.3 接口设计说明函数定义int addCDocument(string strYear,string strCodeID,string strSFClass) 功能说明对公文管理数据的新增 所在类 xxx.java 参数说明 strYear 年份 strCodeID 公文编号 strSFClass 公文类型 返回值说明 strID 判断语句执行是否成功，如果成功返回记录标识，不成功返回-1 数据格式：2. 接口详细设计2.1 制定校历 2.1.1 数据接口1函数定义：int addCDocument(string strYear,string strCodeID,string strSFClass)功能说明：对公文管理数据的新增所在包名：Package所在类名：xxx.java参数说明：1. strYear 年份 2. strCodeID 公文编号 3. strSFClass 公文类型返回值说明：strID 判断语句执行是否成功，如果成功返回记录标识，不成功返回-1数据格式：2.1.2 数据接口22.2 教学进度2.2.1 数据接口12.2.2 数据接口22.3 教学反思2.4 我的备课2.4.1 按教学计划查找对应的备课列表接口函数定义：List aa(String jhid)功能说明：通过教学计划id查找对应的备课列表所在包名：Package所在类名：xxx.java参数说明：1.jhid 教学计划id返回值说明：我的备课列表数据格式：List2.4.2 历史备课学年列表接口函数定义：List aa(String userid)功能说明：通过用户id查找已备课的学年列表（包含当前学年）所在包名：Package所在类名：xxx.java参数说明：1. Userid 用户id返回值说明：学年列表数据格式：List2.4.3 获取备课总课时并标示出当前可选课时及已选课时函数定义：Map aa(bkid)功能说明：通过我的已备课的id查找已备的课时及可选的课时所在包名：Package所在类名：xxx.java参数说明：1.备课时段ID返回值说明：备课的课时标示为key，可选标示、是否已选为value。例：(1,0)表示第一课时不可选（1,1）表示第一课时可选（1，2）表示已选数据格式：Map2.4.4 获取备课总课时以及可选课时函数定义：Map aa(String bkid)功能说明：通过备课id查找已选课时所在包名：Package所在类名：xxx.java参数说明：1.教学计划课题ID返回值说明：备课的课时标示为key，可选标示、是否已选为value。例：(1,0)表示第一课时不可选（1,1）表示第一课时可选（1，2）表示已选数据格式：Map2.4.5 保存备课接口函数定义：OpenResult add(PrepareLesson prepareLesson)功能说明：添加备课对象所在包名：Package所在类名：xxx.java参数说明：1.备课对象返回值说明：返回OpenResult数据格式：OpenResult2.4.6 获取资源接口函数定义：PageList aa(String lessoncode,String type,Boolean flag,Page page)功能说明：通过课程code查找资源所在包名：Package所在类名：xxx.java参数说明：1. lessoncode 课程code2. type 资源类型3. 是否查找优质资源4. Page对象返回值说明：返回资源的分页对象数据格式：PageList2.4.7 获取备课时段下的资源函数定义：PageList aa(String bkid,String type,Page page)功能说明：通过备课时段id查找对应资源所在包名：Package所在类名：xxx.java参数说明：1. 备课时段id2. 资源类型3. Page对象 返回值说明：返回对应资源的分页对象数据格式：PageList2.4.8 新增资源函数定义：OpenResult add(bkFile fkfile)功能说明：新增备课的各类型资源所在包名：Package所在类名：xxx.java参数说明：1.备课文件对象返回值说明：返回OpenResult数据格式：OpenResult2.4.9 删除资源接口函数定义：OpenResult delete(String zyid)功能说明：通过id删除对应的资源所在包名：Package所在类名：xxx.java参数说明：1.zyid 资源id返回值说明：返回OpenResult数据格式：OpenResult2.4.10 推送审查函数定义：OpenResult aa(String bkid)功能说明：通过备课id推送到上级审查所在包名：Package所在类名：xxx.java参数说明：1.bkid 备课id返回值说明：返回OpenResult数据格式：OpenResult2.4.11 通过id查找资源详细函数定义：bkFile aa(String bkid)功能说明：通过备课id查找资源对象所在包名：Package所在类名：xxx.java参数说明：1.bkid 备课id返回值说明：返回OpenResult数据格式：OpenResult2.4.12 通过我的备课id查找修改的按学时备课列