Class PageableSelectOptions

Parameters of the paged output of the query results.

Inheritance

System.Object

PageableSelectOptions

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: Terrasoft.Core.DB

Assembly: Terrasoft.Core.dll

Syntax

public class PageableSelectOptions

Constructors

PageableSelectOptions()

Initializes a new PageableSelectOptions instance.

Declaration

public PageableSelectOptions()

PageableSelectOptions(Int32, PageableSelectDirection)

Initializes a new PageableSelectOptions instance with the specified number of records in the page of data and the direction of the paged output.

Declaration

public PageableSelectOptions(int rowCount, PageableSelectDirection direction)

Parameters

Type	Name	Description
System.Int32	rowCount	Number of records in the page of data.
PageableSelectDirection	direction	Direction of the paged output.

PageableSelectOptions(String, String, Object, Int32)

Initializes a new PageableSelectOptions instance with the specified parameters.

Declaration

public PageableSelectOptions(string primaryConditionColumnName, string primaryConditionLastValueParameterName, object primaryConditionLastValueParameterValue, int rowCount)

Parameters

Type	Name	Description
System.String	primaryConditionColumnName	The name of the column for which the query condition is added.
System.String	primaryConditionLastValueParameterName	The name of the parameter that contains the saved value of the last record of the previous page.
System.Object	primaryConditionLastValueParameterValue	The value of the last record in the previous page.
System.Int32	rowCount	Number of records in the page of data.

PageableSelectOptions(String, String, Object, Int32, PageableSelectDirection)

Initializes a new PageableSelectOptions instance with the specified parameters.

Declaration

public PageableSelectOptions(string primaryConditionColumnName, string primaryConditionLastValueParameterName, object primaryConditionLastValueParameterValue, int rowCount, PageableSelectDirection direction)

Parameters

Type	Name	Description
System.String	primaryConditionColumnName	The name of the column for which the query condition is added.
System.String	primaryConditionLastValueParameterName	The name of the parameter that contains the value of the last record of the previous data page.
System.Object	primaryConditionLastValueParameterValue	The value of the last record in the previous page of data.
System.Int32	rowCount	Number of records in the page of data.
PageableSelectDirection	direction	Direction of the paged output.

PageableSelectOptions(String, String, Object, String, Int32)

Initializes a new PageableSelectOptions instance with the specified parameters.

Declaration

public PageableSelectOptions(string primaryConditionColumnName, string primaryConditionLastValueParameterName, object primaryConditionLastValueParameterValue, string primaryConditionLastValueParameterValueTypeName, int rowCount)

Parameters

Type	Name	Description
System.String	primaryConditionColumnName	The name of the column for which the query condition is added.
System.String	primaryConditionLastValueParameterName	The name of the parameter that contains the saved value of the last record of the previous data page.
System.Object	primaryConditionLastValueParameterValue	The value of the last record in the previous page.
System.String	primaryConditionLastValueParameterValueTypeName	The name of the data type of the value of the last record in the previous page.
System.Int32	rowCount	Number of records in the page of data.

PageableSelectOptions(String, String, Object, String, Int32, PageableSelectDirection)

Initializes a new PageableSelectOptions instance with the specified parameters.

Declaration

public PageableSelectOptions(string primaryConditionColumnName, string primaryConditionLastValueParameterName, object primaryConditionLastValueParameterValue, string primaryConditionLastValueParameterValueTypeName, int rowCount, PageableSelectDirection direction)

Parameters

Type	Name	Description
System.String	primaryConditionColumnName	The name of the column for which the query condition is added.
System.String	primaryConditionLastValueParameterName	The name of the parameter that contains the value of the last record of the previous page.
System.Object	primaryConditionLastValueParameterValue	The value of the last record in the previous page.
System.String	primaryConditionLastValueParameterValueTypeName	The name of the data type of the value of the last record in the previous page.
System.Int32	rowCount	Number of records in the page of data.
PageableSelectDirection	direction	Direction of the paged output.

PageableSelectOptions(String, String, Object, DataValueType, Int32)

Initializes a new PageableSelectOptions instance with the specified parameters.

Declaration

public PageableSelectOptions(string primaryConditionColumnName, string primaryConditionLastValueParameterName, object primaryConditionLastValueParameterValue, DataValueType primaryConditionLastValueParameterValueType, int rowCount)

Parameters

