Class EntitySchemaQueryFunction
The base class of expression of the entity schema query.
Inheritance
Inherited Members
Namespace: Terrasoft.Core.Entities
Assembly: Terrasoft.Core.dll
Syntax
public abstract class EntitySchemaQueryFunction : MetaItem, IMetaItem, IMetaDataSerializable, ICloneable
Constructors
EntitySchemaQueryFunction(EntitySchemaQuery)
Declaration
protected EntitySchemaQueryFunction(EntitySchemaQuery parentQuery)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQuery | parentQuery |
EntitySchemaQueryFunction(EntitySchemaQueryFunction)
Declaration
protected EntitySchemaQueryFunction(EntitySchemaQueryFunction source)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQueryFunction | source |
Properties
ParentQuery
Query against the schema of the entity that contains the function.
Declaration
public EntitySchemaQuery ParentQuery { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaQuery |
QueryAlias
The alias of the function in the SQL query.
Declaration
public abstract string QueryAlias { get; }
Property Value
Type | Description |
---|---|
System.String |
Methods
CheckIsSupportedDataValueType(DataValueType)
Verifies that the output of the function has the specified data type. Otherwise, an exception is thrown.
Declaration
public void CheckIsSupportedDataValueType(DataValueType dataValueType)
Parameters
Type | Name | Description |
---|---|---|
DataValueType | dataValueType | Data type. |
Exceptions
Type | Condition |
---|---|
UnsupportedTypeException | If the output of the function is of a data type other than |
CreateQueryColumnExpression(DBSecurityEngine)
For the current function, gets the query column expression that is generated taking into account the specified access rights.
Declaration
public abstract QueryColumnExpression CreateQueryColumnExpression(DBSecurityEngine dbSecurityEngine)
Parameters
Type | Name | Description |
---|---|---|
DBSecurityEngine | dbSecurityEngine | The DBSecurityEngine entity that determines the access rights. |
Returns
Type | Description |
---|---|
QueryColumnExpression | The QueryColumnExpression instance for the current query function. |
GetArguments()
Gets the collection of expressions of function arguments.
Declaration
public virtual EntitySchemaQueryExpressionCollection GetArguments()
Returns
Type | Description |
---|---|
EntitySchemaQueryExpressionCollection | Collection of expressions of function arguments. |
GetCaption()
Gets the caption of the expression function.
Declaration
public abstract string GetCaption()
Returns
Type | Description |
---|---|
System.String | String of the function caption. |
GetIsSupportedDataValueType(DataValueType)
Indicates whether the output of the function has the specified data type.
Declaration
public abstract bool GetIsSupportedDataValueType(DataValueType dataValueType)
Parameters
Type | Name | Description |
---|---|---|
DataValueType | dataValueType | Data type. |
Returns
Type | Description |
---|---|
System.Boolean |
|
GetResultDataValueType(DataValueTypeManager)
Gets the data type of the output returned by the function, using the passed-in data type manager.
Declaration
public abstract DataValueType GetResultDataValueType(DataValueTypeManager dataValueTypeManager)
Parameters
Type | Name | Description |
---|---|---|
DataValueTypeManager | dataValueTypeManager | Data type manager. |
Returns
Type | Description |
---|---|
DataValueType | Data type of the output returned by the function. |