Class SearchPropertyType

Represents a search property type.

Hierarchy

OnmsEnum<string>
- SearchPropertyType

Index

Constructors

Properties

Accessors

Methods

getComparators toDisplayString toJSON toString forId forLabel

Constructors

constructor

new SearchPropertyType(id, label, someComparators): SearchPropertyType
Parameters
- id: string
- label: string
- someComparators: Comparator[]
Returns SearchPropertyType
Overrides OnmsEnum<string>.constructor
- Defined in src/api/SearchPropertyType.ts:22

Properties

`Private` `Readonly` comparators

comparators: Comparator[]

supported comparators.

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

getComparators

getComparators(): Comparator[]
Returns the comparators supported by this type.

Returns Comparator[]
the supported comparators.
- Defined in src/api/SearchPropertyType.ts:32

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;
}
- 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` forId

forId(id?): any
Parameters
- Optional id: string
Returns any
Inherit Doc
- Defined in src/api/SearchPropertyType.ts:10

`Static` forLabel

forLabel(label?): any
Parameters
- Optional label: string
Returns any
Inherit Doc
- Defined in src/api/SearchPropertyType.ts:15