Class OnmsCollectType

Represents an OpenNMS SNMP interface "should collect" type.

Hierarchy

OnmsEnum<string>
- OnmsCollectType

Implements

IHasUrlValue

Index

Constructors

Accessors

id index label urlValue

Methods

isCollectionEnabled replace toDisplayString toJSON toString forId forLabel

Constructors

constructor

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

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:15

index

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

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

label

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

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

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/OnmsCollectType.ts:26

Methods

isCollectionEnabled

isCollectionEnabled(): boolean
whether or not collection is enabled on the SNMP interface

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

replace

replace(pattern: string | RegExp, replaceWith: string): string
Parameters
- pattern: string | RegExp
- replaceWith: string
Returns string
Inherited from OnmsEnum.replace
- Defined in src/internal/OnmsEnum.ts:54

toDisplayString

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

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

toJSON

toJSON(): {
    id: string;
    label: string;
    replace: (pattern: string | RegExp, replaceWith: string) => string;
}
convert to the JSON representation

Returns {
    id: string;
    label: string;
    replace: (pattern: string | RegExp, replaceWith: string) => string;
}
Inherited from OnmsEnum.toJSON
- Defined in src/internal/OnmsEnum.ts:46

toString

toString(): string
convert this enum to a string

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

`Static`forId

forId(id?: string): any
given an ID, return the matching collect type object
Parameters
- Optionalid: string
Returns any
- Defined in src/model/OnmsCollectType.ts:11

`Static`forLabel

forLabel(label?: string): any
given a label, return the matching collect type object
Parameters
- Optionallabel: string
Returns any
- Defined in src/model/OnmsCollectType.ts:16