EntitySchemaQueryFunction class

Level: advanced

The Terrasoft.Core.Entities.EntitySchemaQueryFunction class implements the expression function.

The expression function is implemented in the following classes:

• EntitySchemaQueryFunction is a base class of expression of the entity schema query.
• EntitySchemaAggregationQueryFunction implements the aggregate function of the expression.
• EntitySchemaIsNullQueryFunction replaces null values with the replacement expression.
• EntitySchemaCoalesceQueryFunction returns the first not null expression from the list of arguments.
• EntitySchemaCaseNotNullQueryFunctionWhenItem is a class that describes the condition expression of the CASE SQL operator.
• EntitySchemaCaseNotNullQueryFunctionWhenItems is a collection of condition expressions of the CASE SQL operator.
• EntitySchemaCaseNotNullQueryFunction returns one value from the set of possible values depending on the specified conditions.
• EntitySchemaSystemValueQueryFunction returns the expression of the system value.
• EntitySchemaCurrentDateTimeQueryFunction implements the function for current date and time expression.
• EntitySchemaBaseCurrentDateQueryFunction is a base class of the expression function for the base date.
• EntitySchemaCurrentDateQueryFunction implements the function for current date and time expression.
• EntitySchemaDateToCurrentYearQueryFunction implements a function that converts the date expression to the same date of the current year.
• EntitySchemaStartOfCurrentWeekQueryFunction implements a function for the date expression of the current week’s start.
• EntitySchemaStartOfCurrentMonthQueryFunction implements a function for the date expression of the current month’s start.
• EntitySchemaStartOfCurrentQuarterQueryFunction implements a function for the date expression of the current quarter’a start.
• EntitySchemaStartOfCurrentHalfYearQueryFunction implements a function for the date expression of the current half-year’s start.
• EntitySchemaStartOfCurrentYearQueryFunction implements a function for the date expression of the current year’s start.
• EntitySchemaBaseCurrentDateTimeQueryFunction is a base class for a function for the base date and time expression.
• EntitySchemaStartOfCurrentHourQueryFunction implements a function for the time expression of the current hour.
• EntitySchemaCurrentTimeQueryFunction implements a function for the current time expression.
• EntitySchemaCurrentUserQueryFunction implements a function for the current user expression.
• EntitySchemaCurrentUserContactQueryFunction implements a function for the current user’s contact expression.
• EntitySchemaCurrentUserAccountQueryFunction implements a function for the current user’s account expression.
• EntitySchemaDatePartQueryFunction implements a function for a date part query.;
• EntitySchemaUpperQueryFunction converts the argument expression characters to uppercase.
• EntitySchemaCastQueryFunction casts the argument expression to the specified data type.
• EntitySchemaTrimQueryFunction removes whitespaces from both ends of the expression.
• EntitySchemaLengthQueryFunction returns the length of the expression.
• EntitySchemaConcatQueryFunction returns a string resulting from merging the string arguments of the function.
• EntitySchemaWindowQueryFunction implements an SQL window function.

EntitySchemaQueryFunction class

Terrasoft.Core.Entities namespace.

The base class of expression of the entity schema query.

note

Use the .NET classes reference to access the full list of the methods, parent classes, and implemented interfaces of the EntitySchemaQueryFunction class.

Methods

abstract QueryColumnExpression CreateQueryColumnExpression(DBSecurityEngine dbSecurityEngine)

For the current function, gets the query column expression that is generated taking into account the specified access rights.

Parameters

dbSecurityEngine

The Terrasoft.Core.DB.DBSecurityEngine object that defines the access rights.

abstract DataValueType GetResultDataValueType(DataValueTypeManager dataValueTypeManager)

Gets the data type of the output returned by the function, using the passed-in data type manager.

Parameters

dataValueTypeManager

Data type manager.

abstract bool GetIsSupportepataValueType(DataValueType dataValueType)

Indicates whether the output of the function has the specified data type.

Parameters

dataValueType

Data type.

abstract string GetCaption()

Gets the caption of the expression function.

virtual EntitySchemaQueryExpressionCollection GetArguments()

Gets the collection of expressions of function arguments.

void CheckIsSupportepataValueType(DataValueType dataValueType)

Verifies that the output of the function has the specified data type. Otherwise, an exception is thrown.

Parameters

dataValueType

Data type.

EntitySchemaAggregationQueryFunction class

Terrasoft.Core.Entities namespace.

The class implements the aggregate expression function.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaAggregationQueryFunction class.

Constructors

EntitySchemaAggregationQueryFunction(EntitySchemaQuery parentQuery)

Initializes the EntitySchemaAggregationQueryFunction instance of the specified aggregate function type for the specified query to the object schema.

Parameters

parentQuery

Query against the schema of the entity that contains the function.

EntitySchemaAggregationQueryFunction(AggregationTypeStrict aggregationType, EntitySchemaQuery parentQuery)

Initializes the EntitySchemaAggregationQueryFunction instance of the specified aggregate function type for the specified query to the object schema.

Parameters

aggregationType	The type of the aggregate function.
parentQuery	Query against the schema of the entity that contains the function.

EntitySchemaAggregationQueryFunction(AggregationTypeStrict aggregationType, EntitySchemaQueryExpression expression, EntitySchemaQuery parentQuery)

