首页
企业微信
腾讯会议
企业邮箱
简道云
其它服务
联系我们
留言板
1、业务对象管理
更新时间： 2024-09-12

类名

H3.DataModel.IBizObjectManager

接口清单

序号

接口名称

说明

1

GetPublishedSchema

根据表单编码获取已发布的业务对象数据模型

2

GetPublishedSchemas

根据多个表单编码获取已发布的业务对象数据模型

3

GetPublishedSchemaSummary

根据表单编码获取已发布的业务对象数据模型摘要

4

GetPublishedSchemaSummaries

根据多个表单编码获取已发布的业务对象数据模型摘要

5

LoadBizObject

获取单个业务对象

6

RemoveBizObject

删除单个业务对象

7

GetList

根据条件获取业务对象集合

8

GetListCount

根据条件获取业务对象数量

9

Clear

根据表单编码清空所有业务对象和相关的附件

10

QueryFileHeader

查询附件头信息

11

GetBizObjectFileHeaders

根据多个业务对象ID获取附件头信息

12

GetFileHeaders

查询多个附件ID获取附件头信息

13

GetFile

根据ID获取一个附件

14

AttachBizObject

将附件附加到业务对象上

15

CopyFiles

将一个业务对象属性上的所有附件复制给另外一个业务对象的属性

16

RemoveFile

根据附件ID删除附件

17

RemoveFilesByBizObjectProperty

删除一个业务对象属性上的所有附件

18

AddComment

添加审批意见

19

GetCommentsByBizObject

根据业务对象ID获取审批意见

20

GetCommentSignature

获取审批意见中的签名图片

21

LoadAssociations

获取表单的关联列表

基本用法

上述清单中的接口均归属在this.Engine.BizObjectManager下，如要获取已发布的业务对象数据模型摘要，可使用如下代码形式：

H3.DataModel.BizObjectSchemaSummary summary = this.Engine.BizObjectManager.GetPublishedSchemaSummary("XXX");

其他接口使用方式与此类似。

接口说明

1. GetPublishedSchema(string schemaCode)

1.1. 说明

根据表单编码获取已发布的表单数据模型。

1.2. 参数

参数名

说明

schemaCode

表单编码

1.3. 返回值

类型

说明

H3.DataModel.BizObjectSchema

业务对象数据模型

2. GetPublishedSchemas(bool getAll, string[] schemaCodes)

2.1. 说明

根据多个表单编码获取已发布的业务对象数据模型。

2.2. 参数

参数名

说明

getAll

是否返回全部业务对象数据模型，如果是，则不需要指定schemaCodes。

schemaCodes

表单编码，如果getAll为false，则需要指定表单编码。

2.3. 返回值

类型

说明

H3.DataModel.BizObjectSchema[]

业务对象数据模型数组

3. GetPublishedSchemaSummary(string schemaCode)

3.1. 说明

根据表单编码获取已发布的表单数据模型摘要。该摘要信息的体量会比H3.DataModel.BizObjectSchema小，所以传输速度会更快，请尽量使用该方法来替代GetPublishedSchema(string schemaCode)。

3.2. 参数

参数名

说明

schemaCode

表单编码

3.3. 返回值

类型

说明

H3.DataModel.BizObjectSchemaSummary

业务对象数据模型摘要

4. GetPublishedSchemaSummaries(bool getAll, string[] schemaCodes)

4.1. 说明

根据多个表单编码获取已发布的业务对象数据模型摘要。为了提高性能和响应，在这里不会返回业务对象模式的全部信息，而是只返回其中的摘要信息，请尽量使用该方法来替代GetPublishedSchemas(string schemaCode)。

4.2. 参数

参数名

说明

getAll

是否返回全部业务对象数据模型，如果是，则不需要指定schemaCodes。

schemaCodes

表单编码，如果getAll为false，则需要指定表单编码。

4.3. 返回值

类型

说明

H3.DataModel.BizObjectSchemaSummary[]

业务对象数据模型摘要数组

