UserInputFilter Class

  • Article

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

Inheritance Hierarchy

System.Object
  Microsoft.Office.Server.ApplicationRegistry.Runtime.FilterBase
    Microsoft.Office.Server.ApplicationRegistry.Runtime.UserInputFilter
      Microsoft.Office.Server.ApplicationRegistry.Runtime.ComparisonFilter
      Microsoft.Office.Server.ApplicationRegistry.Runtime.LimitFilter

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 UserInputFilter _
    Inherits FilterBase

'Usage
Dim instance As UserInputFilter

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

Remarks

There are two kinds of filters in the Business Data Catalog:

  • User Input filters

  • System filters

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

  • System filters are system-provided. Following are the User Input filters that Business Data Catalog 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, time outs, 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 those where field like 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.Office.Server.ApplicationRegistry.Runtime Namespace