Initializes a new EntitySchemaAggregationQueryFunction instance for the specified type of aggregate function, expression, and query to the object schema.

Parameters

aggregationType	The type of the aggregate function.
expression	The query expression.
parentQuery	Query against the schema of the entity that contains the function.

EntitySchemaAggregationQueryFunction(EntitySchemaAggregationQueryFunction source)

Initializes a new EntitySchemaAggregationQueryFunction instance that is a clone of the passed aggregate expression function instance.

Parameters

source

Instance of the expression aggregate function whose clone is being created.

Properties

QueryAlias string

The alias of the function in the SQL query.

AggregationType AggregationTypeStrict

The type of the aggregate function.

AggregationEvalType AggregationEvalType

The scope of the aggregate function.

Expression EntitySchemaQueryExpression

The expression of the aggregate function argument.

Methods

override void WriteMetaData(DataWriter writer)

Serializes the aggregate function, using the specified Terrasoft.Common.DataWriter instance.

Parameters

writer

A Terrasoft.Common.DataWriter instance used for serialization.

override QueryColumnExpression CreateQueryColumnExpression(DBSecurityEngine dbSecurityEngine)

For the aggregate function, gets the query column expression that is generated taking into account the specified access rights.

Parameters

dbSecurityEngine

The Terrasoft.Core.DB.DBSecurityEngine object that defines the access rights.

override EntitySchemaQueryExpressionCollection GetArguments()

Gets the collection of expressions of the aggregate function arguments.

override DataValueType GetResultDataValueType(DataValueTypeManager dataValueTypeManager)

Gets the data type of the output returned by the aggregate function, using the specified data type manager.

Parameters

dataValueTypeManager

Data type manager.

override bool GetIsSupportepataValueType(DataValueType dataValueType)

Indicates whether the output of the aggregate function has the specified data type.

Parameters

dataValueType

Data type.

override string GetCaption()

Gets the caption of the expression function.

override object Clone()

Creates a clone of the current EntitySchemaAggregationQueryFunction instance.

EntitySchemaAggregationQueryFunction All()

Sets the To All Values scope for the current aggregate function.

EntitySchemaAggregationQueryFunction Distinct()

Sets the To Unique Values scope for the current aggregate function.

EntitySchemaIsNullQueryFunction class

Terrasoft.Core.Entities namespace.

The class replaces null values with the replacement experession.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaIsNullQueryFunction class.

Constructors

EntitySchemaIsNullQueryFunction(EntitySchemaQuery parentQuery)

Initializes a EntitySchemaIsNullQueryFunction instance for the specified entity schema query.

Parameters

parentQuery

Query against the schema of the entity that contains the function.

EntitySchemaIsNullQueryFunction(EntitySchemaQuery parentQuery, EntitySchemaQueryExpression checkExpression, EntitySchemaQueryExpression replacementExpression)

Initializes a new EntitySchemaIsNullQueryFunction instance for the specified query to the object schema, validated expression and substitute expression.

Parameters

parentQuery	Query against the schema of the entity that contains the function.
checkExpression	Expression to check for being equal to null.
replacementExpression	The expression returned by the function if checkExpression is null.

EntitySchemaIsNullQueryFunction(EntitySchemaIsNullQueryFunction source)

Initializes a new EntitySchemaIsNullQueryFunction instance that is a clone of the passed expression function.

Parameters

source

An instance of the EntitySchemaIsNullQueryFunction function whose clone is being created.

Properties

QueryAlias string

The alias of the function in the SQL query.

CheckExpression EntitySchemaQueryExpression

Expression of the function argument to check the null value.

ReplacementExpression EntitySchemaQueryExpression

Expression of the function argument that is returned if the check expression is equal to null.

Methods

override void WriteMetaData(DataWriter writer)

Serializes the expression function, using the passed DataWriter instance.

Parameters

writer

A DataWriter instance used for serializing the expression function.

override QueryColumnExpression CreateQueryColumnExpression(DBSecurityEngine dbSecurityEngine)

For the current function, gets the query column expression that is generated taking into account the specified access rights.

Parameters

dbSecurityEngine

The Terrasoft.Core.DB.DBSecurityEngine object that defines the access rights.

override EntitySchemaQueryExpressionCollection GetArguments()

Gets the collection of expressions of function arguments.

override DataValueType GetResultDataValueType(DataValueTypeManager dataValueTypeManager)

Gets the data type of the output returned by the function, using the passed-in data type manager.

Parameters

dataValueTypeManager

Data type manager.

EntitySchemaCoalesceQueryFunction class

Terrasoft.Core.Entities namespace.

The class returns the first not null expression from the list of arguments.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaCoalesceQueryFunction class.

Constructors

EntitySchemaCoalesceQueryFunction(EntitySchemaQuery parentQuery)

Initializes the new EntitySchemaCoalesceQueryFunction instance for the specified entity schema query.

Parameters

aggregationType	The type of the aggregate function.
parentQuery	Query against the schema of the entity that contains the function.

EntitySchemaCoalesceQueryFunction(EntitySchemaCoalesceQueryFunction source)

Initializes a new EntitySchemaCoalesceQueryFunction instance that is a clone of the passed function.

Parameters

source

The EntitySchemaCoalesceQueryFunction function whose clone is being created.

Properties

