Class OINODbQueryOrder

Class for ordering select results on a number of columns.

Hierarchy (View Summary)

OINOQueryOrder
- OINODbQueryOrder

Index

Constructors

Properties

columns descending

Methods

isEmpty parse printSql

Constructors

constructor

new OINODbQueryOrder(
column_or_array: string | string[],
descending_or_array: boolean | boolean[],
): OINODbQueryOrder
Constructor for OINOQueryOrder.
Parameters
- column_or_array: string | string[]
  single or array of columns to order on
- descending_or_array: boolean | boolean[]
  single or array of booleans if ordes is descending
Returns OINODbQueryOrder
Inherited from OINOQueryOrder.constructor
- Defined in common/src/OINOQueryParams.ts:220

Properties

`Readonly`columns

columns: string[]

`Readonly`descending

descending: boolean[]

Methods

isEmpty

isEmpty(): boolean
Does filter contain any valid conditions.

Returns boolean
Inherited from OINOQueryOrder.isEmpty
- Defined in common/src/OINOQueryParams.ts:265

`Static`parse

parse(orderString: string): OINOQueryOrder
Constructor for OINOQueryOrder as parser of http parameter.

Supports comma separated list of column orders formatted as :
- column - order by column in ascending order
- column ASC|DESC - order by single either ascending or descending order
- column+|- - order by single either ascending or descending order
Parameters
- orderString: string
  string representation of order from HTTP-request
Returns OINOQueryOrder
Inherited from OINOQueryOrder.parse
- Defined in common/src/OINOQueryParams.ts:244

`Static`printSql

printSql(order: OINOQueryOrder, dataModel: OINODbDataModel): string
Print order as SQL condition based on the datamodel of the API.
Parameters
- order: OINOQueryOrder
  order instance
- dataModel: OINODbDataModel
  data model (and database) to use for formatting of values
Returns string
- Defined in db/src/OINODbQueryParams.ts:115