FilterBase クラス (Microsoft.Office.Server.ApplicationRegistry.Runtime)

ビジネス データ カタログのフィルタで抽象基本クラスとなります。

名前空間: Microsoft.Office.Server.ApplicationRegistry.Runtime
アセンブリ: Microsoft.SharePoint.Portal (microsoft.sharepoint.portal.dll 内)

構文

'宣言
<SerializableAttribute> _
<DefaultMemberAttribute("Item")> _
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel:=True)> _
<SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel:=True)> _
Public MustInherit Class FilterBase
'使用
Dim instance As FilterBase
[SerializableAttribute] 
[DefaultMemberAttribute("Item")] 
[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel=true)] 
[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel=true)] 
public abstract class FilterBase

備考

フィルタはユーザーまたはシステムによってパラメータを取得するメソッドに付けられたコメントであり、返されるインスタンスを制限できます。メタデータ作成者が FilterDescriptor を使用してバックエンド API に対する入力パラメータ内の特定の "スロット" またはフィールドを "タグ付け" します。さらにユーザーまたはシステムがフィルタの値を設定すると、その値はメソッドの実行時にフィールドに書き込まれるため、そのフィールドの既定値が上書きされます。メソッドは 0 以上のフィルタをサポートできます。

基幹業務 (LOB) システムによって各種のフィルタリング メカニズムが提供されています。ビジネス データ カタログには、データ ソースとは関係なく、同じフィルタリング セマンティクスをユーザーに提供できるように一般的なパターンがまとめられています。ビジネス データ カタログには次のフィルタおよびフィルタリング パターンが用意されています。

  • Comparison フィルタ   指定した条件に一致した場合に返されるインスタンスを制限します。the specified condition is met.

  • ワイルドカード フィルタ   値にアスタリスク (*) のワイルドカード文字が含まれるような、フィールド値などの場合に返されるインスタンスを制限します。field like valueこのフィルタの種類を使用して、"次の文字列で始まる" や "次の値を含む" など、ユーザーにとって分かりやすいフィルタを表示することができます。

  • 制限フィルタ   返されるインスタンスの数を n 個に制限します。SQL は SELECT TOP 句によってこのフィルタをサポートしています。制限フィルタを使用することにより、長い待ち時間とタイム アウトを回避し、さらにユーザーが多量のデータを要求する不適切なクエリを実行しないようにすることもできます。

  • UserContext filter   現在のユーザーのコンテキストによってインスタンスを制限します。このフィルタは現在の Microsoft Windows ユーザーのドメインやユーザー名をメソッド呼び出しに追加するようにビジネス データ カタログに指示します。フォーム認証では、ビジネス データ カタログによってフォーム認証ユーザー名が追加されます。

  • Username filter   シングル サインオン (SSO) ユーザー名によってインスタンスを制限します。このフィルタは、SSO からのユーザー名をパラメータの一部としてメソッド呼び出しに渡すようにビジネス データ カタログに指示します。

  • Password filter   Username フィルタで使用します。このフィルタは、SSO からのパスワードをパラメータの一部としてメソッド呼び出しに渡すようにビジネス データ カタログに指示します。

    注意

    バックエンド メソッド定義では、フィルタをサポートしています。その場合に限って、状況に応じてフィルタを使用し、バックエンド アプリケーションで使用できるフロントエンド Web サーバー内の機能に反映させることができます。メタデータは、メソッドがサポートするフィルタを単に宣言します。

  • UserProfile filter   FilterDescriptor 定義で指定されます。この単純なフィルタを使用するには、フィルタの種類が "UserProfile" のものを宣言し、"UserProfilePropertyName" という名前の付いた System.String プロパティを追加します。この値はユーザー プロファイル プロパティの名前です。ビジネス データ カタログは現在のユーザーのプロファイルを検索し、この名前の付いたプロパティの値を読み込み、呼び出すバックエンド メソッド全体に組み込みます。

  • SSOTicket filter   SSO からの SSO チケットをパラメータの一部としてメソッド呼び出しに渡すようにビジネス データ カタログに指示します。

  • LastIdSeen filter   IDEnumerator オブジェクトのチャンキングを有効にします。Web サービスおよびその他の非ストリーミング バックエンド アプリケーションの場合、パフォーマンス向上のため、次のコード例に示すように、IDEnumerator オブジェクトの LastIdSeen フィルタを使用します。

    SELECT TOP 100 Id FROM Customers WHERE Id>=@LastIdSeen
    ORDER BY Id
    

継承階層

System.Object
  Microsoft.Office.Server.ApplicationRegistry.Runtime.FilterBase
     Microsoft.Office.Server.ApplicationRegistry.Runtime.SystemFilter
     Microsoft.Office.Server.ApplicationRegistry.Runtime.UserInputFilter

スレッドの安全性

この型のパブリックで静的な (Visual Basic では Shared) すべてのメンバは、スレッド セーフです。インスタンス メンバは、スレッド セーフであるとは保証されません。

関連項目

参照

FilterBase メンバ
Microsoft.Office.Server.ApplicationRegistry.Runtime 名前空間