XML处理详细设计(XMLOperate).doc

湖北国际软件外包人才培养基地湖北国际软件外包人才培养基地 XMLOperate 详细设 计 卷号 卷内编号 密级 应用软件详细设计说明书应用软件详细设计说明书 项目名称 项目名称 部门级文档管理系统部门级文档管理系统 项目编号 项目编号 模块名称 模块名称 XMLOperate XML 处理处理 模块编号 模块编号 编写人员 编写人员 编写日期 编写日期 2004 6 8 审批人员 审批人员 审批日期 审批日期 湖北国际软件外包人才培养基地湖北国际软件外包人才培养基地 XMLOperate 详细设 计 1 历史修改记录 版本号修改人 日期摘要审定人 日期 湖北国际软件外包人才培养基地湖北国际软件外包人才培养基地 XMLOperate 详细设 计 2 目录目录 1 1引言引言 2 2 1 11 1 编写目的编写目的 2 1 1 1 目的 2 1 1 2 文档预期读者 3 1 21 2 项目背景项目背景 3 1 31 3 定义定义 3 1 41 4 参考资料参考资料 3 2 2设计说明设计说明 3 3 2 12 1 程序简述程序简述 3 2 1 1 引用命名空间 3 2 1 2 命名空间 3 2 1 3 类名 3 2 22 2 程序功能描述程序功能描述 3 2 2 1 函数列表 3 2 2 2 函数功能说明 4 2 32 3 注释设计注释设计 9 2 42 4 限制条件限制条件 9 2 52 5 测试计划测试计划 9 2 62 6 尚未解决得问题尚未解决得问题 9 湖北国际软件外包人才培养基地湖北国际软件外包人才培养基地 XMLOperate 详细设 计 3 1 引言引言 1 1 编写目的编写目的 1 1 1 目的 描述部门级文档管理系统 XMLOperate 类模块的详细设计 1 1 2 文档预期读者 项目经理 系统分析员 研发经理 测试经理 项目组长 系统开发人 员 1 2 项目背景项目背景 由武汉开目信息技术有限责任公司提出 IBM 外包小组进行开发 软件系统名称 部门级文档管理系统 1 3 定义定义 1 4 参考资料参考资料 需求分析说明书 软件概要设计说明书 2 设计说明设计说明 2 1 程序简述程序简述 2 1 1 引用命名引用命名空间空间 using System using System Xml using System IO using System Text using System Data using PartDM DataSecurity 2 1 2命名空间命名空间 PartDM XMLOperatePartDM XMLOperate 2 1 3类名类名 XMLOperate 湖北国际软件外包人才培养基地湖北国际软件外包人才培养基地 XMLOperate 详细设 计 4 2 2 程序功能描述程序功能描述 2 2 1 函数列表函数列表 成员类成员类 型型 成员说明 类内 外 部使用 public int SetXmlDataSetInfo Operate Type operateType string dataSetObj DocumentLocal dataSetLocal out string strXml 将数据集信息转 为 Xml 流 s c 外 public int SetXmlReturnValueInfo Operate Type operateType int returnValue out string strXml 将返回值类型信 息转为 Xml 流 s c 外 public int SetXmlInAndDelDocument Operate Type operateType string document Name string document Edition int pResult out string strXml 将电子文档信息 转为 Xml 流 入 库 删除文档 s c 外 public int SetXmlOutdocument Operate Type operateType string document Name string document Edition DocumentLocal document Local string document Contents int pResult out string strXml 将电子文档信息 转为 Xml 流 出 库 s c 外 public int GetXmlOperateType string strXml out Operate Type operateType 获得操作类型 s 收 外 public int GetXmlSqlScriptInfo string strXml out string sqlScript 获得 Sql 语句信 息 s 收 外 方法方法 public int GetXmlAdmin string strXml out string userName out string password 获得登录信息 s 收 外 湖北国际软件外包人才培养基地湖北国际软件外包人才培养基地 XMLOperate 详细设 计 5 public int GetXmlModifyDocumentAttibute string strXml out string document Name out string document Edition out string document New Name 获得修改文档属 性的信息 修改 文档名字 s 收 外 public int GetXmlInDocument string strXml out string document Name out string document Edition out DocumentLocal document Local out string document Contents 获得电子文档信 息 入库 s 收 外 public int GetXmlOutAndDelDocument string strXml out string document Name out string document Edition 获得电子文档信 息 出库 删除文 档 s 收 外 public int GetXmlOperateDataBackup string strXml out int backupID 获得备份编号信 息 s 收 外 public enum DocumentLocal 文档位置外 枚举枚举 public enum Operate Type 文档操作外 2 2 2 函数功能说明函数功能说明 2 2 2 1 将数据集信息转为将数据集信息转为 XmlXml 流流 s cs c 函数名 SetXmlDataSetInfoSetXmlDataSetInfo 函数定义 public int SetXmlDataSetInfo Operate Type operateType string dataSetObj DocumentLocal dataSetLocal out string strXml 访问权限 public 参数 参数名类型说明 operateTypeoperate Type输入的操作类型 dataSetObjstring数据集对象文件 dataSetLocal DocumentLocal数据集文件位置状态 strXml out string输出的 XML 流 返回值类型 int 值说明 0转换成功 湖北国际软件外包人才培养基地湖北国际软件外包人才培养基地 XMLOperate 详细设 计 6 2 2 2 2 将返回值类型信息转为将返回值类型信息转为 XmlXml 流流 s c s c 函数名 SetXmlReturnValueInfoSetXmlReturnValueInfo 函数定义 public int SetXmlReturnValueInfo Operate Type operateType int returnValue out string strXml 访问权限 public 参数 参数名类型说明 operateTyp e Operate Typ e 输入的操作类型 returnValueint返回值 strXmlout string输出的 XML 流 返回值类型 int 值说明 0转换成功 2 2 2 3 将电子文档信息转为将电子文档信息转为 XmlXml 流流 入库入库 删除文档删除文档 s c s c 函数名 DeleteDocumenDeleteDocumen 函数定义 public int SetXmlInAndDelDocument Operate Type operateType string document Name string document Edition int pResult out string strXml 访问权限 public 参数 参数名类型说明 operateTypeOperate Type输入的操作类型 document Namestring文档名称 document Editionstring文档版本 pResultint结果 strXmlout string输出的 XML 流 返回值类型 int 值说明 0转换成功 5001文档名称或版本为空 2 2 2 4 将电子文档信息转为将电子文档信息转为 XmlXml 流流 出库出库 s c s c 函数名 SetXmlOutdocument SetXmlOutdocument 函数定义 public int SetXmlOutdocument Operate Type operateType string document Name string document Edition DocumentLocal document Local string document Contents int pResult out string strXml 湖北国际软件外包人才培养基地湖北国际软件外包人才培养基地 XMLOperate 详细设 计 7 访问权限 public 参数 参数名类型说明 operateTypeOperate Type输入的操作类型 document Namestring文档名称 document Editionstring文档版本 document LocalDocumentLocal文档位置 document Contentsstring文档内容 pResultint结果 strXmlstring输出的 XML 流 返回值类型 int 值说明 0转换成功 5001文档名称或文档版本或文档内容为空 2 2 2 5 获得操作类型获得操作类型 s s 收收 函数名 GetXmlOperateType GetXmlOperateType 函数定义 public int GetXmlOperateType string strXml out Operate Type operateType 访问权限 public 参数 参数名类型说明 strXmlstring输入的 XML 流 operateTypeout Operate Type输出的操作类型 返回值类型 int 值说明 0转换成功 5002输出的 XML 流有错误 2 2 2 6 获得获得 SqlSql 语句信息语句信息 s s 收收 函数名 GetXmlSqlScriptInfoGetXmlSqlScriptInfo 函数定义 public int GetXmlSqlScriptInfo string strXml out string sqlScript 访问权限 public 参数 参数名类型说明 strXmlstring输入的 XML 流 sqlScriptout string输出的 SQL 语句 湖北国际软件外包人才培养基地湖北国际软件外包人才培养基地 XMLOperate 详细设 计 8 返回值类型 int 值说明 0获得 SQL 语句成功 5002输出的 XML 流有错误 2 2 2 7 获得登录信息获得登录信息 s s 收收 函数名 GetXmlAdmin GetXmlAdmin 函数定义 public int GetXmlAdmin string strXml out string userName out string password 访问权限 public 参数 参数名类型说明 strXmlstring输入的 XML 流 usernameout string用户 ID passwordout string用户密码 返回值类型 int 值说明 0获得信息成功 5002输出的 XML 流有错误 2 2 2 8 获得修改文档属性的信息获得修改文档属性的信息 修改文档名字修改文档名字 s s 收收 函数名 GetXmlModifyDocumentAttibute GetXmlModifyDocumentAttibute 函数定义 public int GetXmlModifyDocumentAttibute string strXml out string document Name out string document Edition out string document New Name 访问权限 public 参数 参数名类型说明 strXmlstring输入的 XML 流 document Nameout string输出的文档名称 document Editionout string输出的文档版本号 document New Nameout string输出的新的文档名称 返回值类型 int 值说明 0获得信息成功 5002输出的 XML 流有错误 湖北国际软件外包人才培养基地湖北国际软件外包人才培养基地 XMLOperate 详细设 计 9 2 2 2 9 获得电子文档信息获得电子文档信息 入库入库 s s 收收 函数名 GetXmlInDocument GetXmlInDocument 函数定义 public int GetXmlInDocument string strXml out string document Name out string document Edition out DocumentLocal document Local out string document Contents 访问权限 public 参数 参数名类型说明 strXmlstring输入的 XML 流 document Nameout string输出的文档名称 document Editionout string输出的文档版本号 document Localout DocumentLocal输出的文档位置 document Contentsout string输出的新的内容 返回值类型 int 值说明 0获得信息成功 5002输出的 XML 流有错误 2 2 2 10 获得电子文档信息获得电子文档信息 出库出库 删除文档删除文档 s s 收收 函数名 GetXmlOutAndDelDocument GetXmlOutAndDelDocument 函数定义 public int GetXmlOutAndDelDocum