5. LoadBizObject(string userId, string schemaCode, string objectId, bool requireRelatedObjects, out Dictionary<string, List<BizObjectFileHeader>> fileTable, out Dictionary<string, BizObjectHeader> associatedBOHeaders, out Dictionary<string, string> unitNameTable)

5.1. 说明

获取单个业务对象。

5.2. 参数

参数名

说明

userId

用户ID

schemaCode

表单编码

objectId

业务对象ID

requireRelatedObjects

是否返回关联对象的头信息

fileTable

返回这个业务对象相关的附件的文件头，细节详见H3.DataModel.BizObjectFileHeader

associatedBOHeaders

返回关联对象的头信息，细节详见H3.DataModel.BizObjectHeader

unitNameTable

返回业务对象中相关的组织结构的ID和名称信息

5.3. 返回值

类型

说明

H3.Data.Serialization.VirtualObject

业务对象

6. RemoveBizObject(string userId, string schemaCode, BizObjectType bizObjectType, string objectId, bool checkReference, out BizObjectHeader referredObjectHeader)

6.1. 说明

删除单个业务对象。

6.2. 参数

参数名

说明

userId

用户ID

schemaCode

表单编码

bizObjectType

业务对象类型，H3.DataModel.BizObjectType类型的枚举值

objectId

业务对象ID

checkReference

是否检查被其他对象引用

referredObjectHeader

引用该对象的对象的摘要信息，细节详见H3.DataModel.BizObjectHeader

6.3. 返回值

类型

说明

H3.ErrorCode

错误代码

7. GetList( string userId, string schemaCode, GetListScopeType authScopeType, Data.Filter.Filter filter, out int count, bool requireRelatedObjects, out Dictionary<string, BizObjectHeader> associatedBoHeaders, out Dictionary<string, string> unitNameTable)

7.1. 说明

根据条件获取业务对象集合。

7.2. 参数

参数名

说明

userId

用户ID

schemaCode

表单编码

authScopeType

数据权限过滤方式，H3.DataModel.GetListScopeType类型的枚举值

filter

过滤条件，详见H3.Data.Filter.Filter

count

返回集合数据量

requireRelatedObjects

是否返回关联对象的头信息

associatedBoHeaders

返回关联对象的头信息，细节详见H3.DataModel.BizObjectHeader

unitNameTable

返回业务对象中相关的组织结构的ID和名称信息

7.3. 返回值

类型

说明

H3.Data.Serialization.VirtualObject[]

业务对象数组

8. GetListCount( string userId, BizObjectSchema schema, GetListScopeType authScopeType, Data.Filter.Filter filter)

8.1. 说明

根据条件获取业务对象数量。

8.2. 参数

参数名

说明

userId

用户ID

schema

业务对象数据模型

authScopeType

数据权限过滤方式，H3.DataModel.GetListScopeType类型的枚举值

filter

过滤条件，详见H3.Data.Filter.Filter

8.3. 返回值

类型

说明

int

业务对象数量

9. Clear(string schemaCode)

9.1. 说明

根据表单编码清空所有业务对象和相关的附件。

9.2. 参数

参数名

说明

schemaCode

表单编码

9.3. 返回值

类型

说明

无

无

10. QueryFileHeader(string schemaCode, string childSchemaCode, string propertyName, string bizObjectId, H3.Data.BoolValue lastVersion, string fileName)

10.1. 说明

查询附件头信息。

10.2. 参数

参数名

说明

schemaCode

表单编码

childSchemaCode

子表表单编码

propertyName

属性编码

bizObjectId

业务对象ID

lastVersion

是否只查询最终版本

fileName

要查询的文件的名称，常用于查找同一个文件的不同版本

10.3. 返回值

类型

说明

H3.DataModel.BizObjectFileHeader[]

文件头信息

11. GetBizObjectFileHeaders(string[] bizObjectIds)

11.1. 说明

根据多个业务对象ID获取附件头信息。

11.2. 参数

参数名

说明

bizObjectIds

业务对象ID

