SharePoint 的 BCS 客户端对象模型引用

了解可用于使用 SharePoint 客户端对象模型创建客户端脚本以访问 Business Connectivity Services (BCS) 揭示的外部数据的对象。 以下对象可用于使用 SharePoint 客户端对象模型创建客户端脚本以访问 Business Connectivity Services (BCS) 揭示的外部数据。 向该客户端对象模型公开的 BCS 对象模型组件位于 Microsoft.SharePoint.Client.dll。

Entity 对象

Entity 对象实质上表示数据库中的表。 此处提供的方法和属性显示了通过使用客户端代码库可以操作的对象。 其中每个调用都直接映射到服务器对象模型调用。 但是，它们可由分离的客户端调用，例如在使用 JavaScript 的 Web 浏览器中。

方法

方法	方法签名	说明
Create	Identity Create(FieldValueDictionary fieldValues, LobSystemInstance lobSystemInstanceName)
FindSpecificDefault	EntityInstance FindSpecificDefault(Identity identity, LobSystemInstance lobSystemInstanceName)
FindspecificByBdcIDDefault	EntityInstance FindSpecific(Identity identity, string specificFinderName, LobSystemInstance lobSystemInstanceName)
FindSpecificByBdcID	EntityInstance FindSpecificByBdcIDDefault(string BdcIdentity, LobSystemInstance lobSystemInstanceName)
GetCreatorView	EntityInstance FindSpecificByBdcID(string BdcIdentity, string specificFinderName,LobSystemInstance LobSystemInstanceName)
GetDefaultSpecificFinderView	View GetCreatorView(string methodInstanceName)
GetSpecificFinderView_Client	View GetDefaultSpecificFinderView()
GetUpdaterView_Client	View GetSpecificFinderView_Client( string specificFinderName)
GetIdentifiers	View GetUpdaterView_Client(string updaterName)
GetIdentifiers()

属性

属性	说明
long EstimatedInstanceCount { get; }	获取此种外部内容类型的预期外部项的数量。
string Name { get; }	获取元数据对象的名称。
string Namespace { get; }	获取给定数据类的命名空间。
int GetIdentifierCount()

EntityInstance 方法

命名空间

托管	JavaScript
Microsoft.BusinessData.Runtime	SP.BusinessData.Runtime

方法

方法	返回类型	说明
Delete	void	删除外部项
FromXml	void	设置此种来自指定 XML 的词典中的值。 方法签名FromXml(string xml)
GetIdentity	Identity	获取此外部项的标识。
Delete	void	删除该外部项。
ToXml	string	检索 XML 格式的值。
Update	void	提交对外部项进行的更改。

属性

属性	返回类型	说明
this[string fieldDotNotation] { get; set; }	对象	获取或设置点标记所值的字段的值。
RelatedSpecificFinderName { get; }	string

EntityView 方法

指定“实体”数据的自定义视图

命名空间

托管	JavaScript
Microsoft.BusinessData.MetadataModel	SP.BusinessData

方法

方法	返回类型	说明
GetDefaultValues_Client()	FieldValueDictionary	获取包含此视图的默认值的字段值词典。
GetXmlSchema()	string	获取该视图的 XML 架构。
GetType(string fieldDotNotation)	string	获取指定字段的类型。
GetType(string fieldDotNotation)	TypeDescriptor	获取与给定点标记相对应的 TypeDescriptor 对象。

属性

属性	返回类型	说明
Fields { get; }	FieldCollection	获取该视图中的字段的集合。
Name { get; }	string	获取 View 对象的名称。
RelatedSpecificFinderName { get; }	string	检索此视图连接到的特定的查找程序 MethodInstance 的名称。

LobSystem 方法

命名空间

托管	JavaScript
Microsoft.BusinessData.MetadataModel	SP.BusinessData

方法

方法	返回类型	说明
GetLobSystemInstances()	void	获取 LOB 系统实例的列表。
名称	void	获取 LobSystem 的名称。

属性

属性	说明
无。

LobSystemInstance 方法

命名空间

托管	JavaScript
Microsoft.BusinessData.MetadataModel	SP.BusinessData

方法

方法	返回类型	说明
无。	void

属性

属性	说明
无。

Identifier 方法

命名空间

托管	JavaScript
Microsoft.BusinessData.MetadataModel	SP.BusinessData

方法

方法	返回类型	说明
ContainsLocalizedDisplayName	bool	确定该元数据对象是否包含本地化的显示名称。
GetDefaultDisplayName	string	返回默认显示名称。
GetLocalizedDisplayName	string	返回本地化的显示名称。

属性

属性	返回类型	说明
IdentifierType {get;}	string	返回标识符的类型。
Name {get;}	string	获取该标识符的名称。

IdentifierCollection 方法

命名空间

托管	JavaScript
Microsoft.BusinessData.MetadataModel.Collections	SP.BusinessData.Collections

方法

