Share via

SystemFilter Class

  • Article

Provides a base class for all system filters in the Business Data Catalog.

Inheritance Hierarchy

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

Namespace:  Microsoft.Office.Server.ApplicationRegistry.Runtime
Assembly:  Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)

Syntax

'Declaration
<SerializableAttribute> _
<SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel := True)> _
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel := True)> _
Public MustInherit Class SystemFilter _
    Inherits FilterBase

'Usage
Dim instance As SystemFilter

[SerializableAttribute]
[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel = true)]
[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
public abstract class SystemFilter : FilterBase

Remarks

The Business Data Catalog contains two types of filters:

  • User Input filters

  • System filters

User Input filters require users to provide filter values such as the Comparison, Limit and Wildcard filters.

  • System filters are system-provided. The Business Data Catalog populates their values as the very last thing it does before the actual execution. These values are securely set and it is not possible to override them.

  • Following are the system filters that are provided by the Business Data Catalog:

  • UserProfile filter   Specified in the FilterDescriptor definition. To use this simple filter, declare a filter of the type "UserProfile" and add a System.String property with the name "UserProfilePropertyName", whose value is the name of a user profile property. The Business Data Catalog looks up the current user's profile, reads the value of the property with this name, and plumbs that through to the back-end method that is invoked.

  • SSOTicket filter   Tells the Business Data Catalog to pass the single sign-on (SSO) ticket from SSO as part of a parameter to the method call.

  • Username filter   Limits the instances by an SSO username. This filter tells the Business Data Catalog to pass the username from SSO as part of a parameter to the method call.

  • Password filter   Tells the Business Data Catalog to pass the password from SSO as part of a parameter to the method call.

  • UserContext filter   Limits the instances by the current user's context. This filter tells Business Data Catalog to append the current Microsoft Windows user's domain\username to the method call.

  • LastIdSeen filter   Enables chunking for IDEnumerator objects. For Web services and other non-streaming back-end applications, use the LastIdSeen filter in your IDEnumerator object.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

SystemFilter Members

Microsoft.Office.Server.ApplicationRegistry.Runtime Namespace