详细设计说明书1

卓越电信后付费AR缴费管理系统详细设计说明书2011.111 Detailed Design详细设计1.1类名 com.yctc.ar.data.bean.Cashbox 1.1.1Class Diagram类图1.1.2Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）private cashierId float操作员IDprivate initMoney float初始化金额private moneyAdd float调增的金额private moneyPaid float缴费的金额private moneyUp float上缴的金额private state boolean钱箱状态（0关闭；1开启）1.1.3 Methods方法各种set和get方法。

1.2类名 com.yctc.ar.data.been.Staff 1.2.1 Class Diagram类图1.2.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）private city String城市private dept String职位private id String职员ID private name String职员姓名private password String职员密码private post String岗位Private Releld Int角色1.2.3 Methods方法各种set和get方法。

1.3类名 com.yctc.ar.data.been.CashboxForm 1.3.1 Class Diagram类图1.3.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）private cashierId Float操作员IDprivate initMoney Float初始化金额private moneyAdd Float调增的金额private moneyPaid Float缴费的金额private moneyUp Float上缴的金额private password String主管密码private superiorID String主管IDprivate totalMoney String总金额private way Boolean调账方式（调增、调减）1.3.3 Methods方法无1.4类名 er 1.4.1 class diagram类图1.4.2 Attributes 属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）private account Float用户账户金额private balance Float余额private credit Float信用private deposit Float押金金额private idNumber String用户IDprivate oweMoney Float欠费金额private password String用户密码private telephone String用户手机号private userName String用户姓名1.4.3 Methods 方法各种get 和set方法1.5类名 erForm 1.5.1 class diagram类图1.5.2 Attributes 属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）private account Float用户账户金额private balance Float余额private credit Float信用private deposit Float押金金额private dueOfPay Float应缴最低金额private factOfFee Float实际缴费金额private idNumber String用户ID private oweMoney Float欠费金额private password String用户密码private remark String备注private telephone String用户手机号private userName String用户姓名private wayOfPay String缴费方式1.5.3 Methods 方法无1.6类名 com.yctc.ar.data.bean.DrawbackForm 1.6.1class diagram 类图1.6.2 Attributes 属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）private bussinessCIs String业务类型private drawbackCIs String回退类型private drawbackMoney Float回退金额private drawbackReason String回退原因private dueOfLeastPay Float应缴最低金额private endTime Date截止日期private isAddTime Boolean是否按时间查询（是、否）private queryContent String查询内容private queryWay String查询方式private remark String备注private startTime Date开始日期private userList Arraylist用户信息列表1.6.3 Methods 方法无1.7类名 com.yctc.ar.data.bean.MulQueryForm 1.7.1 class diagram 类图1.7.2Attribute 属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）private businessCIs String业务类型private endtime String截止日期private isAddTime Boolean是否按时间查询（是、否）private payLogList Arraylist缴费日志信息private queryContent String查询内容private queryWay String查询方式private serialNumber Int流水号private startTime Date开始日期private telephone String手机号码1.7.3 Methods 方法无1.8.1 class diagram 类图1.8.2 Attributes 属性Visibility 可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）private adjustCIs String调账方式private adjustMoney Float调账金额private adjustReason String调账原因private remark String备注private user User用户信息1.8.3 Methods 方法无1.9.1 class diagram 类图1.9.2 Attributes 属性Visibility 可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）private cityList List城市列表private deptList List部门列表private postList List职位列表private role String角色private staffList List职员列表1.9.3 Methds 方法各种get和set方法1.10类名 com.yctc.ar.data.dao.ICashboxDAO 1.10.1 Class Diagram类图1.10.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）private cashboxDAO ICashboxDAO数据处理层的单例对象1.10.3 Methods方法1) addAndTurnOverMoney ()Method Descriptions方法描述Prototype 函数原型public boolean addAndTurnOverMoney ()Description 功能描述调增或上缴金额Calls 调用函数无Called By 被调用函数无Input 输入参数CashboxOutput 输出参数isSuccessReturn 返回值boolean类型值Exception 抛出异常无2) public boolean addAndTurnOverMoney();3) closeCashbox()Method Descriptions方法描述Prototype 函数原型public boolean closeCashbox ()Description 功能描述关闭钱箱Calls 调用函数无4)public boolean close Cashbox();5) getInstance()public Cashbox getInstance(); openCashbox()1)Method Descriptions方法描述2)public boolean openCashbox() queryCashboxDetails()Method Descriptions方法描述Public Cashbox querCashboxDetails();1.11类名 com.yctc.ar.service.cashbox.CashboxService 1.11.1 Class Diagram类图1.11.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）private cashboxDAO ICashboxDAO数据处理层的单例对象Private staffDAO ISfaffDAO数据处理层的单例对象1.11.3 Methods方法addAndTurnOverMoney ()Method Descriptions方法描述Prototype 函数原型public boolean addAndTurnOverMoney ()Description 功能描述调增或上缴金额Calls 调用函数无Called By 被调用函数无Input 输入参数cashboxOutput 输出参数isSuccessReturn 返回值boolean类型值Exception 抛出异常无public boolean addAndTurnOverMoney(){//1.通过IStaffDAO类的对象获取该用户信息并完成身份验证判断//2.通过ICashboxDAO类的对象调用//3.addAndTurnOverMoney方法完成调增和上缴操//作//4.成功返回true失败返回fault}closeCashbox()1).Method Descriptions方法描述Prototype 函数原型public boolean closeCashbox ()Description 功能描述关闭钱箱Calls 调用函数无Called By 被调用函数无Input 输入参数cashboxOutput 输出参数isSuccessReturn 返回值boolean类型值Exception 抛出异常无2)public boolean close Cashbox(){//1. 通过IStaffDAO类的对象获取该信息并完成身份验证判断//2. 通过ICashbox类的对象调用//3. closeCashbox方法完成关闭钱箱操作//4. 成功返回true失败返回fault}openCashbox()1)Method Descriptions方法描述Prototype 函数原型public boolean openCashbox ()Description 功能描述打开钱箱Calls 调用函数无Called By 被调用函数无Input 输入参数cashboxOutput 输出参数无Return 返回值isSuccessException 抛出异常无2)public boolean openCashbox(){//1.通过IStaffDAO类的对象获取该用户信息并完成身份验证判断//2.通过ICashbox类的对象调用//3. openCashbox方法完成打开钱箱操作//4. 成功返回true失败返回fault}1.12类名com.yctc.ar.web.cashbox.action.CashboxOpen Action1.12.1 Class Diagram类图1.12.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）private cashboxService ICashboxService业务逻辑层的单例对象1.12.3 Methods方法Public String exec(){// 1.通过cashboxService对象调用openCashbox方法打开钱箱}1.13类名com.yctc.ar.web.cashbox.action. Cashbox CloseAction1.13.1 Class Diagram类图1.13.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）private cashboxService ICashboxService业务逻辑层的单例对象1.13.3 Methods方法Public String exec(){//1. 通过cashboxService对象调用//2. closeCashbox方法打开钱箱}1.14类名com.yctc.ar.web.cashbox.action.CashboxAdjust Action1.14.1 Class Diagram类图1.14.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）private cashboxService ICashboxService业务逻辑层的单例对象1.14.3 Methods方法Public String exec(){//1. 通过cashboxService对象调用//2. addAndTurnOverMoney方法打开钱箱}1.15类名 com.yctc.ar.data.dao.AdjustDAO1.15.1 Class Diagram类图1.15.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）无无无无1.15.3 Methods方法public boolen adjustMinusDeposit (User user){//1 调减用户押金}public boolen adjustMinusBlance (User user){//1 调减用户预存款}public boolen adjustPlusBlance (User user){//1 调增用户押金}public boolen adjustPlusDeposit (User user){//1 调增用户预存款}public User getInstance(User user){//1 获取用户信息}1.16类名 com.yctc.ar.service.adjust.AdjustService 1.16.1 Class Diagram类图1.16.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）Private adjustDAO AdjustDAO数据处理层的单例对象1.16.3 Methods方法public boolen adjustMinusDeposit (User user){//1 通过数据处理层的单利对象调减用户押金}public boolen adjustMinusBlance (User user){//1 通过数据处理层的单利对象调减用户预存款}public boolen adjustPlusBlance (User user){//1 通过数据处理层的单利对象调增用户押金}public boolen adjustPlusDeposit (User user){//1 通过数据处理层的单利对象调增用户预存款}public User getInstance(User user){//1 通过数据处理层的单利对象获取用户信息}1.17类名 com.yctc.ar.web.adjust.action.AdjustAction 1.17.1 Class Diagram类图1.17.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）Private adjustService AdjustService业务逻辑层的单例对象1.17.3 Methods方法Public String exec(){//1 调用业务逻辑层对象完成调帐操作，//2 成功返回SUCCESS 错误返回ERROR}1.18类名 com.yctc.ar.service.pay.PaymentService 1.18.1 Class Diagram类图1.18.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）private paymentDAO IpaymentDAO数据处理层单例对象Private userDAO UserDAO数据处理层单例对象Private paymentLogDAO PaymentLogDAO数据处理层单例对象private cashboxLogDAO CashboxLogDAO数据处理层单例对象1.18.3 Methods方法Public Boolean doDeposit(){//1 修改用户余额//2 修改缴费金额//3 添加用户缴费日志//4 添加钱箱日志}Public Boolean doPayment{//1 修改用户余额//2 修改缴费金额//3 添加用户缴费日志//4 添加钱箱日志}1.19类名 com.yctc.ar.data.dao.PaymentDAO 1.19.1 Class Diagram类图1.19.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）无无无无1.19.3 Methods方法Public Boolean doDeposit(){//1 修改用户余额}Public Boolean doPayment{//1 修改用户余额}1.20类名 com.yctc.ar.web.pay.action.PaymentAction 1.20.1 Class Diagram类图1.20.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）private paymentService PaymentService业务逻辑层单例对象1.20.3 Methods方法Public String exec(){//1 调用业务逻辑层对象进行处理//2 成功返回success 错误返回error}1.21类名 com.yctc.ar.web.pay.action.DepositAction 1.21.1 Class Diagram类图1.21.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）private paymentService PaymentService业务逻辑层单例对象1.21.3 Methods方法Public String exec(){//1 调用业务逻辑层对象进行处理//2 成功返回success 错误返回error}1.22类名 com.yctc.ar.data.dao.MuiQueryDAO 1.22.1 Class Diagram类图1.22.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）无无无无1.22.3 Methods方法Public PayLog getInstance(){//1 获取单个对象}Public List<PayLog> query(){//1 获取记录列表}Public list<PayLog> queryBySerialNumber(){//1 通过流水号查找日志}Public list<PayLog> queryByTelephone(){//1 通过手机号获取日志记录列表}1.23类名 com.yctc.ar.service.query.MulQueryService 1.23.1 Class Diagram类图1.23.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）private muiQueryDAO MuiQueryDAO数据访问层单例对象1.23.3 Methods方法Public PayLog getInstance(){//1 获取单个对象}Public List<PayLog> query(){//1 查询满足条件的记录总个数//2 计算出总分页个数//3 获取指定页数的日志记录列表}Public list<PayLog> queryBySerialNumber(){//1 通过流水号查找日志}Public list<PayLog> queryByTelephone(){//1 查询满足条件的记录总个数//2 计算出总分页个数//3 获取指定页数的日志记录列表}1.24类名 com.yctc.ar.web.query.action. MulQueryAction 1.24.1 Class Diagram类图1.24.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）private muiQueryService MuiQueryService业务逻辑层单例对象1.24.3 Methods方法Public String exec(){//1 调用业务逻辑层获取列表}1.25类名 com.yctc.ar.data.dao.ManageDAO1.25.1 Class Diagram类图1.25.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）无无无无1.25.3 Methods方法public Boolean addNewstaff(Staff staff){//1 tb_staff表增加一条记录}public Boolean creatrCity(City city){//1 tb_city表增加一条记录}public Boolean createDept(Dept dept){//1 tb_dept表增加一条记录}Public List<City> findCityList(){}Public list<Dept> findDeptsByCity(City){}6）Public list<Staff> findeStaffsByDept(Dept){}1.26类名 com.yctc.ar.service.manage.ManageService 1.26.1 Class Diagram类图1.26.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）pricate manageDAO ManageDAO数据访问层单体实例1.26.3 Methods方法public Boolean addNewstaff(Staff staff){//1 tb_staff表增加一条记录}public Boolean creatrCity(City city){//1 tb_city表增加一条记录}public Boolean createDept(Dept dept){//1 tb_dept表增加一条记录}Public List<City> findCityList(){}Public list<Dept> findDeptsByCity(City){}Public list<Staff> findeStaffsByDept(Dept){}1.27类名 com.yctc.ar.web.manage.action.ManageAction 1.27.1 Class Diagram类图1.27.2 Attributes属性Visibility可见性Name 属性名称Type 类型Brief descriptions说明（对属性的简短描述）pricate manageService ManageService业务逻辑层单体实例1.27.3 Methods方法Public Sting exec(){//1 调用业务逻辑层并返回结果}（注：可编辑下载，若有不当之处，请指正，谢谢!）。

班级通讯录详细设计说明书目录目录 01引言 (1)1.1编写目的 (1)1.2背景 (1)1.3术语和缩写词 (1)1.4参考资料 (1)2程序系统的结构 (2)3数据库设计说明 (4)4项目页面文件设计说明 (5)1引言1.1编写目的该系统主要处理班级的通讯录的相关信息。

（1）通讯录界面信息主要包括：姓名、性别、民族、手机号、Email、相片等内容。

（2）完成以下操作：实现通讯录的添加、修改、查询、删除、保存。

（3）通讯录信息的输入输出、短信的发送、拨打电话。

1.2背景一个班级同学之间的手机号码比较多，如果直接加入手机自带的通讯录里面会使同学在拨打电话和收发短信给同学之间时会显得比较麻烦。

因此，有必要开发一个通讯系统，使得在班级同学之间的通讯可以得到统一的管理，减少同学之间通讯的不必要的麻烦。

1.3术语和缩写词1.4 参考资料2 程序系统的结构Tongxunlu.java该类主要负责创建用户的管理系统窗口，该类由main 方法、以及界面的设计。

Tongxunlu.java类的成员变量及方法：成员变量数据类型变量名称姓名文本框JTextFiled Name 性别文本框JTextFiled Sex 民族文本框JTextFiled Nation 手机号文本框JTextFiled Phone Email文本框JTextFiled Email 相片标签Jlabel Photo 姓名标签Jlabel 姓名性别标签Jlabel 性别民族标签Jlabel 民族手机号标签Jlabel 手机号Email标签Jlabel Email 相片名标签Jlabel 相片添加按钮JButton 添加删除按钮JButton 删除查询按钮JButton 查询刷新按钮JButton 刷新保存JButton 保存发送短信JButton 发送拨号JButton 拨号3数据库设计说明该数据库是在Android平台上面执行的JAVA代码，由于整个SQLite数据库是非可视化操作的，因此对所有数据库的操作都是通过执行JAVA代码实现的。

精品整理页脚内容文档编号：____________ 保密级别：____________XXX详细设计说明书所属项目：文件类别：版本号：编写者：审核者：批准者：修订记录目录1引言 (3)1.1编写目的 (3)3 1.3参考资料 (3)1.432 (4)2.142.242.34 2.442.5 (4)3 (4)3.143.254总体方案确认 (5)4.1系统总体结构确认 (5)4.2系统详细界面划分 (5)4.2.1应用系统与支撑系统的详细界面划分 (5)4.2.2系统内部详细界面划分 (5)5 (6)5.1 (6)5.2 (6)5.365.3.175.3.275.3.376 (7)6.176.276.376.3.176.3.276.3.386.3.486.3.586.3.687 (8)7.187.28 1引言1.1编写目的说明编写详细设计方案的主要目的。

说明书编制的目的是说明一个软件系统各个层次中的每个程序（每个模块或子程序）和数据库系统的设计考虑，为程序员编码提供依据。

如果一个软件系统比较简单，层次很少，本文件可以不单独编写，和概要设计说明书中不重复部分合并编写。

方案重点是模块的执行流程和数据库系统详细设计的描述。

1.2背景应包含以下几个方面的内容：A. 待开发软件系统名称；B. 该系统基本概念，如该系统的类型、从属地位等；C. 开发项目组名称。

1.3参考资料列出详细设计报告引用的文献或资料，资料的作者、标题、出版单位和出版日期等信息，必要时说明如何得到这些资料。

1.4术语定义及说明列出本文档中用到的可能会引起混淆的专门术语、定义和缩写词的原文。

2设计概述2.1任务和目标说明详细设计的任务及详细设计所要达到的目标。

2.2需求概述对所开发软件的概要描述, 包括主要的业务需求、输入、输出、主要功能、性能等，尤其需要描述系统性能需求。

2.3运行环境概述对本系统所依赖于运行的硬件，包括操作系统、数据库系统、中间件、接口软件、可能的性能监控与分析等软件环境的描述，及配置要求。

<XX系统> 详细设计说明书XX有限公司修订记录目录第一章概述 (5)1.1.应用模块的目的 (5)1.2.应用模块总体描述 (5)1.3.应用模块接口描述 (5)1.4.假设条件 (5)第二章设计模式（Design pattern） (6)第三章类设计 (7)3.1.分块类图 (8)3.1.1.<类图1> (8)3.1.2.<类图n> (8)3.2.整体继承关系 (8)3.3.类描述 (9)3.3.1.<类名1> Class Description (9)3.3.2.<类名n> Class Description (10)第四章交互图 (12)4.1.<情景编号1: 情景名称> (12)4.1.1.交互图 (12)4.1.2.例外情况及条件 (13)4.2.<情景编号n: 情景名称> (13)第五章状态图 (14)5.1.<状态图编号1:状态图名称> (14)5.2.<状态图编号n:状态图名称> (15)第六章时序流程图 (16)第七章用户界面设计说明 (18)7.1.用户界面关系 (18)7.2.用户界面具体描述 (18)7.2.1.<界面编号1:界面名称〉 (18)7.2.2.<界面编号N:界面名称〉 (19)第八章测试考虑 (20)第九章附录 (21)9.1.附录A 代码举例 (21)9.2.附录B 设计问题 (21)9.2.1.<设计问题1> (21)9.2.2.<设计问题n> (21)第一章概述1.1.应用模块的目的请明确客户建立应用模块的目的。

1.2.应用模块总体描述描述应用模块的总体功能。

1.3.应用模块接口描述简要描述本应用模块的公共接口，具体接口会在相应的类中进行具体描述。

建议采用列表的方式。

1.4.假设条件列出在问题领域，项目方案及其它影响系统设计的可能方面内，应当成立的假设条件。