Type	Name	Description
System.String	primaryConditionColumnName	The name of the column for which the query condition is added.
System.String	primaryConditionLastValueParameterName	The name of the parameter that contains the saved value of the last record of the previous page.
System.Object	primaryConditionLastValueParameterValue	The value of the last record in the previous page.
DataValueType	primaryConditionLastValueParameterValueType	The data type of the value of the last record in the previous page.
System.Int32	rowCount	Number of records in the page of data.

PageableSelectOptions(String, String, Object, DataValueType, Int32, PageableSelectDirection)

Initializes a new PageableSelectOptions instance with the specified parameters.

Declaration

public PageableSelectOptions(string primaryConditionColumnName, string primaryConditionLastValueParameterName, object primaryConditionLastValueParameterValue, DataValueType primaryConditionLastValueParameterValueType, int rowCount, PageableSelectDirection direction)

Parameters

Type	Name	Description
System.String	primaryConditionColumnName	The name of the column for which the query condition is added.
System.String	primaryConditionLastValueParameterName	The name of the parameter that contains the value of the last record of the previous page.
System.Object	primaryConditionLastValueParameterValue	The value of the last record in the previous page.
DataValueType	primaryConditionLastValueParameterValueType	The data type of the value of the last record in the previous page of data.
System.Int32	rowCount	Number of records in the page of data.
PageableSelectDirection	direction	Direction of the paged output.

PageableSelectOptions(PageableSelectCondition, Int32, PageableSelectDirection)

Initializes a new PageableSelectOptions instance with the specified parameters.

Declaration

public PageableSelectOptions(PageableSelectCondition primaryCondition, int rowCount, PageableSelectDirection direction)

Parameters

Type	Name	Description
PageableSelectCondition	primaryCondition	The query condition.
System.Int32	rowCount	Number of records in the page of data.
PageableSelectDirection	direction	Direction of the paged output.

PageableSelectOptions(PageableSelectOptions)

Initializes a new PageableSelectOptions instance that is a clone of the passed-in instance.

Declaration

public PageableSelectOptions(PageableSelectOptions source)

Parameters

Type	Name	Description
PageableSelectOptions	source	The PageableSelectOptions instance whose clone is being created.

PageableSelectOptions(QueryColumnExpression, String, Object, Int32)

Initializes a new PageableSelectOptions instance with the specified parameters.

Declaration

public PageableSelectOptions(QueryColumnExpression primaryConditionSourceExpression, string primaryConditionLastValueParameterName, object primaryConditionLastValueParameterValue, int rowCount)

Parameters

Type	Name	Description
QueryColumnExpression	primaryConditionSourceExpression	The expression of the column for which the query condition is added.
System.String	primaryConditionLastValueParameterName	The name of the parameter that contains the value of the last record of the previous page.
System.Object	primaryConditionLastValueParameterValue	The value of the last record in the previous page of data.
System.Int32	rowCount	Number of records in the page of data.

PageableSelectOptions(QueryColumnExpression, String, Object, Int32, PageableSelectDirection)

Initializes a new PageableSelectOptions instance with the specified parameters.

Declaration

public PageableSelectOptions(QueryColumnExpression primaryConditionSourceExpression, string primaryConditionLastValueParameterName, object primaryConditionLastValueParameterValue, int rowCount, PageableSelectDirection direction)

Parameters

Type	Name	Description
QueryColumnExpression	primaryConditionSourceExpression	The expression of the column for which the query condition is added.
System.String	primaryConditionLastValueParameterName	The name of the parameter that contains the saved value of the last record of the previous data page.
System.Object	primaryConditionLastValueParameterValue	The value of the last record in the previous page.
System.Int32	rowCount	Number of records in the page of data.
PageableSelectDirection	direction	Direction of the paged output.

PageableSelectOptions(QueryColumnExpression, String, Object, String, Int32)

Initializes a new PageableSelectOptions instance with the specified parameters.

Declaration

public PageableSelectOptions(QueryColumnExpression primaryConditionSourceExpression, string primaryConditionLastValueParameterName, object primaryConditionLastValueParameterValue, string primaryConditionLastValueParameterValueTypeName, int rowCount)

Parameters

