Class OnmsPrimaryType

Represents an OpenNMS "SNMP primary" type.

Hierarchy

OnmsEnum<string>
- OnmsPrimaryType

Implements

IHasUrlValue

Index

Constructors

Accessors

id index label urlValue

Methods

isPrimary toDisplayString toJSON toString forId forLabel

Constructors

constructor

new OnmsPrimaryType(id, label): OnmsPrimaryType
construct an enum object with an id and label
Parameters
- id: string
- label: string
Returns OnmsPrimaryType
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

urlValue

get urlValue(): string
The value of this object when added to an OpenNMS URL parameter.

Returns string
Implementation of IHasUrlValue.urlValue
- Defined in src/model/OnmsPrimaryType.ts:26

Methods

isPrimary

isPrimary(): boolean
Whether or not the interface is a primary SNMP interface.

Returns boolean
- Defined in src/model/OnmsPrimaryType.ts:21

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
Given an ID, return the matching primary type object.
Parameters
- Optional id: string
Returns any
- Defined in src/model/OnmsPrimaryType.ts:11

`Static` forLabel

forLabel(label?): any
Given a label, return the matching primary type object.
Parameters
- Optional label: string
Returns any
- Defined in src/model/OnmsPrimaryType.ts:16