Class QueryFilter

Namespace

Shift.Common

Assembly

Shift.Common.dll

public class QueryFilter

Inheritance

object

QueryFilter

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ExceptionExtensions.FromHierarchy<TSource>(TSource, Func<TSource, TSource>)

ExceptionExtensions.FromHierarchy<TSource>(TSource, Func<TSource, TSource>, Func<TSource, bool>)

ObjectCopier.CloneJson<T>(T)

ObjectCopier.ShallowCopyTo<TSource, TDestination>(TSource, TDestination, BindingFlags)

Constructors

QueryFilter()

public QueryFilter()

Properties

Excludes

A comma-separated list of properties to be specifically excluded from the data set.

public string Excludes { get; set; }

Property Value

string

Examples

Excludes = "IgnorePropertyA,IgnorePropertyB"

Remarks

This property can be used (optionally) to decrease the size of the data set requested by client code when there is a need decrease bandwidth usage and/or increase performance on the server by limiting the amount of work it is expected to do in building a response.

Format

Export file format (always JSON by default)

public string Format { get; set; }

Property Value

string

Includes

A comma-separated list of properties to be specifically included in the data set.

public string Includes { get; set; }

Property Value

string

Examples

Excludes = "MassivePropertyX,MassivePropertyY"

Remarks

This property can be used (optionally) to include additional information in the requested data set, when the additional data may not be included by default.

Page

The subset of items requested within a paged data set

public int Page { get; set; }

Property Value

int

Remarks

Indexing starts at one (not zero) because we want page numbers to be readable and user-friendly in URLs.

PageSize

The number of items requested per page

public int PageSize { get; set; }

Property Value

int

Sort

A comma-separated list of property names.

public string Sort { get; set; }

Property Value

string

Examples

Sort = "Age+desc,LastName+asc,FirstName"

Remarks

Here we support sorting direction specifiers "asc" and "desc" for ascending and descending. If there is no specifier then the default is to sort ascending.