Class OINODbQueryLimit

Class for limiting the number of results.

Hierarchy (View Summary)

OINOQueryLimit
- OINODbQueryLimit

Index

Constructors

Properties

Methods

isEmpty parse printSql

Constructors

constructor

new OINODbQueryLimit(limit: number, page?: number): OINODbQueryLimit
Constructor for OINOQueryLimit.
Parameters
- limit: number
  maximum number of items to return
- page: number = -1
  page number to return starting from 1
Returns OINODbQueryLimit
Inherited from OINOQueryLimit.constructor
- Defined in common/src/OINOQueryParams.ts:287

Properties

`Readonly`limit

limit: number

`Readonly`page

page: number

Methods

isEmpty

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

Returns boolean
Inherited from OINOQueryLimit.isEmpty
- Defined in common/src/OINOQueryParams.ts:317

`Static`parse

parse(limitString: string): OINOQueryLimit
Constructor for OINOQueryLimit as parser of http parameter.

Supports limit and page formatted as:
- limit - limit number of items to return
- limit page n - limit number of items to return and return page n (starting from 1)
- limit.n - limit number of items to return and return page n (starting from 1)
Parameters
- limitString: string
  string representation of limit from HTTP-request
Returns OINOQueryLimit
Inherited from OINOQueryLimit.parse
- Defined in common/src/OINOQueryParams.ts:302

`Static`printSql

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