AI OnAI Off

Class ListRequest

Represents list request.

Inheritance
System.Object
Request
ListRequest
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Mediachase.BusinessFoundation.Data.Business
Assembly: Mediachase.BusinessFoundation.Data.dll
Version: 10.8.0
Syntax
public class ListRequest : Request

Constructors

ListRequest()

Initializes a new instance of the ListRequest class.

Declaration
public ListRequest()

ListRequest(EntityObject, FilterElement[])

Initializes a new instance of the ListRequest class.

Declaration
public ListRequest(EntityObject target, FilterElement[] filters)
Parameters
Type Name Description
EntityObject target

The target.
FilterElement[] filters

The filters.

ListRequest(EntityObject, FilterElement[], SortingElement[])

Initializes a new instance of the ListRequest class.

Declaration
public ListRequest(EntityObject target, FilterElement[] filters, SortingElement[] sorting)
Parameters
Type Name Description
EntityObject target

The target.
FilterElement[] filters

The filters.
SortingElement[] sorting

The sorting.

ListRequest(EntityObject, FilterElement[], SortingElement[], Nullable<Int32>, Nullable<Int32>)

Initializes a new instance of the ListRequest class.

Declaration
public ListRequest(EntityObject target, FilterElement[] filters, SortingElement[] sorting, int? start, int? count)
Parameters
Type Name Description
EntityObject target

The target.
FilterElement[] filters

The filters.
SortingElement[] sorting

The sorting.
System.Nullable<System.Int32> start

The index of first item to return.
System.Nullable<System.Int32> count

The maximum count of items to return.

ListRequest(EntityObject, SortingElement[])

Initializes a new instance of the ListRequest class.

Declaration
public ListRequest(EntityObject target, SortingElement[] sorting)
Parameters
Type Name Description
EntityObject target

The target.
SortingElement[] sorting

The sorting.

ListRequest(String, FilterElement[])

Initializes a new instance of the ListRequest class.

Declaration
public ListRequest(string metaClassName, FilterElement[] filters)
Parameters
Type Name Description
System.String metaClassName

Name of the meta class.
FilterElement[] filters

The filters.

ListRequest(String, FilterElement[], SortingElement[])

Initializes a new instance of the ListRequest class.

Declaration
public ListRequest(string metaClassName, FilterElement[] filters, SortingElement[] sorting)
Parameters
Type Name Description
System.String metaClassName

Name of the meta class.
FilterElement[] filters

The filters.
SortingElement[] sorting

The sorting.

ListRequest(String, FilterElement[], SortingElement[], Nullable<Int32>, Nullable<Int32>)

Initializes a new instance of the ListRequest class.

Declaration
public ListRequest(string metaClassName, FilterElement[] filters, SortingElement[] sorting, int? start, int? count)
Parameters
Type Name Description
System.String metaClassName

Name of the meta class.
FilterElement[] filters

The filters.
SortingElement[] sorting

The sorting.
System.Nullable<System.Int32> start

The index of first item to return.
System.Nullable<System.Int32> count

The maximum count of items to return.

ListRequest(String, SortingElement[])

Initializes a new instance of the ListRequest class.

Declaration
public ListRequest(string metaClassName, SortingElement[] sorting)
Parameters
Type Name Description
System.String metaClassName

Name of the meta class.
SortingElement[] sorting

The sorting.

Fields

CountParameter

Declaration
public const string CountParameter = "Count"
Field Value
Type Description
System.String

FiltersParameter

Declaration
public const string FiltersParameter = "Filters"
Field Value
Type Description
System.String

SortingParameter

Declaration
public const string SortingParameter = "Sorting"
Field Value
Type Description
System.String

StartParameter

Declaration
public const string StartParameter = "Start"
Field Value
Type Description
System.String

Properties

Count

Gets or sets the maximum count of items to return.

Declaration
public int? Count { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

New value.

Filters

Gets or sets the filters.

Declaration
public FilterElement[] Filters { get; set; }
Property Value
Type Description
FilterElement[]

The filters.

Sorting

Gets or sets the sorting.

Declaration
public SortingElement[] Sorting { get; set; }
Property Value
Type Description
SortingElement[]

The sorting.

Start

Gets or sets the index of first item to return.

Declaration
public int? Start { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

New value.