模块设计说明书.docx

《模块设计说明书.docx》由会员分享，可在线阅读，更多相关《模块设计说明书.docx（23页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、文档编号文档版本密级拟 制 人日期CPATEST注册会计师考试管理系统模块设计说明书331004保存新增免试信息功能保存新增免试人员信息输入case ID331004objFormuserFormuserFormOb ject 序号类型对象1ExamFreeInIandExtFo rm免试考生信息输出.ArrayList序号类型对象0True/faIse1String成功/失败信息331005保存修改免试人员信息功能保存修改输入case ID331005objFormuserFormObject 序号类型对象1ExamFreeInIandExtForm免试考生信息23输出ArrayList序号

2、类型对象0True/faIse1String成功/失败信息331006删除免试人员信息功能删除免试人员信息输入case ID331006objFormuserForm331007上报免试申请数据Ob ject 序号类型对象1String免试记录Guid字符 串，组织规则：Gu i dGu i d输出ArrayList序号类型对象0True/faIse1String成功/失败信息功能上报免试申请数据输入case ID331007objFormuserFormObject 序号类型对象1Str i ng免试记录Guid字符串，组织规则：Gu i dGu i d23输出ArrayList序号类型对象

3、0True/faIse1Str i ng成功/失败信息833001接收考区免试申请数据功能接收考区输入case ID833001objFormuserFormObject 序号类型对象1Fi IeTxt加密文件输出ArrayList序号类型对象0True/faIse1String成功/失败信息833002下发考区4后台设计功能免试审批数据下发输入case ID833002objFormuserFormObject 序号类型对象1String当前年度输出ArrayList序号类型对象0Fi IeZip加密文件14.1 类设计模块类图模块类说明 InFreeMngBO: 免试申请管理B0 （境内申

4、请免试管理） OutFreeMngBO:对内豁免登记管理B0（境外申请境内免试管理）4. 2免试申请管理类（InFreeMngBO）4. 2.1/* 331001*查询免试数据* param year办理年度* param orgCode 机构代码* param nameCn 中文姓名* param idcard18 证件号码* param auditCode 审批状态* return ArrayList (ExamFreeInIandExtForm)* /pub Iic ArrayLi st getFreeInIandL i st(Str i ng year, Str i ng orgCod

5、e, Str i ng nameCn, Str i ng i dcard18,Str i ng aud i tCode);1、业务SQIFrom ExamFreeInIandExtForm freeWhere 1=1And free. nameCn I ike %中文姓名And free, idcard 二证件号码And free.auditCode=, auditCodeAnd free.orgCode Iike orgCode%And free.annual=year1注意：1）如果机构代码为00则，机构条件部分改为小于99 2）如果年度为00,则年度条件部分修改为小于等于当前年度 4）如

6、果处罚选项代码为00,则去掉处罚选项代码过滤条件331001 getFreeInlandList4.2.1 331002 getFreeInlandByGuid/* 331002*获得免试考生信息* param fiGuidreturn ExamFreeInIandExtForm 免试人员信息*/pub Iic ExamCheatRecordExtForm getFreeInIandByGu i d (Str i ng fiGuid)；1、 调用平台通过ID获得对象方法实现2、 转一下form中的代码4. 2.1331003 patchFreeInfoByIdcard/* 331003*定位免

7、是考生信息* param orgCode 机构代码* param nameCn 中文姓名* param cardtypeCode 证件类型* param idcard18 证件号码* return ArrayList (ExamFreeInIandExtForm)* /pub Iic ExamFreeInIandExtForm patchFreeInfoByIdcard (Str i ng orgCode,String nameCn, Str i ng cardtypeCode, Str i ng i dcard18);1、从境内免试审批表中定位考生信息，业务SQLFrom ExamFreeI

8、nIandExtForm freeWhere 1=1And free. nameCn I ike 中文姓名And free. idcard18 二 证件号码And free.orgCode 99And free.annua I Ii ke orgCode%Order by free.annua I desc2、如果1中查到以往年度考生免试数据则直接返回考生最近一年的免试信 息，否则通过以下SQL从报名信息表中获取免试考生信息，业务SQLFrom ExamRegExamee regWhere 1=1And reg. nameCn I ike 中文姓名And reg. idcard18 =证件号码

9、And reg.orgCode Ii ke orgCode%And reg. annua I 二当前年度Order by free.annua I desc3、如果2中找到考生报名信息，则将考生最近一年的报名信息转化为免试审 批form信息返回，否则返回NULL4. 2.1331004 saveNewFreeInfo/* * 331004*保存免试考生申请信息* param free Info* return ArrayList (0 true/f lase 1 成功/错误信息)*/pub Iic ArrayLi st saveNewFreeInfo (ExamFreeInIandExtFor

10、m free Info);1、保存考生免试申请信息，关键信息存储设置如下：年度;当前年度序号二自动生成，同一个省统一年度不能重复唯一编号、免试人员照片，从历史数据中获取一个考生只能免试一个科目注销状态二未注销审批状态二未上报预审状态二未审核4. 2.1331005 saveNewFreeInfo/* 331005* 保存修改的免试考生申请信息* param free Info* return ArrayList (0 true/f lase 1 成功/错误信息)*/pub Iic ArrayL i st saveFreeInfo(ExamFreeInIandExtForm free Info)