QueryAlias string

The alias of the function in the SQL query.

Expressions EntitySchemaQueryExpressionCollection

Collection of expressions of function arguments.

HasExpressions bool

Indicates whether at least one item exists in the collection of expressions of the function arguments.

Methods

override bool GetIsSupportepataValueType(DataValueType dataValueType)

Indicates whether the output of the function has the specified data type.

Parameters

dataValueType

Data type.

EntitySchemaCaseNotNullQueryFunctionWhenItem class

Terrasoft.Core.Entities namespace.

Class that describes the condition expression of the CASE SQL operator.

note

Use the .NET classes reference to access the full list of the methods, parent classes, and implemented interfaces of the EntitySchemaCaseNotNullQueryFunctionWhenItem class.

Constructors

EntitySchemaCaseNotNullQueryFunctionWhenItem()

Initializes a new instance of the EntitySchemaCaseNotNullQueryFunctionWhenItem class.

EntitySchemaCaseNotNullQueryFunctionWhenItem(EntitySchemaQueryExpression whenExpression, EntitySchemaQueryExpression thenExpression)

Initializes a EntitySchemaCaseNotNullQueryFunctionWhenItem instance for the specified expressions of the WHEN and THEN clauses.

Parameters

whenExpression	Expression of the WHEN condition clause.
thenExpression	Expression of the THEN condition clause.

EntitySchemaCaseNotNullQueryFunctionWhenItem(EntitySchemaCaseNotNullQueryFunctionWhenItem source)

Initializes the EntitySchemaCaseNotNullQueryFunctionWhenItem instance that is a clone of the passed function.

Parameters

source

The EntitySchemaCaseNotNullQueryFunctionWhenItem function whose clone is being created.

Properties

WhenExpression EntitySchemaQueryExpression

Expression of the WHEN clause.

ThenExpression EntitySchemaQueryExpression

Expression of the THEN clause.

EntitySchemaCaseNotNullQueryFunctionWhenItems class

Terrasoft.Core.Entities namespace.

The class implements a collection condition expressions of the CASE SQL operator.

note

Use the .NET classes reference to access the full list of the methods, parent classes, and implemented interfaces of the EntitySchemaCaseNotNullQueryFunctionWhenItems class.

Constructors

EntitySchemaCaseNotNullQueryFunctionWhenItems()

Initializes an EntitySchemaCaseNotNullQueryFunctionWhenItems instance.

EntitySchemaCaseNotNullQueryFunctionWhenItems(EntitySchemaCaseNotNullQueryFunctionWhenItems source)

Initializes a new EntitySchemaCaseNotNullQueryFunctionWhenItems instance that is a clone of the passed collection of conditions.

Parameters

source

The collection of conditions whose clone is being created.

EntitySchemaCaseNotNullQueryFunction class

Terrasoft.Core.Entities namespace.

The class returns one value from the set of possible values depending on the specified conditions.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaCaseNotNullQueryFunction class.

Constructors

CurrentDateTimeQueryFunction()

Initializes a new CurrentDateTimeQueryFunction instance.

EntitySchemaCaseNotNullQueryFunction(EntitySchemaQuery parentQuery)

Initializes the new EntitySchemaCaseNotNullQueryFunction instance for the specified entity schema query.

Parameters

parentQuery

Query against the schema of the entity that contains the function.

EntitySchemaCaseNotNullQueryFunction(EntitySchemaCaseNotNullQueryFunction source)

Initializes a new EntitySchemaCaseNotNullQueryFunction instance that is a clone of the passed function.

Parameters

source

The EntitySchemaCaseNotNullQueryFunction function whose clone is being created.

Properties

QueryAlias string

The alias of the function in the SQL query.

WhenItems EntitySchemaCaseNotNullQueryFunctionWhenItems

Collection of conditions of the expression function.

HasWhenItems bool

Indicates whether the function has at least one condition.

ElseExpression EntitySchemaQueryExpression

Expression of the ELSE clause.

Methods

void SpecifyQueryAlias(string queryAlias)

For the current expression function, defines the specified alias in the resulting SQL query.

Parameters

queryAlias

Alias to define for the current function.

EntitySchemaSystemValueQueryFunction class

Terrasoft.Core.Entities namespace.

The class returns the expression of the system value.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaSystemValueQueryFunction class.

Properties

QueryAlias string

The alias of the function in the SQL query.

SystemValueName string

Name of the system value.

EntitySchemaCurrentDateTimeQueryFunction class

Terrasoft.Core.Entities namespace.

The class implements the function for current date and time expression.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaCurrentDateTimeQueryFunction class.

Constructors

EntitySchemaCurrentDateTimeQueryFunction(EntitySchemaQuery parentQuery)

Initializes a EntitySchemaCurrentDateTimeQueryFunction instance for the specified entity schema query.

Parameters

parentQuery

Query against the schema of the entity that contains the function.

EntitySchemaCurrentDateTimeQueryFunction(EntitySchemaCurrentDateTimeQueryFunction source)

Initializes a EntitySchemaCurrentDateTimeQueryFunction instance that is a clone of the passed function.

Parameters

source

An instance of the EntitySchemaCurrentDateTimeQueryFunction function whose clone is being created.

Properties

SystemValueName string

Name of the system value.

Methods

override string GetCaption()

