Class Order

Represents a sort order.

Hierarchy

OnmsEnum<string>
- Order

Index

Constructors

Accessors

Methods

matches toDisplayString toJSON toString forLabel fromString

Constructors

constructor

new Order(id: string, label: string): API.Order
construct an enum object with an id and label
Parameters
- id: string
- label: string
Returns API.Order
Inherited from OnmsEnum<string>.constructor
- Defined in src/internal/OnmsEnum.ts:28

Accessors

id

get id(): T
get the index/id of this enum entry

Returns T
Inherited from OnmsEnum.id
- Defined in src/internal/OnmsEnum.ts:13

index

get index(): T
an alias for [[OnmsEnum.id]]

Returns T
Inherited from OnmsEnum.index
- Defined in src/internal/OnmsEnum.ts:18

label

get label(): string
get the label of this enum entry

Returns string
Inherited from OnmsEnum.label
- Defined in src/internal/OnmsEnum.ts:23

Methods

matches

matches(label: string): boolean
Whether this order matches the given order string.
Parameters
- label: string
Returns boolean
- Defined in src/api/OrderBy.ts:27

toDisplayString

toDisplayString(): string
convert this enum to a string suitable for display

Returns string
Inherited from OnmsEnum.toDisplayString
- Defined in src/internal/OnmsEnum.ts:34

toJSON

toJSON(): { id: string; label: string }
convert to the JSON representation

Returns { id: string; label: string }
Inherited from OnmsEnum.toJSON
- Defined in src/internal/OnmsEnum.ts:44

toString

toString(): string
convert this enum to a string

Returns string
Inherited from OnmsEnum.toString
- Defined in src/internal/OnmsEnum.ts:39

`Static`forLabel

forLabel(label: string): any
Given a label ('ASC', 'DESC'), return the corresponding order.
Parameters
- label: string
Returns any
- Defined in src/api/OrderBy.ts:12

`Static`fromString

fromString(order: string): API.Order
given an order spec (order=DESC), return an [[Order]] object
Parameters
- order: string
Returns API.Order
- Defined in src/api/OrderBy.ts:17