UserInputFilter class

Provides a base class for all user input filters that the Business Data Connectivity (BDC) service supports.

Inheritance hierarchy

System.MarshalByRefObject
  Microsoft.SharePoint.BusinessData.Runtime.FilterBase
    Microsoft.SharePoint.BusinessData.Runtime.UserInputFilter
      Microsoft.SharePoint.BusinessData.Runtime.ComparisonFilter
      Microsoft.SharePoint.BusinessData.Runtime.LimitFilter
      Microsoft.SharePoint.BusinessData.Runtime.PageNumberFilter
      Microsoft.SharePoint.BusinessData.Runtime.SortingFilter

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

Syntax

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

Remarks

BDC supports two types of filters:

  • User input filters User input filters require users to provide filter values just as the Comparison, Limit, and Wildcardfilters.

  • System filters System filters are system-provided.

Following are the user input filters that BDC supports:

  • Limit filter   Limits the number of instances returned to n. SQL supports this filter with the SELECT TOP clause. By using a Limit filter, you can prevent long waits, timeouts, and users from issuing bad queries that request large amounts of data.

  • Comparison filter   Takes an operator and a condition and returns only the instances that meet the condition.

  • Wildcard filter   Limits the instances returned to fields such as value, where value may contain the asterisk (*) wildcard character. Users can use this filter type to present more user-friendly filters such as "starts with" and "contains."

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

UserInputFilter members

Microsoft.SharePoint.BusinessData.Runtime namespace