Gets the caption of the expression function.

override object Clone()

Creates a clone of the current EntitySchemaCurrentDateTimeQueryFunction instance.

EntitySchemaBaseCurrentDateQueryFunction class

Terrasoft.Core.Entities namespace.

Base class of the expression function for the base date.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaBaseCurrentDateQueryFunction class.

Properties

SystemValueName string

Name of the system value.

Offset int

The offset.

EntitySchemaCurrentDateQueryFunction class

Terrasoft.Core.Entities namespace.

EntitySchemaCurrentDateQueryFunction – implements the function for current date and time expression.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaCurrentDateQueryFunction class.

Constructors

EntitySchemaCurrentDateQueryFunction(EntitySchemaQuery parentQuery, int offset = 0) : this(parentQuery, null, offset)
EntitySchemaCurrentDateQueryFunction(EntitySchemaQuery parentQuery, EntitySchemaQueryExpression expression, int offset = 0) : base(parentQuery, expression, offset)

Initializes a EntitySchemaCurrentDateQueryFunction instance with the specified offset from the base date for the request to the object schema.

Parameters

parentQuery	Query against the schema of the entity that contains the function.
offset	Day offset from the control date. By default, 0.
expression	The query expression.

EntitySchemaCurrentDateQueryFunction(EntitySchemaCurrentDateQueryFunction source)

Initializes a EntitySchemaCurrentDateQueryFunction instance that is a clone of the passed function.

Parameters

source

An instance of the EntitySchemaCurrentDateQueryFunction function whose clone is being created.

Methods

override string GetCaption()

Gets the caption of the expression function.

override object Clone()

Creates a clone of the current EntitySchemaCurrentDateQueryFunction instance.

EntitySchemaDateToCurrentYearQueryFunction class

Terrasoft.Core.Entities namespace.

The class implements the function that converts the date expression to the same date of the current year.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaDateToCurrentYearQueryFunction class.

Constructors

EntitySchemaDateToCurrentYearQueryFunction(EntitySchemaQuery parentQuery)

Initializes the new EntitySchemaDateToCurrentYearQueryFunction instance for the specified entity schema query.

Parameters

parentQuery

Query against the schema of the entity that contains the function.

EntitySchemaDateToCurrentYearQueryFunction(EntitySchemaQuery parentQuery, EntitySchemaQueryExpression expression)

Initializes the new EntitySchemaDateToCurrentYearQueryFunction instance for the specified entity schema query and passed date expression.

Parameters

parentQuery	Query against the schema of the entity that contains the function.
expression	The query expression.

EntitySchemaDateToCurrentYearQueryFunction(EntitySchemaDateToCurrentYearQueryFunction source)

Initializes a new EntitySchemaDateToCurrentYearQueryFunction instance that is a clone of the passed function.

Parameters

source

The EntitySchemaDateToCurrentYearQueryFunction function whose clone is being created.

Properties

QueryAlias string

The alias of the function in the SQL query.

Expression EntitySchemaQueryExpression

The expression of the function arguments.

EntitySchemaStartOfCurrentWeekQueryFunction class

Terrasoft.Core.Entities namespace.

The class implements the function for current date expression.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaStartOfCurrentWeekQueryFunction class.

Constructors

EntitySchemaStartOfCurrentWeekQueryFunction(EntitySchemaQuery parentQuery, int offset = 0) : this(parentQuery, null, offset)
EntitySchemaStartOfCurrentWeekQueryFunction(EntitySchemaQuery parentQuery, EntitySchemaQueryExpression expression, int offset = 0) : base(parentQuery, expression, offset)

Initializes a EntitySchemaStartOfCurrentWeekQueryFunction instance with the specified offset from the base date for the request to the object schema.

Parameters

parentQuery	Query against the schema of the entity that contains the function.
offset	Day offset from the control date. By default, 0.
expression	The query expression.

EntitySchemaStartOfCurrentWeekQueryFunction(EntitySchemaStartOfCurrentWeekQueryFunction source) : base(source)

Initializes a EntitySchemaStartOfCurrentWeekQueryFunction instance that is a clone of the passed-in expression function.

Parameters

source

An instance of the EntitySchemaStartOfCurrentWeekQueryFunction function whose clone is being created.

Methods

override string GetCaption()

Gets the caption of the expression function.

override object Clone()

Creates a clone of the current EntitySchemaStartOfCurrentWeekQueryFunction instance.

EntitySchemaStartOfCurrentMonthQueryFunction class

Terrasoft.Core.Entities namespace.

The class implements the function for the current month start date expression.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaStartOfCurrentMonthQueryFunction class.

Constructors

EntitySchemaStartOfCurrentMonthQueryFunction(EntitySchemaQuery parentQuery, int offset = 0) : this(parentQuery, null, offset)
EntitySchemaStartOfCurrentMonthQueryFunction(EntitySchemaQuery parentQuery, EntitySchemaQueryExpression expression, int offset = 0) : base(parentQuery, expression, offset)

Initializes a EntitySchemaStartOfCurrentMonthQueryFunction instance with the specified offset from the base date for the request to the object schema.

Parameters

parentQuery	Query against the schema of the entity that contains the function.
offset	Day offset from the control date. By default, 0.
expression	The query expression.

