业务接口设计说明书1.docx
《业务接口设计说明书1.docx》由会员分享，可在线阅读，更多相关《业务接口设计说明书1.docx（32页珍藏版）》请在冰点文库上搜索。
业务接口设计说明书1
业务接口设计说明书
－会计科目结构
文档编号：
OE.XM.20090212.001.YWJKSJSMS.KJKMJG
版本号：
1.0
文档名称：
业务接口设计说明书
项目名称：
模块化系统平台
负责人：
whs
编写：
时间：
校对：
时间：
审核：
时间：
批准：
时间：
开发单位：
allrun
1引言1
1.1系统背景1
1.2参考资料1
1.3名词解释1
2系统简介2
3数据结构3
3.1科目模型3
3.2数据约束4
4数据表格5
4.1会计科目5
4.1.1科目表：
INOUTSTOCK_ACCOUNT5
5存储过程6
5.1会计科目6
5.1.1会计科目表CRUD单元：
INOUTSTOCK_AccountStorer6
5.1.2会计科目表读取单元：
INOUTSTOCK_AccountReader7
6业务接口8
6.1会计科目8
6.1.1TBrAccount9
6.1.2TBrAccountSet10
6.1.3BrAccountType11
6.1.4BrAccountAttrib11
6.1.5BrAccountLeaf11
6.1.6BrAccountSystem12
6.1.7BrAccountField12
6.1.8TBrAccountFields13
6.1.9TBrAccountOrder13
6.1.10TBrAccountOrders14
6.1.11IBmAccount14
7业务实现16
7.1会计科目16
7.1.1TBmAccount17
7.1.2TBmAccountStorer18
7.1.3TBmAccountReader19
1引言
详细描述会计科目结构的架构、软件组成与存储方式，定义系统用到的会计科目结构以及关联关系，规划所有外部接口与内部接口，为程序开发提供依据。
1.1系统背景
1.2参考资料
1.C#编程规范
2.系统设计文档规范
3.模块化业务组件设计说明书
文档编号OE.XM.20081124.001.MKHYWZJSJSMS
4.业务接口设计说明书
文档编号OE.XM.20081127.001.YWJKSJSMS
1.3名词解释
2系统简介
定义会计科目结构的数据表、存储过程、数据接口和处理接口。
命名空间：
Allrun.BcAccount
3数据结构
定义会计科目的构成。
3.1科目模型
☐会计科目采用树状结构。
3.2数据约束
类型
说明
科目代码
由英文字母和数字组成，输入不区分大小写，存储全部采用小写。
最多32个字符。
界面层中，要求在数据处理之前全部转换为小写。
4数据表格
根据业务此处定义会计科目表。
4.1会计科目
4.1.1科目表：
INOUTSTOCK_ACCOUNT
描述
域名
类型
长度
NULL
默认值
备注
科目代码
ACCOUNTCODE
nvarchar
32
N
科目名称
ACCOUNTNAME
nvarchar
50
N
上级代码
PARENTCODE
nvarchar
32
N
代码，由应用系统解释。
科目类型
ACCOUNTTYPE
int
N
0=其他类
1=资产类
2=负债类
3=所有者权益类
4=成本类
5=损益类
科目级别
ACCOUNTLAYER
int
N
当前余额
CURBAL
decimal
24,4
N
科目属性
ATTRIB
int
N
0=现金（资产类）
1=应收款（资产类）
2=固定资产（资产类）
3=流动资产（资产类）
4=应付款（负债类）
5=收入（损益类）
6=费用（损益类）
7=资金
8=其他（其他类）
详细科目
LEAF
int
N
0=否；1=是
系统科目
SYSTEM
int
N
0=否；1=是
备注
DESCRIBE
nvarchar
500
N
主键
科目代码
候选键
外键
索引
科目类型
科目属性
其他
5存储过程
根据业务需要此处定义会计科目表存储过程。
业务接口只能访问自己的存储过程，不能以任何形式访问任何其它存储过程。
5.1会计科目
5.1.1会计科目表CRUD单元：
INOUTSTOCK_AccountStorer
项目
内容
输入参数
CrudAction=CRUD操作类型（0=创建、1=读取、2=修改、3=删除）
AccountCode=科目代码
AccountName=科目名称
ParentCode=上级代码
AccountType=科目类型
Accountlayer=科目级别
Curbal=当前余额
Attrib=科目属性
Leaf=详细科目
System=系统科目
Describe=科目描述
AccountTypes=用“;”包裹的类型整数值连接串[NVARCHAR（2000）]
Attribs=用“;”包裹的属性整数值连接串[NVARCHAR（2000）]
FromCurbal=开始科目余额[DECIMAL（24,4）]
ToCurbal=结束科目余额[DECIMAL（24,4）]
LikeAccountCode=匹配科目代码[NVARCHAR（32）]
ExactAccountName=精确科目名称[NVARCHAR（50）]
IOFields=输入输出字段[NVARCHAR（2000）]
OrderBys=排序方式[NVARCHAR（2000）]
PageNo=页号
PageSize=页长
输出参数
RecordTotal=总记录数
输入输出参数
返回值
描述
PageNo与PageSize只用于查询，若PageNo或PageSize为null表示检索所有符合条件的数据。
AccountTypes、Attribs、FromCurbal、ToCurbal、LikeAccountCode、ExactAccountName只用于查询和删除。
IOFields只用于查询和修改。
OrderBys只用于查询。
5.1.2会计科目表读取单元：
INOUTSTOCK_AccountReader
项目
内容
输入参数
AccountCodes=用“;”包裹的科目代码连接串[NVARCHAR（4000）]
IOFields=输出字段[NVARCHAR（2000）]
输出参数
输入输出参数
返回值
描述
查询输出结果按科目代码正序排列。
6业务接口
根据业务定义会计科目业务接口。
6.1会计科目
命名空间：
Allrun.BcInterface.InOutStock.Account。
6.1.1TBrAccount
继承Allrun.BcInterface.TBoDatum，定义会计科目数据。
该类要求应用System.SerializableAttribute特性。
类型
说明
修饰
public
成员
定义
说明
修饰
构造
TBrAccount（）
构造一个实例。
public
TBrAccount（TBrAccountreference）
构造一个实例，并把参照实例的所有元素深度克隆到当前实例中。
reference为参照实例。
public
TBrAccount（SerializationInfoinfo,StreamingContextcontext）
反序列化构造实例。
info为序列化数据存储对象。
context为序列化上下文。
protected
属性
stringAccountCode
设置或获取会计科目代码。
主键。
publicvirtual
stringAccountName
设置或获取会计科目名称。
publicvirtual
stringParentCode
设置或获取上级代码。
publicvirtual
BrAccountTypeAccountType
设置或获取科目类型。
publicvirtual
intAccountlayer
设置或获取科目级别。
publicvirtual
decimalCurbal
设置或获取当前余额。
publicvirtual
BrAccountAttribAttrib
设置或获取科目属性。
publicvirtual
BrAccountLeafLeaf
设置或获取详细科目。
publicvirtual
BrAccountSystemSystem
设置或获取系统科目。
publicvirtual
stringDescribe
设置或获取科目描述。
publicvirtual
stringAccountTypes
设置或获取科目类型连接串。
仅作为查询和删除条件。
publicvirtual
stringAttribs
设置或获取科目属性连接串。
仅作为查询和删除条件。
publicvirtual
decimalFromCurbal
设置或获取开始科目余额。
仅作为查询和删除条件。
publicvirtual
decimalToCurbal
设置或获取结束科目余额。
仅作为查询和删除条件。
publicvirtual
stringLikeAccountCode
设置或获取匹配科目代码。
仅作为查询和删除条件。
publicvirtual
stringExactAccountName
设置或获取精确科目名称。
仅作为查询和删除条件。
publicvirtual
索引
方法
voidDeserialize（SerializationInfoinfo,StreamingContextcontext）
二进制、SOAP反序列化数据。
info为序列化数据存储对象。
context为序列化上下文。
protectedoverride
voidSerialize（SerializationInfoinfo,StreamingContextcontext）
二进制、SOAP序列化数据。
info为序列化数据存储对象。
context为序列化上下文。
protectedoverride
voidXmlDeserialize（XmlReaderreader）
XML反序列化数据。
reader为XML数据读取流。
protectedoverride
XmlSerialize（XmlWriterwriter）
XML序列化数据。
writer为XML数据写入流。
protectedoverride
objectClone（）
创建作为当前实例深度副本的新对象。
返回当前实例深度副本的新对象。
publicoverride
6.1.2TBrAccountSet
继承Allrun.BcInterface.TBoRecordSet，定义会计科目数据列表。
该类要求应用System.SerializableAttribute特性。
类型
说明
修饰
public
成员
定义
说明
修饰
构造
TBrAccountSet（）
构造一个实例。
public
TBrAccountSet（TBrAccountSetreference）
构造一个实例，并把参照实例的所有元素深度克隆到当前实例中。
reference为参照实例。
public
TBrAccountSet（SerializationInfoinfo,StreamingContextcontext）
反序列化构造实例。
info为序列化数据存储对象。
context为序列化上下文。
protected
属性
索引
方法
objectClone（）
创建作为当前实例深度副本的新对象。
返回当前实例深度副本的新对象。
publicoverride
string[]GetAccountCodes（）
获取所含的会计科目代码。
返回会计科目代码数组。
publicvirtual
TBrAccountGetAccount（stringstrAccountCode）
获取特定代码的会计科目数据。
strAccountCode为会计科目代码。
返回会计科目数据，null表示不存在。
publicvirtual
6.1.3BrAccountType
枚举类型，定义会计科目类型。
类型
说明
修饰
public
成员
定义
说明
修饰
Invalid
未知类别。
-1
Asset
资产类。
0
Liabilities
负债类。
1
Possess
所有者权益类。
2
Cost
成本类。
3
Profit
损益类。
4
Other
其他。
5
6.1.4BrAccountAttrib
枚举类型，定义会计科目属性。
类型
说明
修饰
public
成员
定义
说明
修饰
Invalid
未知类别。
-1
Currency
现金（资产类）。
0
Receivable
应收款（资产类）。
1
FixedAsset
固定资产（资产类）。
2
CurrentAsset
流动资产（资产类）。
3
Payable
应付款（负债类）。
4
Revenue
收入（损益类）。
5
Expense
费用（损益类）。
6
Fund
资金（其他）。
7
Other
8=其他（其他类）。
8
6.1.5BrAccountLeaf
枚举类型，定义会计科目详细科目标志。
类型
说明
修饰
public
成员
定义
说明
修饰
Invalid
未知类别。
-1
LeafNo
非详细科目（非叶子节点）。
0
LeafYes
详细科目（叶子节点）。
1
6.1.6BrAccountSystem
枚举类型，定义会计科目系统科目标志。
类型
说明
修饰
public
成员
定义
说明
修饰
Invalid
未知类别。
-1
SystemNo
资产类。
0
SystemYes
负债类。
1
6.1.7BrAccountField
枚举类型，定义会计科目字段。
类型
说明
修饰
public
成员
定义
说明
修饰
AccountCode
会计科目代码。
AccountName
会计科目名称。
ParentCode
上级代码。
AccountType
科目类型。
Accountlayer
科目级别。
Curbal
当前余额。
Attrib
科目属性。
Leaf
详细科目。
System
系统科目。
Describe
科目描述。
6.1.8TBrAccountFields
继承Allrun.BcInterface.TBoFields，定义会计科目字段表。
该类要求应用System.SerializableAttribute特性。
类型
说明
修饰
public
成员
定义
说明
修饰
构造
TBrAccountFields（）
构造一个实例。
public
TBrAccountFields（paramsBrAccountField[]fields）
构造一个实例。
fields为会计科目字段数组。
public
TBrAccountFields（TBrAccountFieldsreference）
构造一个实例，并把参照实例的所有元素深度克隆到当前实例中。
reference为参照实例。
public
TBrAccountFields（SerializationInfoinfo,StreamingContextcontext）
反序列化构造实例。
info为序列化数据存储对象。
context为序列化上下文。
protected
属性
索引
方法
objectClone（）
创建作为当前实例深度副本的新对象。
返回当前实例深度副本的新对象。
publicoverride
6.1.9TBrAccountOrder
继承Allrun.BcInterface.TBoFieldOrder，定义会计科目字段排序项。
该类要求应用System.SerializableAttribute特性。
类型
说明
修饰
public
成员
定义
说明
修饰
构造
TBrAccountOrder（）
构造一个实例。
public
TBrAccountOrder（BrAccountFieldfield,BoOrderEnumorderType）
构造一个实例。
field为会计科目字段。
orderType为排序类型。
public
TBrAccountOrder（TBrAccountOrderreference）
构造一个实例，并把参照实例的所有元素深度克隆到当前实例中。
reference为参照实例。
public
TBrAccountOrder（SerializationInfoinfo,StreamingContextcontext）
反序列化构造实例。
info为序列化数据存储对象。
context为序列化上下文。
protected
属性
索引
方法
objectClone（）
创建作为当前实例深度副本的新对象。
返回当前实例深度副本的新对象。
publicoverride
6.1.10TBrAccountOrders
继承Allrun.BcInterface.TBoFieldOrders，定义会计科目字段排序表。
该类要求应用System.SerializableAttribute特性。
类型
说明
修饰
public
成员
定义
说明
修饰
构造
TBrAccountOrders（）
构造一个实例。
public
TBrAccountOrders（paramsTBrAccountOrder[]orders）
构造一个实例。
orders为字段排序项数组。
public
TBrAccountOrders（TBrAccountOrdersreference）
构造一个实例，并把参照实例的所有元素深度克隆到当前实例中。
reference为参照实例。
public
TBrAccountOrders（SerializationInfoinfo,StreamingContextcontext）
反序列化构造实例。
info为序列化数据存储对象。
context为序列化上下文。
protected
属性
索引
方法
objectClone（）
创建作为当前实例深度副本的新对象。
返回当前实例深度副本的新对象。
publicoverride
6.1.11IBmAccount
定义会计科目处理接口。
类型
说明
修饰
public
成员
定义
说明
修饰
属性
方法
boolCreateAccount（TBrAccountinfo）
追加一个会计科目信息。
info为待追加会计科目数据。
返回true表示成功，false表示失败。
TBrAccountSetReadAccount（TBrAccountinfo,TBrAccountFieldsfields,TBrAccountOrdersorders,TCoPageObjectpage）
读取符合条件的会计科目信息。
info为查询条件，null表示无条件读取。
fields为输出的会计科目字段，null表示输出所有字段。
orders为排序方式，null表示采用默认排序方式。
-附加码正序
page为分页控制，null表示不分页读取。
返回会计科目数据列表，null表示读取失败。
TBrAccountSetReadAccount（string[]accountCodes,TBrAccountFieldsfields）
读取符合条件的会计科目。
accountCodes为会计科目代码数组。
fields为输出的会计科目字段，null表示输出所有字段。
返回会计科目数据列表，null表示读取失败。
stringGetAccountName（stringAccountcode）
根据会计科目代码读取会计科目名称。
accountcode为会计科目代码。
返回会计科目名称，空字符表示不存在。
boolUpdateAccount（TBrAccountinfo,TBrAccountFieldsfields）
根据会计科目代码修改会计科目数据。
info为待修改会计科目数据。
fields为待修改会计科目字段，null表示修改除会计科目代码之外的所有字段。
返回true表示修改成功，false表示修改失败。
boolDeleteAccount（TBrAccountinfo）
删除符合条件的会计科目。
info为删除条件。
返回true表示删除成功，false表示删除失败。
7业务实现
描述对各个业务接口的实现。
7.1会计科目
命名空间：
A
升级会员 