Click or drag to resize

DataFilter Structure

A simple filter abstraction layer used to provide a mechanism by which methods can make simple filter calls to various models.
Inheritance Hierarchy
SystemObject
  SystemValueType
    AppOne.Services.V2DataFilter

Namespace: AppOne.Services.V2
Assembly: AppOne.Web.Service (in AppOne.Web.Service.dll) Version: 1.0.141
Syntax
Copy
public struct DataFilter

The DataFilter type exposes the following members.

Properties
 NameDescription
Public propertyHideValues The setting works in direct correlation with the Values property. If true the values that are passed in will not be shown in the data result, if false then only the filter values that match the criteria will show in the data result.
Public propertyName The name of the data filter to use. This value will be documented for each and every service contract that uses the DataFilter name.
Public propertyValues A generic list of string values. These values are defined by the name of the DataFilter and are different for each and every service call.
Top
Remarks
The DataFilter structure allows a filter to be applied to the various contracts that implement them. The DataFilter Name is the property that will determine how the filter is used. Every contract that implements the DataFilter Name will have a unique set of values that it supports and will be documented with each contract.

Note  Note
The DataAction structure and DataFilter structure play similar roles in filtering the data returned from a service call. The big difference is that the DataAction is a direct query to the underlying model, whereas the DataFilter is a post filtration operation that filters data already returned by the service. The DataFilter can still decrease the size of your Results, but the bigger performance increase will be found by using the DataAction structure if a possible query name exists.
Example
JavaScript
Copy
{
    //Sub-Sample of the DataFilter
    "DataFilter":{
       "Name":"BY-CODE",
       "HideValues":true,
       "Values":["CO"],
       "Enabled":false
    }
 }
See Also