EntitySchemaStartOfCurrentMonthQueryFunction(EntitySchemaStartOfCurrentMonthQueryFunction source) : base(source)

Initializes an EntitySchemaStartOfCurrentMonthQueryFunction instance that is a clone of the passed-in expression function.

Parameters

source

An instance of the EntitySchemaStartOfCurrentMonthQueryFunction function whose clone is being created.

Methods

override string GetCaption()

Gets the caption of the expression function.

override object Clone()

Creates a clone of the current EntitySchemaStartOfCurrentMonthQueryFunction instance.

EntitySchemaStartOfCurrentQuarterQueryFunction class

Terrasoft.Core.Entities namespace.

The class implements the function for the current month start date expression.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaStartOfCurrentQuarterQueryFunction class.

Constructors

EntitySchemaStartOfCurrentQuarterQueryFunction(EntitySchemaQuery parentQuery, int offset = 0) : this(parentQuery, null, offset)
EntitySchemaStartOfCurrentQuarterQueryFunction(EntitySchemaQuery parentQuery, EntitySchemaQueryExpression expression, int offset = 0) : base(parentQuery, expression, offset)

Initializes a EntitySchemaStartOfCurrentQuarterQueryFunction instance with the specified offset from the base date for the request to the object schema.

Parameters

parentQuery	Query against the schema of the entity that contains the function.
offset	Day offset from the control date. By default, 0.
expression	The query expression.

EntitySchemaStartOfCurrentQuarterQueryFunction(EntitySchemaStartOfCurrentQuarterQueryFunction source) : base(source)

Initializes an EntitySchemaStartOfCurrentQuarterQueryFunction instance that is a clone of the passed-in expression function.

Parameters

source

An instance of the EntitySchemaStartOfCurrentQuarterQueryFunction function whose clone is being created.

Methods

override string GetCaption()

Gets the caption of the expression function.

override object Clone()

Creates a clone of the current EntitySchemaStartOfCurrentQuarterQueryFunction instance.

EntitySchemaStartOfCurrentHalfYearQueryFunction class

Terrasoft.Core.Entities namespace.

The class implements the function for the current half-year start date expression.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaStartOfCurrentHalfYearQueryFunction class.

Constructors

EntitySchemaStartOfCurrentHalfYearQueryFunction(EntitySchemaQuery parentQuery, int offset = 0) : this(parentQuery, null, offset)
EntitySchemaStartOfCurrentHalfYearQueryFunction(EntitySchemaQuery parentQuery, EntitySchemaQueryExpression expression, int offset = 0) : base(parentQuery, expression, offset)

Initializes a EntitySchemaStartOfCurrentHalfYearQueryFunction instance with the specified offset from the base date for the request to the object schema.

Parameters

parentQuery	Query against the schema of the entity that contains the function.
offset	Day offset from the control date. By default, 0.
expression	The query expression.

EntitySchemaStartOfCurrentHalfYearQueryFunction(EntitySchemaStartOfCurrentHalfYearQueryFunction source) : base(source)

Initializes a EntitySchemaStartOfCurrentHalfYearQueryFunction instance that is a clone of the passed-in expression function.

Parameters

source

An instance of the EntitySchemaStartOfCurrentHalfYearQueryFunction function whose clone is being created.

Methods

override string GetCaption()

Gets the caption of the expression function.

override object Clone()

Creates a clone of the current EntitySchemaStartOfCurrentHalfYearQueryFunction instance.

EntitySchemaStartOfCurrentYearQueryFunction class

Terrasoft.Core.Entities namespace.

The class implements the function for the current year start date expression.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaStartOfCurrentYearQueryFunction class.

Constructors

EntitySchemaStartOfCurrentYearQueryFunction(EntitySchemaQuery parentQuery, int offset = 0) : this(parentQuery, null, offset)
EntitySchemaStartOfCurrentYearQueryFunction(EntitySchemaQuery parentQuery, EntitySchemaQueryExpression expression, int offset = 0) : base(parentQuery, expression, offset)

Initializes a EntitySchemaStartOfCurrentYearQueryFunction instance with the specified offset from the base date for the request to the object schema.

Parameters

parentQuery	Query against the schema of the entity that contains the function.
offset	Day offset from the control date. By default, 0.
expression	The query expression.

EntitySchemaStartOfCurrentYearQueryFunction(EntitySchemaStartOfCurrentYearQueryFunction source) : base(source)

Initializes a EntitySchemaStartOfCurrentYearQueryFunction instance that is a clone of the passed-in expression function.

Parameters

source

An instance of the EntitySchemaStartOfCurrentYearQueryFunction function whose clone is being created.

Methods

override string GetCaption()

Gets the caption of the expression function.

override object Clone()

Creates a clone of the current EntitySchemaStartOfCurrentHalfYearQueryFunction instance.

EntitySchemaBaseCurrentDateTimeQueryFunction class

Terrasoft.Core.Entities namespace.

Base class of the expression function for the base date and time.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaBaseCurrentDateTimeQueryFunction class.

Properties

SystemValueName string

Name of the system value.

EntitySchemaStartOfCurrentHourQueryFunction class

Terrasoft.Core.Entities namespace.

The class implement a function for the current hour expression.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaStartOfCurrentHourQueryFunction class.

Constructors