11、;1、 通过免试Gu i d获得免试考生申请信息2、 将修改的字段更新入库4. 2.1331006 removeFreeInfo/* 331006*删除免试考生申请信息* param fiGuidStr 组织格式fiGuidfiGuidfiGuid* return ArrayList (0 true/f Iase 1 成功/错误信息)*/pub Iic ArrayLi st removeFreeInfo(Str i ng fiGuidStr)；1、 只有未上报的免试申请考生信息才允许删除。2、 通过原生SQL删除免试考生信息4. 2.133100刀 getCheatRecL i st/* 33

12、1007*上报免试考生申请信息* param f iGuidStr 组织格式f iGuidf iGuidf iGuidreturn ArrayList (0 true/f lase 1 成功/错误信息) */pub Iic ArrayLi st saveRpFreeInfo(Str i ng fiGuidStr)；只有未上报的免试申请考生信息才允许上报。T2、通过原生SQL上报免试申请信息4. 2.1833001 save ImpFreeInfoData/* 833001* 导入考区上报的免试申请数据* param File考区上报的文件* return ArrayLi st (0 true/

13、fa I se 1 操作结果)* /pub Iic ArrayLi st savaImpFreeInfoData(Fi Ie freelnfoFi Ie);1、 解压缩2、 解密3、 准备导入文件，只需要省级没有上报的免试申请数据，对于省级已经存在的免试数据进行部分更新。4、 导入文件4. 2,1833002 expFreeInfoData/* 833002* 导出指定年度省级审批数据* param year 年度* param orgCode 机构代码* return Ar rayL i st (ExamFreeInIandExtForm)* /pub Iic List expFreeInf

14、oData (Str i ng year,Str i ng orgCode);业务SQLFrom ExamFreeInI and freeWhere 1=1And free.orgCode I ike orgCode%And free, annual=1 year文档编码密级文档版本拟 制 人日期项目编号和项目名称设计说明书其他如副标题/子模块变更说明日期版本变更位置变更说明作者变更履历版本日期变更位置变更理由/变更内容变更人备注1.0创建目录1 概述32 总体设计33 模块1设计（模块唯一编号）3子模块1设计（模块唯一编号）33. 1. 1模块概述33. 1.2类图33. 1.3调用关系/时

15、序图41.4类及接口设计53.2子模块2设计（模块唯一编号）62. 1模块概述61.1.1 类图6调用关系/时序图61.1.2 类及接口设计6【重要提示】本文档的目录结构应与需求规格说明书一一对应。5概述描述该功能的主要设计目标和设计思路，对设计部分的内容做一个简要的说明。6总体设计总体设计针对所有不能归入任何一个模块的功能进行设计，可以分节进行描述： 对于较为复杂的模块，可以使用模块架构图来说明模块的整体框架结构，以方 便阅读者直观地理解模块的体系架构 从总体上描述所有功能模块应遵循的规则。例如模块划分的原则等。 代码的目录结构 性能方面的设计：例如数据缓冲的设计等 安全性方面的设计 扩展性

16、方面的设计 稳定性方面的设计 模块1设计（模块唯一编号）7.1 子模块1设计（模块唯一编号）7.1.1 模块概述对模块1的设计进行概要描述，主要有设计思路、主要原理、设计目标等。7.1.2 类图描述所有类之间的关联、继承、依赖等关系。可以使用UML类图的规则来绘制（推荐使用VisuaIPraradigm或Rat ionaI Rose工具进行绘制）。类图中出现的现有 系统中已经实现的类，可以不用体现类中具体的属性和方法，对于本模块设计的类必 须体现类中publ ic类型的所有方法及属性（属性的get和set方法可以省略）。如 果类比较多，可以分多个类图进行绘制。类图以图片的形式插入本文档，同时保

17、留与 本文档同名的类图文件作为附件，以便修改。NewClass2瓜IIIDeperidencyInterface7.1.3 调用关系/时序图注：调用关系/时序的技术原则为实用原则，即对于不言而喻的调用关系/时序图 可以不必描述，例如简单的增、册1改操作，这里只需描述调用关系较为复杂的时 序。7.1.3.1 时序图1描述一个完整的业务功能操作的处理流程，通过类之间的调用关系流程来体现程 序的执行顺序。可以使用UML时序图的规则来绘制（推荐使用VisualPramdigm或 Rational Rose工具进行绘制）。时序图中对现有系统中已经实现的类的调用，可以 不用体现类中被调用方法的具体参数，对

18、于本模块设计的类的调用，则必须体现类中 所有方法的调用参数及类型。时序图以图片的形式插入本文档，同时保留与本文档同 名的时序图文件作为附件，以便修改。注：需要先描述此时序图发生的场景以便于理 解，例如“点击生成按钮触发此时序图”。例：7.1.3.2 时序图2同时序17.1.1 类及接口设计7.1.4.1 基础类1基础类的设计，可以使用UML类图来描述，或者使用类定义的伪代码来描述，描 述时要注意把类属性的含义、类型、约束、方法、参数等描述清楚，如果涉及到持久 化（存储），需要描述其存储方式（文件、数据库、注册表等等）、数据表、文件、 位置等等。如果涉及到较为复杂的数据库读写，需要将该SQL写出

19、来，SQL中的关键 字以蓝色标识，参数以紫色标识。例如：seIect * from eai_reportgroupwhere rgp_pgu i d=rgpGu idorder by rgp_order7.1.4.2 基础类27.1.4.3 接口 17.1.4.4 接口 27.2 子模块2设计（模块唯一编号）7. 2.1模块概述7.2.1 类图7. 2.1 调用关系/时序图7. 2. 3.1时序图17. 2. 3. 2时序图27. 2. 3. 3类及接口设计7. 2. 3. 4基础类17. 2. 3. 5基础类27. 2. 3.6 接口 1723.7接口 21 FORM 设计51. 1教材管理

20、51教材信息扩展Form51.1. 1教材定购信息扩展Form51时间设置扩展Form51.2. 1费用设置扩展Form62前台设计62. 1模块规划62.1. 110公用方法62. 1初始化机构树62.2. 111教材管理61获取本年度教材列表62.3. 1新增教材71修改教材72.4. 1删除教材72.4112教材订购管理71初始化教材订购管理72.5. 1获取教材预订信息71修改教材预订信息82.5113考务时间设置81初始化时间设置界面82.6. 1保存时间设置82.6114收费标准设置81初始化收费标准设置界面82.7. 1保存收费标准设置82.7811初始化数据导出91初始化数据导

21、出记录92.8. 1导出初始化数据93 SERVICE 接口93. 1系统公用方法93.1. 111000教材管理101111001获取本年度教材列表103.2. 1111002新增教材101111003修改教材103.3. 1111004删除教材113.3112000教材预订管理111112001获取教材预订信息113.4. 1112002修改教材预订信息113.4113000考务时间设置121113001初始化时间设置界面123.5. 1113002保存考务时间设置121113003保存考试时间设置123.5114000收费标准设置131114001初始化收费标准133.6. 111400

22、2保存收费标准133. 6811000初始化数据导出1411811001初始化数据导出记录列表143.7. 1811002导出初始化数据144 后台设计144. 1类设计144. 1. 1模块类图144. 1. 1模块类说明144.2教材管理类(TextbookBO)154. 2. 1111001 getTextbooxByL i st 154. 2. 1111002 savaNewTextbook 154. 2. 1111003 saveTextbook 154.2. 1111004 de I Textbook 164. 2. 1112001 getTextbookOrderI nfo 16

23、4. 2. 1112002 saveTextbookOrder I nfo 164.3系统管理类(SysMngBO) 174.3. 1113001 getDateSet 174. 3. 1113002saveExamWorkDateSet 174.3. 1114001getAI ICostOfExam 184. 3. 1114002saveCostOfExam 181 Form设计免试管理1.1.1 境内免试审批扩展Form境外免试审批扩展FormAct ionForm 标识ExamFreeInIandExtForm功能说明：境内免试审批扩展Form字段类型字段名称字段含义默认值备注ExamF

24、ree I n I andForm 所有字段Str i ngOrgName机构名称1.1.1 境外协会信息扩展FormAct i onForm 标识ExamFreeOutIandExtForm功能说明：境外免试审批扩展Form字段类型字段名称字段含义默认值备注ExamFreeOut I andForm 所有字段Str ingOrgName机构名称境外协会豁免协议扩展FormAct i onForm 标识ExamFreeOutascExtForm功能说明：境外协会信息扩展Form字段类型字段名称字段含义默认值备注ExamFreeOutascForm 所有字段StringOrgName机构名称Ac

25、t ionForm 标识ExamFreeAgreeExtForm功能说明：境外协会豁免协议扩展Form字段类型字段名称字段含义默认值备注ExamFreeAgreeForm 所有字段StringfoaName境外协会名称StringfoaCode境外协会代码Str i ngfoaNameE n境外协会英文名称StringvaIi dNam e有效名称2前台设计2 . 1模块规划:com. j i uq i. cpatest:web/app/bnscontent2.2331免试申请管理菜单资源Act i on类名Web目录备注免试申请 管理. act i on. freemng. InFreeAc

26、t i on. java/free对内豁免登记. act i on. freemng. OutFreeAct i on .java/free中注协豁免协议 管理.act i on. freemng. AgreeMngAct i on. java/free2.2.1 初始化调用编号331001情景说明初始化查询结果，无需分页（默认年度）2.2.1 查询调用编号331001情景说明查询免试人员，无需分页2. 2.1 查看人员信息调用编号331002情景说明查看免试人员信息1. 2.1 新增调用331003定位免试考生信息，调用331004保存新增免试人员信息。2. 2.1 修改调用331002获取

27、修改免试人员信息，调用331005报名修改的免试人员信息。3. 2.1 删除调用331006删除/批量删除考生免试人员信息。4. 2.1 上报调用331007上报/批量上报免试人员信息。5. 2. 1 接收考区调用833001显性导入考区免试人员信息。6. 2.1 下发考区调用833002显性导出本省当年审批免试人员信息。7. 2.1 打印申请表调用331002查询免试人员信息，打印免试申请表8. 2.1 导出、打印导出、打印当前页面数据即可。9. Service 接口331免试申请管理9.1.1 331001查询免试申请数据功能查询免试申请输入case ID341001objFormuser

28、FormObject 序号类型对象1String办理年度2Str i ng机构代码3String姓名4Str i ng证件号码5String审批状态6输出ArrayList序号类型对象0ArrayLi stExamFreeInIandExtFor m331002查看免试考生信息功能查询免试考生信息输入case ID331002objFormuserFormObject 序号类型对象1String免试guid输出.ArrayList序号类型对象0ExamFreeInIandExtFo rm免试考生信息331003定位免试考生数据功能定位免试考生信息输入case ID331003objFormuserFormObject 序号类型对象1String姓名2String证件类型3String证件号码4String机构代码输出ArrayList序号类型对象0ExamFreeInIandExtForm免试考生信息1Str i ng考生审核信息