Type	Name	Description
QueryColumnExpression	primaryConditionSourceExpression	The expression of the column for which the query condition is added.
System.String	primaryConditionLastValueParameterName	The name of the parameter that contains the value of the last record of the previous data page.
System.Object	primaryConditionLastValueParameterValue	The value of the record in the previous page of data.
System.String	primaryConditionLastValueParameterValueTypeName	The name of the type of the value of the last record in the previous data page.
System.Int32	rowCount	Number of records in the page of data.

PageableSelectOptions(QueryColumnExpression, String, Object, String, Int32, PageableSelectDirection)

Initializes a new PageableSelectOptions instance with the specified parameters.

Declaration

public PageableSelectOptions(QueryColumnExpression primaryConditionSourceExpression, string primaryConditionLastValueParameterName, object primaryConditionLastValueParameterValue, string primaryConditionLastValueParameterValueTypeName, int rowCount, PageableSelectDirection direction)

Parameters

Type	Name	Description
QueryColumnExpression	primaryConditionSourceExpression	The expression of the column for which the query condition is added.
System.String	primaryConditionLastValueParameterName	The name of the parameter that contains the value of the last record of the previous data page.
System.Object	primaryConditionLastValueParameterValue	The value of the last record in the previous page of data.
System.String	primaryConditionLastValueParameterValueTypeName	The name of the data type of the value of the last record in the previous data page.
System.Int32	rowCount	Number of records in the page of data.
PageableSelectDirection	direction	Direction of the paged output.

PageableSelectOptions(QueryColumnExpression, String, Object, DataValueType, Int32)

Initializes a new PageableSelectOptions instance with the specified parameters.

Declaration

public PageableSelectOptions(QueryColumnExpression primaryConditionSourceExpression, string primaryConditionLastValueParameterName, object primaryConditionLastValueParameterValue, DataValueType primaryConditionLastValueParameterValueType, int rowCount)

Parameters

Type	Name	Description
QueryColumnExpression	primaryConditionSourceExpression	The expression of the column for which the query condition is added.
System.String	primaryConditionLastValueParameterName	The name of the parameter that contains the value of the last record of the previous page.
System.Object	primaryConditionLastValueParameterValue	The value of the record in the previous page of data.
DataValueType	primaryConditionLastValueParameterValueType	The data type of the value of the last record in the previous page of data.
System.Int32	rowCount	Number of records in the page of data.

PageableSelectOptions(QueryColumnExpression, String, Object, DataValueType, Int32, PageableSelectDirection)

Initializes a new PageableSelectOptions instance with the specified parameters.

Declaration

public PageableSelectOptions(QueryColumnExpression primaryConditionSourceExpression, string primaryConditionLastValueParameterName, object primaryConditionLastValueParameterValue, DataValueType primaryConditionLastValueParameterValueType, int rowCount, PageableSelectDirection direction)

Parameters

Type	Name	Description
QueryColumnExpression	primaryConditionSourceExpression	The expression of the column for which the query condition is added.
System.String	primaryConditionLastValueParameterName	The name of the parameter that contains the saved value of the last record of the previous data page.
System.Object	primaryConditionLastValueParameterValue	The value of the last record in the previous page of data.
DataValueType	primaryConditionLastValueParameterValueType	The data type of the value of the last page of data.
System.Int32	rowCount	Number of records in the page of data.
PageableSelectDirection	direction	Direction of the paged output.

Properties

Direction

Direction of the paged output.

Declaration

public PageableSelectDirection Direction { get; set; }

Property Value

Type	Description
PageableSelectDirection

HasOrderByItemsConditions

Specifies whether the query contains conditions for the expressions by which the query results are sorted.

Declaration

public bool HasOrderByItemsConditions { get; }

Property Value

Type	Description
System.Boolean

HasPrimaryCondition

Determines whether the query with the paged output has a primary condition.

Declaration

public bool HasPrimaryCondition { get; }

Property Value

Type	Description
System.Boolean

OrderByItemsConditions

The collection of conditions for expressions by which the query results are sorted.

Declaration

public Collection<PageableSelectCondition> OrderByItemsConditions { get; }

Property Value

Type	Description
System.Collections.ObjectModel.Collection<PageableSelectCondition>

PrimaryCondition

The primary condition for the query with the paged output.

Declaration

public PageableSelectCondition PrimaryCondition { get; }

Property Value

Type	Description
PageableSelectCondition

RowCount

Number of records in the page of data.

Declaration

public int RowCount { get; set; }

Property Value

Type	Description
System.Int32

RowsOffset

Number of rows to skip.

Declaration

public int RowsOffset { get; set; }