EntitySchemaStartOfCurrentHourQueryFunction(EntitySchemaQuery parentQuery, int offset = 0) : base(parentQuery, offset)

Initializes a EntitySchemaStartOfCurrentHourQueryFunction instance that is part of the parentQuery with the specified offset from the base date.

Parameters

parentQuery	An EntitySchemaQuery instance.
offset	Hour offset from the base date.

EntitySchemaStartOfCurrentHourQueryFunction(EntitySchemaQuery parentQuery, EntitySchemaQueryExpression expression, int offset = 0) : this(parentQuery, offset)

Initializes a EntitySchemaStartOfCurrentHourQueryFunction instance that is part of the parentQuery with the specified expression and offset from the base date.

Parameters

parentQuery	An EntitySchemaQuery instance.
expression	The expression of the function argument.
offset	Hour offset from the base date.

EntitySchemaStartOfCurrentHourQueryFunction(EntitySchemaStartOfCurrentHourQueryFunction source) : base(source)

Initializes a EntitySchemaStartOfCurrentHourQueryFunction instance that is a clone of the passed-in expression function.

Parameters

source

An instance of the EntitySchemaStartOfCurrentHourQueryFunction function whose clone is being created.

Methods

override string GetCaption()

Gets the caption of the expression function.

override object Clone()

Creates a clone of the current EntitySchemaStartOfCurrentHourQueryFunction instance.

EntitySchemaCurrentTimeQueryFunction class

Terrasoft.Core.Entities namespace.

The class implements the function for current time expression.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaCurrentTimeQueryFunction class.

Constructors

EntitySchemaCurrentTimeQueryFunction(EntitySchemaQuery parentQuery) : base(parentQuery)

Initializes the new EntitySchemaCurrentTimeQueryFunction instance for the specified entity schema query.

Parameters

parentQuery

Query against the schema of the entity that contains the function.

EntitySchemaCurrentTimeQueryFunction(EntitySchemaCurrentTimeQueryFunction source) : base(source)

Initializes a new EntitySchemaCurrentTimeQueryFunction instance that is a clone of the passed function.

Parameters

source

The EntitySchemaCurrentTimeQueryFunction function whose clone is being created.

Properties

SystemValueName string

Name of the system value.

Methods

override string GetCaption()

Gets the caption of the expression function.

override object Clone()

Creates a clone of the current EntitySchemaCurrentTimeQueryFunction instance.

EntitySchemaCurrentUserQueryFunction class

Terrasoft.Core.Entities namespace.

The class implements the function for current user expression.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaCurrentUserQueryFunction class.

Constructors

EntitySchemaCurrentUserQueryFunction(EntitySchemaQuery parentQuery) : base(parentQuery)

Initializes the new EntitySchemaCurrentUserQueryFunction instance for the specified entity schema query.

Parameters

parentQuery

Query against the schema of the entity that contains the function.

EntitySchemaCurrentUserQueryFunction(EntitySchemaCurrentUserQueryFunction source) : base(source)

Initializes a new EntitySchemaCurrentUserQueryFunction instance that is a clone of the passed function.

Parameters

source

The EntitySchemaCurrentUserQueryFunction function whose clone is being created.

Properties

SystemValueName string

Name of the system value.

Methods

override string GetCaption()

Gets the caption of the expression function.

override object Clone()

Creates a clone of the current EntitySchemaCurrentUserQueryFunction instance.

EntitySchemaCurrentUserContactQueryFunction class

Terrasoft.Core.Entities namespace.

The class implements the function for the current user's contact.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaCurrentUserContactQueryFunction class.

Constructors

EntitySchemaCurrentUserContactQueryFunction(EntitySchemaQuery parentQuery) : base(parentQuery)

Initializes a new EntitySchemaCurrentUserContactQueryFunction instance for the specified entity schema query.

Parameters

parentQuery

Query against the schema of the entity that contains the function.

EntitySchemaCurrentUserContactQueryFunction(EntitySchemaCurrentUserContactQueryFunction source) : base(source)

Initializes a new EntitySchemaCurrentUserContactQueryFunction instance that is a clone of the passed function.

Parameters

source

The EntitySchemaCurrentUserContactQueryFunction function whose clone is being created.

Properties

SystemValueName string

Name of the system value.

Methods

override string GetCaption()

Gets the caption of the expression function.

override object Clone()

Creates a clone of the current EntitySchemaCurrentUserContactQueryFunction instance.

EntitySchemaCurrentUserAccountQueryFunction class

Terrasoft.Core.Entities namespace.

The class implments the expression function of the current user's account.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaCurrentUserAccountQueryFunction class.

Constructors

EntitySchemaCurrentUserAccountQueryFunction(EntitySchemaQuery parentQuery)

Initializes the new EntitySchemaCurrentUserAccountQueryFunction instance for the specified entity schema query.

Parameters

parentQuery

Query against the schema of the entity that contains the function.

EntitySchemaCurrentUserAccountQueryFunction(EntitySchemaCurrentUserAccountQueryFunction source)

Initializes a new EntitySchemaCurrentUserAccountQueryFunction instance that is a clone of the passed function.

Parameters

source

The EntitySchemaCurrentUserAccountQueryFunction function whose clone is being created.

Properties

SystemValueName string

Name of the system value.

EntitySchemaDatePartQueryFunction class