11.3. 返回值

类型

说明

H3.DataModel.BizObjectFileHeader[]

文件头信息，不包含文件内容

12. GetFileHeaders(string[] fileIds)

12.1. 说明

查询多个附件ID获取附件头信息。

12.2. 参数

参数名

说明

fileIds

附件ID

12.3. 返回值

类型

说明

H3.DataModel.BizObjectFileHeader[]

文件头信息，不包含文件内容

13. GetFile(string fileId)

13.1. 说明

根据ID获取一个附件。

13.2. 参数

参数名

说明

fileId

附件ID

13.3. 返回值

类型

说明

H3.DataModel.BizObjectFile

文件信息，包括文件内容

14. AttachBizObject(string[] fileIds, string schemaCode, string childSchemaCode, string propertyName, string bizObjectId)

14.1. 说明

将附件附加到业务对象上。

14.2. 参数

参数名

说明

fileIds

附件ID

schemaCode

表单编码

childSchemaCode

子表表单编码

propertyName

业务对象属性编码

bizObjectId

业务对象ID

14.3. 返回值

类型

说明

无

无

15. CopyFiles(string sourceSchemaCode, string sourceChildSchemaCode, string sourcePropertyName, string sourceBizObjectId, string destSchemaCode, string destChildSchemaCode, string destPropertyName, string destBizObjectId, bool overwrite, bool physicalRemove)

15.1. 说明

将一个业务对象属性上的所有附件复制给另外一个业务对象的属性。

15.2. 参数

参数名

说明

sourceSchemaCode

源表单编码

sourceChildSchemaCode

源子表表单编码

sourcePropertyName

源表单属性编码

sourceBizObjectId

源业务对象ID

destSchemaCode

目标表单编码

destChildSchemaCode

目标子表表单编码

destPropertyName

目标表单属性编码

destBizObjectId

目标业务对象ID

overwrite

是否是覆盖目标业务对象属性

physicalRemove

如果是覆盖模式，则表示被覆盖的文件是否物理删除

15.3. 返回值

类型

说明

H3.DataModel.BizObjectFileHeader[]

复制后的文件头信息，不包含文件内容

16. RemoveFile(string fileId, bool physical)

16.1. 说明

根据附件ID删除附件。

16.2. 参数

参数名

说明

fileId

附件ID

physical

是否物理删除

16.3. 返回值

类型

说明

无

无

17. RemoveFilesByBizObjectProperty(string schemaCode, string childSchemaCode, string propertyName, string bizObjectId, bool physical)

17.1. 说明

删除一个业务对象属性上的所有附件。

17.2. 参数

参数名

说明

schemaCode

表单编码

childSchemaCode

子表表单编码

propertyName

属性编码

bizObjectId

业务对象ID

physical

是否物理删除

17.3. 返回值

类型

说明

无

无

18. AddComment(DataModel.Comment comment)

18.1. 说明

添加审批意见。

18.2. 参数

参数名

说明

comment

审批意见对象，详见H3.DataModel.Comment

18.3. 返回值

类型

说明

H3.ErrorCode

错误代码

19. GetCommentsByBizObject(string schemaCode, string bizObjectId)

19.1. 说明

根据业务对象ID获取审批意见。

19.2. 参数

参数名

说明

schemaCode

表单编码

bizObjectId

业务对象ID

19.3. 返回值

类型

说明

H3.DataModel.Comment[]

审批意见数组

20. GetCommentSignature(string key)

20.1. 说明

获取审批意见中的签名图片。

20.2. 参数

参数名

说明

key

签名键

20.3. 返回值

类型

说明

string

签名图片URL

21. LoadAssociations(string schemaCode)

21.1. 说明

获取表单的关联列表。

21.2. 参数

参数名

说明

schemaCode

表单编码

21.3. 返回值

类型

说明

Dictionary<string, string>

关联列表编码和显示名称字典

Copyright(C)2023 HFBangFu Inc. All Rights Reserved 皖ICP备12017563号-5
收缩