Class SearchPropertyType

Represents a search property type.

Hierarchy

OnmsEnum<string>
- SearchPropertyType

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new SearchPropertyType(id: string, label: string): SearchPropertyType

Inherited from OnmsEnum.constructor
- Defined in internal/OnmsEnum.ts:26
construct an enum object with an id and label

Parameters
- id: string
- label: string
Returns SearchPropertyType

Accessors

id

get id(): T

Inherited from OnmsEnum.id
- Defined in internal/OnmsEnum.ts:14
get the index/id of this enum entry

Returns T

index

get index(): T

Inherited from OnmsEnum.index
- Defined in internal/OnmsEnum.ts:19
an alias for OnmsEnum.id

Returns T

label

get label(): string

Inherited from OnmsEnum.label
- Defined in internal/OnmsEnum.ts:24
get the label of this enum entry

Returns string

Methods

toDisplayString

toDisplayString(): string

Inherited from OnmsEnum.toDisplayString
- Defined in internal/OnmsEnum.ts:35
convert this enum to a string suitable for display

Returns string

toJSON

toJSON(): object

Inherited from OnmsEnum.toJSON
- Defined in internal/OnmsEnum.ts:45
convert to the JSON representation

Returns object
- id: T
- label: string

toString

toString(): T

Inherited from OnmsEnum.toString
- Defined in internal/OnmsEnum.ts:40
convert this enum to a string

Returns T

Static forId

forId(id: string): any

- Defined in api/SearchPropertyType.ts:9
given an ID, return the matching search property type object

Parameters
- id: string
Returns any

Generated using TypeDoc