Table of Contents

Documentation / queries/QueryResult

queries/QueryResult

Classes

QueryResult<TDataType>

Represents the result from executing a IQueryFor.

Type Parameters

TDataType = object

The data type.

Implements

Constructors

new QueryResult()

new QueryResult<TDataType>(result, instanceType, enumerable): QueryResult<TDataType>

Creates an instance of query result.

Parameters
result

ServerQueryResult

The raw result from the backend.

instanceType

Constructor

The type of instance to deserialize.

enumerable

boolean

Whether or not the result is supposed be an enumerable or not.

Returns

QueryResult<TDataType>

Defined in

queries/QueryResult.ts:86

Properties

data

readonly data: TDataType

Gets the data result from the query.

Implementation of

IQueryResult.data

Defined in

queries/QueryResult.ts:119

exceptionMessages

readonly exceptionMessages: string[]

Gets any exception messages that might have occurred.

Implementation of

IQueryResult.exceptionMessages

Defined in

queries/QueryResult.ts:140

exceptionStackTrace

readonly exceptionStackTrace: string

Gets the stack trace if there was an exception.

Implementation of

IQueryResult.exceptionStackTrace

Defined in

queries/QueryResult.ts:143

hasExceptions

readonly hasExceptions: boolean

Gets whether or not there are any exceptions that occurred.

Implementation of

IQueryResult.hasExceptions

Defined in

queries/QueryResult.ts:134

isAuthorized

readonly isAuthorized: boolean

Gets whether or not the query was authorized to execute.

Implementation of

IQueryResult.isAuthorized

Defined in

queries/QueryResult.ts:128

isSuccess

readonly isSuccess: boolean

Gets whether or not the query executed successfully.

Implementation of

IQueryResult.isSuccess

Defined in

queries/QueryResult.ts:125

isValid

readonly isValid: boolean

Gets whether or not the query is valid.

Implementation of

IQueryResult.isValid

Defined in

queries/QueryResult.ts:131

paging

readonly paging: PagingInfo

Gets the paging information.

Implementation of

IQueryResult.paging

Defined in

queries/QueryResult.ts:122

validationResults

readonly validationResults: ValidationResult[]

Gets any validation errors. If this collection is empty, there are errors.

Implementation of

IQueryResult.validationResults

Defined in

queries/QueryResult.ts:137

noSuccess

static noSuccess: QueryResult

Defined in

queries/QueryResult.ts:63

Accessors

hasData
Get Signature

get hasData(): boolean

Gets whether or not the query has data.

Returns

boolean

Gets whether or not the query has data.

Implementation of

IQueryResult.hasData

Defined in

queries/QueryResult.ts:148

Methods

empty()

static empty<TDataType>(defaultValue): QueryResult<TDataType>

Type Parameters

TDataType

Parameters
defaultValue

TDataType

Returns

QueryResult<TDataType>

Defined in

queries/QueryResult.ts:43