Terrasoft.Core.Entities namespace.

The class implements a function for a date part query.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaDatePartQueryFunction class.

Constructors

EntitySchemaDatePartQueryFunction(EntitySchemaQuery parentQuery) : base(parentQuery)

Initializes a new EntitySchemaDatePartQueryFunction instance for the specified entity schema query.

Parameters

parentQuery

An EntitySchemaQuery instance.

EntitySchemaDatePartQueryFunction(EntitySchemaQuery parentQuery, EntitySchemaDatePartQueryFunctionInterval interval, EntitySchemaQueryExpression expression) : base(parentQuery)

Initializes a new EntitySchemaDatePartQueryFunction instance that is part of the parentQuery with the specified interval date part for requesting the entity schema and the query expression.

Parameters

parentQuery	An EntitySchemaQuery instance.
interval	Datepart.
expression	The query expression.

EntitySchemaDatePartQueryFunction(EntitySchemaDatePartQueryFunction source) : base(source)

Initializes a new EntitySchemaDatePartQueryFunction instance that is a clone of the passed function.

Parameters

source

The EntitySchemaDatePartQueryFunction function whose clone is being created.

Properties

QueryAlias string

The alias of the function in the SQL query.

EntitySchemaDatePartQueryFunctionInterval Interval

The date part returned by the function.

EntitySchemaQueryExpression Expression

The expression of the function argument.

Methods

override void WriteMetaData(DataWriter writer)

Serializes the function using the specified Terrasoft.Common.DataWriter instance.

Parameters

writer

A Terrasoft.Common.DataWriter instance used for serialization.

override QueryColumnExpression CreateQueryColumnExpression(DBSecurityEngine dbSecurityEngine)

For the current function, gets the query column expression that is generated taking into account the specified access rights.

Parameters

dbSecurityEngine

The Terrasoft.Core.DB.DBSecurityEngine object that defines the access rights.

override DataValueType GetResultDataValueType(DataValueTypeManager dataValueTypeManager)

Gets the data type of the output returned by the function, using the passed-in data type manager.

Parameters

dataValueTypeManager

Data type manager.

override bool GetIsSupportedDataValueType(DataValueType dataValueType)

Indicates whether the output of the function has the specified data type.

Parameters

dataValueType

Data type.

override string GetCaption()

Gets the caption of the expression function.

override EntitySchemaQueryExpressionCollection GetArguments()

Gets the collection of expressions of function arguments.

override object Clone()

Creates a clone of the current EntitySchemaUpperQueryFunction instance.

EntitySchemaUpperQueryFunction class

Terrasoft.Core.Entities namespace.

The class converts the argument expression characters to uppercase.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaUpperQueryFunction class.

Constructors

EntitySchemaUpperQueryFunction(EntitySchemaQuery parentQuery)

Initializes the new EntitySchemaUpperQueryFunction instance for the specified entity schema query.

Parameters

parentQuery

Query against the schema of the entity that contains the function.

EntitySchemaUpperQueryFunction(EntitySchemaQuery parentQuery, EntitySchemaQueryExpression expression)

Initializes the new EntitySchemaUpperQueryFunction instance for the specified entity schema query and passed date expression.

Parameters

parentQuery	Query against the schema of the entity that contains the function.
expression	The query expression.

EntitySchemaUpperQueryFunction(EntitySchemaUpperQueryFunction source)

Initializes a new EntitySchemaUpperQueryFunction instance that is a clone of the passed function.

Parameters

source

The EntitySchemaUpperQueryFunction function whose clone is being created.

Properties

QueryAlias string

The alias of the function in the SQL query.

Expression EntitySchemaQueryExpression

The expression of the function arguments.

EntitySchemaCastQueryFunction class

Terrasoft.Core.Entities namespace.

The class casts the argument expression to the specified data type.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaCastQueryFunction class.

Constructors

EntitySchemaCastQueryFunction(EntitySchemaQuery parentQuery, DBDataValueType castType)

Initializes a new EntitySchemaCastQueryFunction instance for the specified query to the schema of the object with the specified target data type.

Parameters

parentQuery	Query against the schema of the entity that contains the function.
castType	The target data type.

EntitySchemaCastQueryFunction(EntitySchemaQuery parentQuery, EntitySchemaQueryExpression expression, DBDataValueType castType)

Initializes a new EntitySchemaCastQueryFunction instance with the specified expression and target data type.

Parameters

parentQuery	Query against the schema of the entity that contains the function.
expression	The query expression.
castType	The target data type.

EntitySchemaCastQueryFunction(EntitySchemaCastQueryFunction source)

Initializes a new EntitySchemaCastQueryFunction instance that is a clone of the passed function.

Parameters

source

The EntitySchemaCastQueryFunction function whose clone is being created.

Properties

QueryAlias string

The alias of the function in the SQL query.

Expression EntitySchemaQueryExpression

The expression of the function argument.

CastType DBDataValueType

The target data type.

EntitySchemaTrimQueryFunction class

Terrasoft.Core.Entities namespace.

The class removes whitespaces from both ends of the expression.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaTrimQueryFunction class.

Constructors

EntitySchemaTrimQueryFunction(EntitySchemaQuery parentQuery)

Initializes the new EntitySchemaTrimQueryFunction instance for the specified entity schema query.