方法	返回类型	说明
无。	void

属性

属性	说明
无。

Identify 方法

命名空间

托管	JavaScript
Microsoft.BusinessData.Runtime	SP.BusinessData.Runtime

构造函数

构造函数	说明
public Identity (Object[] identifierValues)	使用一组标识符值构造该类的新实例。

方法

方法	返回类型	说明
Serialize	string	获取该标志的字符串表示。

属性

属性	返回类型	说明
IdentifierCount { get; }	int	返回标识符的数量。
IsTemporary { get; }	bool	检查该标识是否是暂时的。
this[int identifierIndex] { get; }	对象	检索给定索引处的元素。 CSOM 不支持基于 INT 的索引。 基于字符串的访问器为了相同的目的实现。
TemporaryId { get; }	Guid	返回该标识的临时部分。

FieldValueDictionary 方法

命名空间

托管	JavaScript
Microsoft.BusinessData.Runtime	SP.BusinessData.Runtime

方法

方法	返回类型	说明
FromXml	void	设置此种来自指定 XML 的词典中的值。
GetCollectionSize	int	返回点标记所指的集合的大小。
ToXml	string	检索 XML 格式的值。

属性

属性	说明
Object this[string fieldDotNotation] { get; set; }	获取或设置点标记所值的字段的值。

EntityFieldCollection 方法

命名空间

托管	JavaScript
Microsoft.BusinessData.Runtime	SP.BusinessData.Runtime

方法

方法	返回类型	说明
无。	void

属性

属性	说明
无。

EntityField 方法

命名空间

托管	JavaScript
Microsoft.BusinessData.Runtime	SP.BusinessData.Runtime

方法

方法	返回类型	说明
无。	void

属性

属性	返回类型	只读	说明
ContainsLocalizedDisplayName	Boolean	是	确定该字段是否包含本地化的显示名称。
DefaultDisplayName	string	是	检索该字段的默认显示名称。
GetLocalizedDisplayName	string		检索该字段的本地化显示名称。
名称	string	是	检索该字段的名称。

TypeDescriptor 类

命名空间

托管	JavaScript
Microsoft.BusinessData.MetadataModel	SP.BusinessData

方法

方法	返回类型	只读	说明
ContainsLocalizedDisplayName()	Boolean	是	确定该类型描述符是否包含本地化的显示名称。
GetLocalizedDisplayName()	string	是	返回本地化的显示名称。
GetDefaultDisplayName()	string		返回默认显示名称。

属性

属性	返回类型	说明
名称	string	检索该字段的名称。
TypeName	string	检索此类型描述符表示的数据类型的名称。
IsReadOnly	Boolean	确定此类型描述符是否表示只读数据结构。
ContainsReadOnly	Boolean	确定此类型描述符或其某个子级是否表示只读数据结构。
IsCollection	Boolean	确定所描述的类型是否表示集合数据结构。

接口

命名空间为 Microsoft.BusinessData.MetadataModel。

接口	说明
IMetadataCatalog	该入口指向了 BDC 对象模型。 使用该服务器上的 DatabaseBasedMetadataCatalog。
ILobSystem	获取有关外部系统的详细情况。
IEntity	BDC 元数据库中的外部内容类型。
IMethod	可以在外部内容类型上执行的操作。
IEntityInstance	实体实例（也称作外部项）是从 BDC 中的外部系统返回的单个项。 IEntityInstance 接口提取了基本数据源并阐明了必须学习特定于应用程序的编码范例的客户端；这使得它们能通过单一、简单的方式访问所有业务数据。 通过使用 IEntityInstance 接口，您可以使用数据基中的一行数据，就和使用 Web 服务返回的复杂的 .NET Framework 结构的方法一样。 BDC 中实体实例上附加了特殊的语义。 例如，它可以知道该行的哪个字段或哪些字段表示该实体实例的标识符，它还能使您在该实体实例上调用 GetAssociated、 GetIdentifierValues 和 Execute 等方法。
IEntityInstanceEnumerator	枚举器可用于读取外部项集合中的数据，但是不能用于修改基础集合。 IEntityInstanceEnumerator 支持流式处理，因此，当后端应用程序返回大量数据时，它非常有用。

Client Object model FAQ

• <查询外部列表时，是否需要将方法>标记包含在 CAML 查询中

  不正确。

• Do all fields in the external list need to be specified in the CAML query?

  Using the ViewXML tag in the BDC model, the developer can specify only those fields that are required and the CSOM APIs for Lists will return only those fields.

另请参阅

• SharePoint 的 Business Connectivity Services 程序员参考

• SharePoint 的 .NET 客户端 API 引用

• 在 SharePoint 中使用具有外部数据的客户端对象模型入门

• 如何：使用客户端代码库访问 SharePoint 中的外部数据

• SharePoint 中的 Business Connectivity Services 的新增功能

• SharePoint 中的业务连续性服务入门