接口设计说明_QXPT

《接口设计说明_QXPT》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、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接口设计说明[函数定义]intaddCDocument(stringstrYear,stringstrCodeID,st

2、ringstrSFClass)[功能说明]对公文管理数据的新增[所在类]xxx.java[参数说明]strYear年份strCodeID公文编号strSFClass公文类型[返回值说明]strID判断语句执行是否成功，如果成功返回记录标识，不成功返回-1[数据格式]：第7页1.接口详细设计1.1制定校历1.1.1数据接口1函数定义：intaddCDocument(stringstrYear,stringstrCodeID,stringstrSFClass)功能说明：对公文管理数据的新增所在包名：Package所在类名：xxx.java参数说明：1.st

3、rYear年份2.strCodeID公文编号3.strSFClass公文类型返回值说明：strID判断语句执行是否成功，如果成功返回记录标识，不成功返回-1数据格式：1.1.2数据接口21.2教学进度1.2.1数据接口11.2.2数据接口21.3教学反思1.4我的备课1.4.1按教学计划查找对应的备课列表接口函数定义：Listaa(Stringjhid)第7页功能说明：通过教学计划id查找对应的备课列表所在包名：Package所在类名：xxx.java参数说明：1.jhid教学计划id返回值说明：我的备课列表数据格式：List1.1.1历史备课学年列表

4、接口函数定义：Listaa(Stringuserid)功能说明：通过用户id查找已备课的学年列表（包含当前学年）所在包名：Package所在类名：xxx.java参数说明：1.Userid用户id返回值说明：学年列表数据格式：List1.1.2获取备课总课时并标示出当前可选课时及已选课时函数定义：Mapaa(bkid)功能说明：通过我的已备课的id查找已备的课时及可选的课时所在包名：Package所在类名：xxx.java参数说明：1.备课时段ID返回值说明：备课的课时标示为key，可选

5、标示、是否已选为value。例：(1,0)表示第一课时不可选（1,1）表示第一课时可选（1，2）表示已选数据格式：Map第7页1.1.1获取备课总课时以及可选课时函数定义：Mapaa(Stringbkid)功能说明：通过备课id查找已选课时所在包名：Package所在类名：xxx.java参数说明：1.教学计划课题ID返回值说明：备课的课时标示为key，可选标示、是否已选为value。例：(1,0)表示第一课时不可选（1,1）表示第一课时可选（1，2）表示已选数据格式：Map

6、tring>1.1.2保存备课接口函数定义：OpenResultadd(PrepareLessonprepareLesson)功能说明：添加备课对象所在包名：Package所在类名：xxx.java参数说明：1.备课对象返回值说明：返回OpenResult数据格式：OpenResult1.1.3获取资源接口函数定义：PageListaa(Stringlessoncode,Stringtype,Booleanflag,Pagepage)功能说明：通过课程code查找资源所在包名：Package所在类名：xxx.java参数说明：1.lessonco

7、de课程code2.type资源类型第7页1.是否查找优质资源2.Page对象返回值说明：返回资源的分页对象数据格式：PageList1.1.1获取备课时段下的资源函数定义：PageListaa(Stringbkid,Stringtype,Pagepage)功能说明：通过备课时段id查找对应资源所在包名：Package所在类名：xxx.java参数说明：1.备课时段id2.资源类型3.Page对象返回值说明：返回对应资源的分页对象数据格式：PageList1.1.2新增资源函数定义：OpenResultadd(bkFilefkfile)功能说明：新增备

8、课的各类型资源所在包名：Package所在类名：xxx.java参数说明：1.备课文件对象返回