Parameters

parentQuery

Query against the schema of the entity that contains the function.

EntitySchemaTrimQueryFunction(EntitySchemaQuery parentQuery, EntitySchemaQueryExpression expression)

Initializes the new EntitySchemaTrimQueryFunction instance for the specified entity schema query and passed date expression.

Parameters

parentQuery	Query against the schema of the entity that contains the function.
expression	The query expression.

EntitySchemaTrimQueryFunction(EntitySchemaTrimQueryFunction source)

Initializes a new EntitySchemaTrimQueryFunction instance that is a clone of the passed function.

Parameters

source

The EntitySchemaTrimQueryFunction function whose clone is being created.

Properties

QueryAlias string

The alias of the function in the SQL query.

Expression EntitySchemaQueryExpression

The expression of the function arguments.

EntitySchemaLengthQueryFunction class

Terrasoft.Core.Entities namespace.

The class returns the length of the expression.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaLengthQueryFunction class.

Constructors

EntitySchemaLengthQueryFunction(EntitySchemaQuery parentQuery)

Initializes the new EntitySchemaLengthQueryFunction instance for the specified entity schema query.

Parameters

parentQuery

Query against the schema of the entity that contains the function.

EntitySchemaLengthQueryFunction(EntitySchemaQuery parentQuery, EntitySchemaQueryExpression expression)

Initializes the new EntitySchemaLengthQueryFunction instance for the specified entity schema query and passed date expression.

Parameters

parentQuery	Query against the schema of the entity that contains the function.
expression	The query expression.

EntitySchemaLengthQueryFunction(EntitySchemaLengthQueryFunction source)

Initializes a new EntitySchemaLengthQueryFunction instance that is a clone of the passed function.

Parameters

source

The EntitySchemaLengthQueryFunction function whose clone is being created.

Properties

QueryAlias string

The alias of the function in the SQL query.

Expression EntitySchemaQueryExpression

The expression of the function arguments.

EntitySchemaConcatQueryFunction class

Terrasoft.Core.Entities namespace.

The class returns a string resulting from merging the string arguments of the function.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaConcatQueryFunction class.

Constructors

EntitySchemaConcatQueryFunction(EntitySchemaQuery parentQuery)

Initializes the new EntitySchemaConcatQueryFunction instance for the specified entity schema query.

Parameters

parentQuery

Query against the schema of the entity that contains the function.

EntitySchemaConcatQueryFunction(EntitySchemaQuery parentQuery, EntitySchemaQueryExpression expressions)

Initializes a new EntitySchemaConcatQueryFunction instance for the specified array of expressions and entity schema query.

Parameters

parentQuery	Query against the schema of the entity that contains the function.
expressions	Array of expressions.

EntitySchemaConcatQueryFunction(EntitySchemaConcatQueryFunction source)

Initializes a new EntitySchemaConcatQueryFunction instance that is a clone of the passed function.

Parameters

source

The EntitySchemaConcatQueryFunction function whose clone is being created.

Properties

QueryAlias string

The alias of the function in the SQL query.

Expressions EntitySchemaQueryExpressionCollection

Collection of expressions of function arguments.

HasExpressions bool

Indicates whether at least one item exists in the collection of expressions of the function arguments.

EntitySchemaWindowQueryFunction class

Terrasoft.Core.Entities namespace.

The class implements an SQL window function.

note

Use the .NET classes reference to access the full list of the methods, properties, parent classes, and implemented interfaces of the EntitySchemaWindowQueryFunction class.

Constructors

EntitySchemaWindowQueryFunction(EntitySchemaQuery parentQuery)

Initializes the new EntitySchemaWindowQueryFunction instance for the specified entity schema query.

Parameters

parentQuery

Query against the schema of the entity that contains the function.

EntitySchemaWindowQueryFunction(EntitySchemaQueryExpression function, EntitySchemaQuery esq)

Initializes the new EntitySchemaWindowQueryFunction instance for the specified entity schema query.

Parameters

function	Nested query function.
esq	Query against the entity schema.

EntitySchemaWindowQueryFunction(EntitySchemaQueryExpression function, EntitySchemaQuery esq, EntitySchemaQueryExpression partitionBy = null, EntitySchemaQueryExpression orderBy = null)

Initializes the new EntitySchemaWindowQueryFunction instance for the specified entity schema query.

Parameters

function	Nested query function.
parentQuery	Query against the schema of the entity that contains the function.
partitionBy	The expression for splitting the query.
orderBy	The expression for ordering the query.

EntitySchemaWindowQueryFunction(EntitySchemaQueryFunction source)

Initializes a new EntitySchemaWindowQueryFunction instance that is a clone of the passed function.

Parameters

source

The EntitySchemaQueryFunction function whose clone is being created.

EntitySchemaWindowQueryFunction(EntitySchemaWindowQueryFunction source)

Initializes a new EntitySchemaWindowQueryFunction instance that is a clone of the passed function.

Parameters

source

The EntitySchemaWindowQueryFunction function whose clone is being created.

Properties

QueryAlias string

The alias of the function in the SQL query.

InnerFunction EntitySchemaQueryExpression

The function to apply.

PartitionByExpression EntitySchemaQueryExpression

Split by expression.

OrderByExpression EntitySchemaQueryExpression

Sort by expression.