Property Value

Type	Description
System.Int32

Methods

AddCondition(String, String, Object)

Adds a condition with the specified properties for the column expression with the specified name, by which the results of the query will be sorted.

Declaration

public PageableSelectCondition AddCondition(string columnName, string lastValueParameterName, object lastValueParameterValue)

Parameters

Type	Name	Description
System.String	columnName	The name of the column for which the expression of the left side of the condition is added.
System.String	lastValueParameterName	The name of the parameter that defines the value of the last record of the previous data page.
System.Object	lastValueParameterValue	The value of the last record in the previous page of data.

Returns

Type	Description
PageableSelectCondition	Condition for the expression of query results sorting.

AddCondition(String, String, Object, String)

Adds a condition with the specified properties for the column expression with the specified name, by which the results of the query will be sorted.

Declaration

public PageableSelectCondition AddCondition(string columnName, string lastValueParameterName, object lastValueParameterValue, string lastValueParameterValueTypeName)

Parameters

Type	Name	Description
System.String	columnName	The name of the column for which the expression of the left side of the condition is added.
System.String	lastValueParameterName	The name of the parameter that defines the value of the last record of the previous data page.
System.Object	lastValueParameterValue	The value of the last record in the previous page of data.
System.String	lastValueParameterValueTypeName	The name of the data type of the value of the last record in the page of data.

Returns

Type	Description
PageableSelectCondition	Condition for the expression of query results sorting.

AddCondition(String, String, Object, DataValueType)

Adds a condition with the specified properties for the column expression with the specified name, by which the results of the query will be sorted.

Declaration

public PageableSelectCondition AddCondition(string columnName, string lastValueParameterName, object lastValueParameterValue, DataValueType lastValueParameterValueType)

Parameters

Type	Name	Description
System.String	columnName	The name of the column for which the expression of the left side of the condition is added.
System.String	lastValueParameterName	The name of the parameter that defines the value of the last record of the previous data page.
System.Object	lastValueParameterValue	The value of the last record in the previous page of data.
DataValueType	lastValueParameterValueType	The data type of the value of the last record in the previous page of data.

Returns

Type	Description
PageableSelectCondition	Condition for the expression of query results sorting.

AddCondition(String, String, String, Object, String)

Adds a condition with the specified properties to express the column with the specified name from the specified source, by which the results of the query will be sorted.

Declaration

public PageableSelectCondition AddCondition(string sourceAlias, string sourceColumnName, string lastValueParameterName, object lastValueParameterValue, string lastValueParameterValueTypeName)

Parameters

Type	Name	Description
System.String	sourceAlias	The alias of the source.
System.String	sourceColumnName	The name of the column for which the expression of the left side of the condition is added.
System.String	lastValueParameterName	The name of the parameter that determines the value of the last record in the page of data.
System.Object	lastValueParameterValue	The value of the last record in the previous page of data.
System.String	lastValueParameterValueTypeName	The name of the value type of the last record in the page of data.

Returns

Type	Description
PageableSelectCondition	Condition for the expression of query results sorting.

AddCondition(String, String, String, Object, DataValueType)

Adds a condition with the specified properties to express the column with the specified name from the specified source, by which the results of the query will be sorted.

Declaration

public PageableSelectCondition AddCondition(string sourceAlias, string sourceColumnName, string lastValueParameterName, object lastValueParameterValue, DataValueType lastValueParameterValueType)

Parameters

Type	Name	Description
System.String	sourceAlias	The alias of the source.
System.String	sourceColumnName	The name of the column for which the expression of the left side of the condition is added.
System.String	lastValueParameterName	The name of the parameter that determines the value of the last record in the page of data.
System.Object	lastValueParameterValue	The value of the last record in the previous page of data.
DataValueType	lastValueParameterValueType	The data type of the value of the last record in the page of data.

Returns

Type	Description
PageableSelectCondition	Condition for the expression of query results sorting.

AddCondition(QueryColumnExpression, OrderByItem, QueryParameter)

Adds the condition with the specified properties for the passed-in expression of query results sorting.

Declaration

public PageableSelectCondition AddCondition(QueryColumnExpression leftExpression, OrderByItem orderByItem, QueryParameter lastValueParameter)

Parameters

Type	Name	Description
QueryColumnExpression	leftExpression	Expression of the left side of the condition.
OrderByItem	orderByItem	The expression used for sorting the query results.
QueryParameter	lastValueParameter	The parameter that determines the value of the last record in the previous page of data.

