SharePoint BCS クライアント オブジェクト モデル リファレンス
SharePointのクライアント オブジェクト モデルを使用して Business Connectivity Services (BCS)によって公開された外部データにアクセスするクライアント側スクリプトを作成するために利用できるオブジェクトについて説明します。 以下のオブジェクトは、SharePoint クライアント オブジェクト モデルを使用して、Business Connectivity Services (BCS)によって公開されている外部データにアクセスするクライアント側スクリプトを作成するために使用できます。 クライアント オブジェクト モデルに公開されている CS オブジェクト モデル コンポーネントは 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() |
プロパティ
| Property | 説明 |
|---|---|
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 |
この外部アイテムの ID を取得します |
|
Delete |
void |
外部アイテムを削除します。 |
|
ToXml |
string |
XML 形式の値を取得します。 |
|
Update |
void |
外部アイテムに加えた変更を送信します。 |
プロパティ
| プロパティ | 戻り値の型 | 説明 |
|---|---|---|
this[string fieldDotNotation] { get; set; } |
Object |
ドット表記によって参照されたフィールド値を取得または設定します。 |
RelatedSpecificFinderName { get; } |
string |
EntityView メソッド
Entity データのカスタマイズされたビューを指定します。
名前空間
| マネージ型 | 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 の名前を取得します。 |
プロパティ
| Property | 説明 |
|---|---|
| なし。 |
LobSystemInstance メソッド
名前空間
| マネージ型 | JavaScript |
|---|---|
|
Microsoft.BusinessData.MetadataModel |
SP.BusinessData |
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| なし。 |
void |
プロパティ
| Property | 説明 |
|---|---|
| なし。 |
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 |
プロパティ
| Property | 説明 |
|---|---|
| なし。 |
Identity メソッド
名前空間
| マネージ型 | JavaScript |
|---|---|
|
Microsoft.BusinessData.Runtime |
SP.BusinessData.Runtime |
コンストラクター
| コンストラクター | 説明 |
|---|---|
public Identity (Object[] identifierValues) |
識別子の値の配列を使用してクラスの新しいインスタンスを構築します。 |
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
|
Serialize |
string |
ID の文字列表現を取得します。 |
プロパティ
| プロパティ | 戻り値の型 | 説明 |
|---|---|---|
IdentifierCount { get; } |
int |
識別子の数を返します。 |
IsTemporary { get; } |
bool |
ID が一時的なものかどうか調べます。 |
this[int identifierIndex] { get; } |
オブジェクト |
所定のインデックスの要素を返します。 CSOM は int ベースのインデックス作成をサポートしません。 同じ用途で文字列ベースのアクセサーが実装されています。 |
TemporaryId { get; } |
Guid |
ID の一時的な部分を返します。 |
FieldValueDictionary メソッド
名前空間
| マネージ型 | JavaScript |
|---|---|
|
Microsoft.BusinessData.Runtime |
SP.BusinessData.Runtime |
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
|
FromXml |
void |
指定した XML からの値をこの辞書に設定します。 |
|
GetCollectionSize |
int |
ドット表記によって参照されたコレクションのサイズを返します。 |
|
ToXml |
string |
XML 形式の値を取得します。 |
プロパティ
| Property | 説明 |
|---|---|
Object this[string fieldDotNotation] { get; set; } |
ドット表記によって参照されたフィールドの値を取得または設定します。 |
EntityFieldCollection メソッド
名前空間
| マネージ型 | JavaScript |
|---|---|
|
Microsoft.BusinessData.Runtime |
SP.BusinessData.Runtime |
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| なし。 |
void |
プロパティ
| Property | 説明 |
|---|---|
| なし。 |
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 |
ブール値 |
この型記述子で読み取り専用のデータ構造を表すかどうかを指定します。 |
|
ContainsReadOnly |
ブール値 |
この型記述子または子の 1 つで読み取り専用のデータ構造を表すかどうかを指定します。 |
|
IsCollection |
ブール値 |
記述された型でコレクション データ構造を表すかどうかを指定します。 |
インターフェイス
名前空間は Microsoft.BusinessData.MetadataModel です。
| インターフェイス | 説明 |
|---|---|
|
IMetadataCatalog |
BDC オブジェクト モデルへのエントリ ポイント。 サーバー上の DatabaseBasedMetadataCatalog を使用します。 |
|
ILobSystem |
外部システムに関する詳細情報を含みます。 |
|
IEntity |
BDC Metadata Store 内の外部 コンテンツ タイプ。 |
|
IMethod |
外部 コンテンツ タイプに実行できる操作。 |
|
IEntityInstance |
エンティティ インスタンス (外部アイテムとも呼ばれる) は、BDC 内の外部システムから返される 1 つのアイテムです。 IEntityInstance インターフェイスは、基になるデータ ソースを抽象化し、アプリケーション固有のコーディング パラダイムを学習する必要からクライアントを絶縁します。これにより、すべてのビジネス データに 1 つの簡略化された方法でアクセスできます。 IEntityInstance インターフェイスを使用すると、Web サービスから返される複雑な .NET Framework 構造体を操作するのと同じ方法で、データベースのデータ行を操作できます。 BDC 内のエンティティ インスタンスには、特殊なセマンティクスが付けられています。 たとえば、行のどのフィールドがエンティティ インスタンスの識別子を表しているかを識別することができ、エンティティ インスタンス上に GetAssociated、 GetIdentifierValues、および Executeの各メソッドを呼び出すことができます。 |
|
IEntityInstanceEnumerator |
列挙子は、外部アイテム コレクション内のデータの読み取りに使用できますが、基になるコレクションの修正には使用できません。
IEntityInstanceEnumerator はストリーミングをサポートしているため、バックエンド アプリケーションが大量のデータを返す場合に非常に便利です。 |
クライアント オブジェクト モデルに関する FAQ
外部リストのクエリを実行するときに、 <Method> タグを CAML クエリに含める必要があるかどうか
いいえ。
CAML クエリでは、外部リストのすべてのフィールドを指定する必要がありますか?
BDC モデルの ViewXML タグを使用すると、開発者は必須のフィールドのみを指定でき、リスト用の CSOM API はこれらのフィールドのみを返します。