日志管理详细设计

LogManage详细设计说明书卷号卷内编号密级应用软件详细设计说明书项目名称：部门级文档管理系统项目编号：模块名称：LogManage(日志管理)模块编号：编写人员：****编写日期：审批人员：审批日期：LogManage详细设计说明书1历史修改记录版本号修改人/日期摘要审定人/日期目录LogManage详细设计说明书21引言..................................................31.1编写目的..............................................31.1.1目的........................................................31.1.2文档预期读者................................................31.2项目背景..............................................31.3定义..................................................31.4参考资料..............................................32设计说明..............................................32.1程序简述..............................................32.1.1引用命名空间................................................32.1.2命名空间....................................................32.1.3类名........................................................32.2程序功能描述..........................................42.2.1函数列表....................................................42.2.2函数功能说明................................................42.3注释设计..............................................52.4限制条件..............................................52.5测试计划..............................................62.6尚未解决得问题........................................6LogManage详细设计说明书31引言1.1编写目的1.1.1目的描述部门级文档管理系统LogManage类模块的详细设计。1.1.2文档预期读者项目经理、系统分析员、研发经理、测试经理、项目组长、系统开发人员。1.2项目背景由武汉开目信息技术有限责任公司提出，IBM外包小组进行开发。软件系统名称：部门级文档管理系统。1.3定义1.4参考资料需求分析说明书、软件概要设计说明书。2设计说明2.1程序简述2.1.1引用命名空间usingSystem;usingSystem.Data;usingPartDM.DBOperate;2.1.2命名空间PartDM.LogManage2.1.3类名LogManageLogManage详细设计说明书42.2程序功能描述2.2.1函数列表成员类型成员说明类内/外部使用方法publicintAddDlog(stringSQLstring){}将指定的日志写入数据库外publicintSGetLog(intlogTime,intOState,outDataSetlogDataSet){}服务器日志查询外privateintExecuteSelect(inttime,intstate,outDataSetlogDataSet){}用语执行内嵌的SWITCH查询字符串内2.2.2函数功能说明2.2.2.1查询记录并得到记录集函数名：AddLog函数定义：publicintAddlog(stringSQLstring)访问权限：public参数：参数名类型说明SQLstringstring执行操作的SQL语句返回值类型：int值说明0插入成功2.2.2.2服务器日志查询函数名：SGetLog函数定义：publicintSGetLog(intlogTime,intOState,outDataSetlogDataSet)访问权限：public参数：参数名类型说明logTimeint查询时间(0为所有时间,3为3天以LogManage详细设计说明书5内,7为7天以内)OStateint操作状态(0为成功,1为失败,2为所有操作)logDataSetoutDataSet查询的输出型的记录集返回值类型：int值说明0插入成功2197服务器操作条件不符，操作失败2.2.2.3用于执行内嵌的SWITCH查询字符串函数名：ExecuteSelect函数定义：privateintExecuteSelect(inttime,intstate,outDataSetlogDataSet)访问权限：public参数：参数名类型说明timeint查询时间(0为所有时间,3为3天以内,7为7天以内)stateint操作状态(0为成功,1为失败,2为所有操作)logDataSetoutDataSet查询的输出型的记录集返回值类型：int值说明0插入成功2197服务器操作条件不符，操作失败2.3注释设计在方法的前面标注注释，描述该方法的功能，参数类型，返回值。声明变量应标注该变量的用途。在判断错误的位置加注释，说明是什么错误。2.4限制条件在调用本模块前，有必要先进行注册，将数据库连接串输入到注册表。要引用DBOperate模块。LogManage详细设计说明书62.5测试计划请参照单元测试计划说明书。2.6尚未解决得问题无