服务器端文档操作详细设计(RWDocument)

1、 湖北国际软件外包人才培养基地湖北国际软件外包人才培养基地 RWDocument 文档操作详细设计 卷号卷内编号密级 应用软件详细设计说明书应用软件详细设计说明书项目名称：项目名称： 部门级文档管理系统部门级文档管理系统 项目编号：项目编号： 模块名称：模块名称：RWDocument(服务器文档操作服务器文档操作)模块编号：模块编号： 编写人员：编写人员： * 编写日期：编写日期： 2004-6-8 审批人员：审批人员： 审批日期：审批日期： 湖北国际软件外包人才培养基地湖北国际软件外包人才培养基地 RWDocument 详细设计说明书1历史修改记录版本号修改人/日期摘要审定人/日期 湖北国际

2、软件外包人才培养基地湖北国际软件外包人才培养基地 RWDocument 详细设计说明书2目录目录1 1引言引言 .2 21.11.1 编写目的编写目的.2目的 .2文档预期读者 .31.21.2 项目背景项目背景.31.31.3 定义定义.31.41.4 参考资料参考资料.32 2设计说明设计说明 .3 32.12.1 程序简述程序简述.3引用命名空间 .3命名空间 .3类名 .32.22.2 程序功能描述程序功能描述.3函数列表 .3函数功能说明 .42.32.3 注释设计注释设计.92.42.4 限制条件限制条件.92.52.5 测试计划测试计划.92.62.6 尚未解决得问题尚未解决得问

3、题.9 湖北国际软件外包人才培养基地湖北国际软件外包人才培养基地 RWDocument 详细设计说明书31 引言引言1.1 编写目的编写目的1.1.1 目的描述部门级文档管理系统 RWDocument 类模块的详细设计。1.1.2 文档预期读者项目经理、系统分析员、研发经理、测试经理、项目组长、系统开发人员。1.2 项目背景项目背景由武汉开目信息技术有限责任公司提出，IBM 外包小组进行开发。软件系统名称：部门级文档管理系统。1.3 定义定义1.4 参考资料参考资料需求分析说明书、软件概要设计说明书。2 设计说明设计说明2.1 程序简述程序简述2.1.1 引用命名引用命名空间空间using S

4、ystem;using System.IO;using System.Text;using PartDM.DBOperate;using PartDM.XMLOperate;using System.Data;2.1.2命名空间命名空间 PartDM.RWDocumentPartDM.RWDocument2.1.3类名类名RWDocumentRWDocument 湖北国际软件外包人才培养基地湖北国际软件外包人才培养基地 RWDocument 详细设计说明书42.2 程序功能描述程序功能描述2.2.1 函数列表函数列表成员类成员类型型成员说明类内/外部使用public int ReadDocum

5、ent(string userID, string documentName,string documentVersion,long startReadPosition,out string content,out bool isReadEnd)从服务器端读文件外public int WriteDocument(string content,string userID,string documentName,string documentVersion,DocumentLocal documentPosition)从服务器端写文件外方法方法public int DeleteDocument(s

6、tring documentID,string documentName)删除文档外属性属性public int BufferSize获得传输文件时，文件的大小外2.2.2 函数功能说明函数功能说明2.2.2.1 从服务器端读文件从服务器端读文件函数名 ：ReadDocumentReadDocument ()函数定义：public int ReadDocument(string userID, string documentName,string documentVersion,long startReadPosition,out string content,out bool isReadE

7、nd)访问权限：public参数：参数名类型说明userIDstring文档拥有者的 IDdocumentNmaestring文档名称documentVersionstring文件版本号startReadPositionlong开始读的位置contentout string输出文档的内容isReadEndout bool文档是否结束 湖北国际软件外包人才培养基地湖北国际软件外包人才培养基地 RWDocument 详细设计说明书5返回值类型：int值说明？执行的状态5504指定的路径不存在2.2.2.2 从服务器端写文件从服务器端写文件函数名 ： WriteDocumentWriteDocume

8、nt ()函数定义：public int WriteDocument(string content,string userID,string documentName,string ocumentVersion,DocumentLocal documentPosition)访问权限：public参数：参数名类型说明contentstring文档内容userIDstring拥有者的 IDdocumentNamestring文档名称ocumentVersionstring文档版本号documentPositionDocumentLocal文件流的位置返回值类型：int值说明0出库成功5505在服务

9、器上写文档失败2.2.2.3 删除文档删除文档函数名 ： DeleteDocumenDeleteDocumen ()函数定义：public void DeleteDocumen()访问权限：public参数：参数名类型说明无无无返回值类型：int值说明0出库成功2.2.2.4 删除文档删除文档函数名 ： DeleteDocument()()函数定义：public int DeleteDocument(string documentID,string documentName)访问权限：public 湖北国际软件外包人才培养基地湖北国际软件外包人才培养基地 RWDocument 详细设计说明书6参数：参数名类型说明documentIDsring文档 IDdocumentNamesring文档名称返回值类型：int值说明0查询成功5506删除失败2.3 注释设计注释设计在方法的前面标注注释，描述该方法的功能