Share via


SystemFilter class

Provides a base class for all system filters in the Business Data Connectivity (BDC) service.

Inheritance hierarchy

System.MarshalByRefObject
  Microsoft.SharePoint.BusinessData.Runtime.FilterBase
    Microsoft.SharePoint.BusinessData.Runtime.SystemFilter

Namespace:  Microsoft.SharePoint.BusinessData.Runtime
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
<SerializableAttribute> _
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel := True)> _
<SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel := True)> _
Public MustInherit Class SystemFilter _
    Inherits FilterBase
'Usage
Dim instance As SystemFilter
[SerializableAttribute]
[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel = true)]
public abstract class SystemFilter : FilterBase

Remarks

The BDC contains two types of filters:

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

  • System filters System-provided filters. The BDC 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 BDC:

  • 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 BDC looks up the current user's profile, reads the value of the property with this name, and plumbs that through to the external system method that is invoked.

  • SSOTicket filter Tells the BDC 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 BDC to pass the username from SSO as part of a parameter to the method call.

  • Password filter Tells the BDC 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 BDC to append the current Windows user's domain\username to the method call.

  • LastIdSeen filter Enables chunking for IDEnumerator objects. For Web services and other nonstreaming external system 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.SharePoint.BusinessData.Runtime namespace