Returns

Type	Description
PageableSelectCondition	Condition for the orderByItem sort expression.

AddCondition(QueryColumnExpression, QueryParameter)

Adds a condition with the specified properties for the expressions by which the results of the query will be sorted.

Declaration

public PageableSelectCondition AddCondition(QueryColumnExpression leftExpression, QueryParameter lastValueParameter)

Parameters

Type	Name	Description
QueryColumnExpression	leftExpression	Expression of the left side of the condition.
QueryParameter	lastValueParameter	The parameter that determines the value of the last record in the previous page of data.

Returns

Type	Description
PageableSelectCondition	Condition for the expressions of query results sorting.

SetPrimaryConditionProperties(QueryColumnExpression, String, Object)

Sets properties of the primary condition of the query with paged output to the passed-in values.

Declaration

public void SetPrimaryConditionProperties(QueryColumnExpression leftExpression, string lastValueParameterName, object lastValueParameterValue)

Parameters

Type	Name	Description
QueryColumnExpression	leftExpression	Expression of the left side of the condition.
System.String	lastValueParameterName	The name of the parameter of the value of the last record in the previous page of data.
System.Object	lastValueParameterValue	The value of the primary last record in the previous page of data.

SetPrimaryConditionProperties(QueryColumnExpression, String, Object, String)

Sets properties of the primary condition of the query with paged output to the passed-in values.

Declaration

public void SetPrimaryConditionProperties(QueryColumnExpression leftExpression, string lastValueParameterName, object lastValueParameterValue, string lastValueParameterValueTypeName)

Parameters

Type	Name	Description
QueryColumnExpression	leftExpression	Expression of the left side of the condition.
System.String	lastValueParameterName	The name of the parameter of the value of the last record in the previous page of data.
System.Object	lastValueParameterValue	The value of the last record in the previous page of data.
System.String	lastValueParameterValueTypeName	The name of the data type of the value of the last record in the previous data page.

SetPrimaryConditionProperties(QueryColumnExpression, String, Object, DataValueType)

Sets properties of the primary condition of the query with paged output to the passed-in values.

Declaration

public void SetPrimaryConditionProperties(QueryColumnExpression leftExpression, string lastValueParameterName, object lastValueParameterValue, DataValueType lastValueParameterValueType)

Parameters

Type	Name	Description
QueryColumnExpression	leftExpression	Expression of the left side of the condition.
System.String	lastValueParameterName	The name of the parameter of the value of the last record in the previous page of data.
System.Object	lastValueParameterValue	The value of the last record in the previous page of data.
DataValueType	lastValueParameterValueType	The data type of the value of the last record in the previous page of data.

Extension Methods

ReflectionUtilities.GetPropertyValue(Object, String)

ReflectionUtilities.GetPropertyDefValue(Object, String, Object)

ReflectionUtilities.TryGetPropertyValue(Object, String, out Object)

ReflectionUtilities.HasProperty(Object, String)

ReflectionUtilities.GetPropertyValue(Object, String, BindingFlags)

ReflectionUtilities.GetPropertyValueByPath(Object, String)

ReflectionUtilities.SetPropertyValue(Object, String, Object)

ReflectionUtilities.TrySetPropertyValue(Object, String, Object)

ValidateUtilities.CheckArgumentNull(Object, String)

ValidateUtilities.CheckDependencyNull(Object, String)

ValidateUtilities.EnsureDependencyNotNull<T>(T, String)

MetaDataTestUtils.MetaPropertiesShouldNotHaveDefValue<TInstance>(TInstance)

MetaDataTestUtils.MetaPropertiesShouldNotHaveDefValue<TInstance>(TInstance, Boolean)

NSubstituteExtension.Protected(Object, String, Object[])

NSubstituteExtension.Protected(Object, String, Boolean, Object[])

NSubstituteExtension.ProtectedGeneric<T>(Object, String, Object[])

NSubstituteExtension.ProtectedGeneric<T>(Object, String, Boolean, Object[])

NSubstituteExtension.ProtectedProperty(Object, String)

NSubstituteExtension.MatchInstance<T>(T)

SubstituteUtilities.GetIsSubstituteObject(Object)

SubstituteUtilities.Instead<TInstance, TValue>(TInstance, Func<TInstance, TValue>)