Class BasicItemFilter

Represents a filter for retrieving basic items.

Inheritance

object

BasicItemFilter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DataWeb.Structure

Assembly: DataWeb.Core.dll

Syntax

public class BasicItemFilter

Properties

Count

Gets or sets the count of items to retrieve.

Declaration

public int Count { get; set; }

Property Value

Type	Description
int

Id

Gets or sets the unique identifier.

Declaration

public string Id { get; set; }

Property Value

Type	Description
string

Ids

Gets or sets a list of item Ids to retrieve.

Declaration

public List<string> Ids { get; set; }

Property Value

Type	Description
List<string>

IsDeletedIncluded

Gets all the items, deleted included.

Declaration

public bool? IsDeletedIncluded { get; set; }

Property Value

Type	Description
bool?

IsPagination

Gets or sets a value indicating whether pagination is used.

Declaration

public bool IsPagination { get; set; }

Property Value

Type	Description
bool

OrderDataFields

Gets or sets the data fields used to order the context item.

Declaration

public List<BasicItemFilter.OrderDataField> OrderDataFields { get; set; }

Property Value

Type	Description
List<BasicItemFilter.OrderDataField>

PageIndex

Gets or sets the page index used for pagination.

Declaration

public long PageIndex { get; set; }

Property Value

Type	Description
long

PageSize

Gets or sets the page size used for pagination.

Declaration

public int PageSize { get; set; }

Property Value

Type	Description
int

RelationDataField

Gets or sets the name of the relation data field.

Declaration

public string RelationDataField { get; set; }

Property Value

Type	Description
string

RelationId

Gets or sets the id of the relation.

Declaration

public string RelationId { get; set; }

Property Value

Type	Description
string

SearchDataFields

Gets or sets the data fields used to search for the context item.

Declaration

public List<BasicItemFilter.FilterDataField> SearchDataFields { get; set; }

Property Value

Type	Description
List<BasicItemFilter.FilterDataField>

Status

Gets or sets the status used to filter the item.

Declaration

public string Status { get; set; }

Property Value

Type	Description
string