Class AlarmDAO

Data access for [[OnmsAlarm]] objects.

Hierarchy

AbstractDAO<number, OnmsAlarm>
- AlarmDAO

Constructors

constructor

new AlarmDAO(impl: IOnmsHTTP | IHasHTTP): AlarmDAO
Parameters
- impl: IOnmsHTTP | IHasHTTP
Returns AlarmDAO
Overrides AbstractDAO<number, OnmsAlarm>.constructor
- Defined in src/dao/AlarmDAO.ts:35

Accessors

http

get http(): IOnmsHTTP
The HTTP implementation to use internally when making DAO requests.

Returns IOnmsHTTP
Inherited from AbstractDAO.http
- Defined in src/dao/BaseDAO.ts:56
set http(impl: IOnmsHTTP): void
Parameters
- impl: IOnmsHTTP
Returns void
Inherited from AbstractDAO.http
- Defined in src/dao/BaseDAO.ts:61

server

get server(): OnmsServer
The [[OnmsServer]] being connected to by this DAO.

Returns OnmsServer
Inherited from AbstractDAO.server
- Defined in src/dao/BaseDAO.ts:68
set server(s: OnmsServer): void
Parameters
- s: OnmsServer
Returns void
Inherited from AbstractDAO.server
- Defined in src/dao/BaseDAO.ts:76

Methods

acknowledge

acknowledge(alarm: number | OnmsAlarm, user?: string): Promise<void>
Acknowledge an alarm.
Parameters
- alarm: number | OnmsAlarm
  The [[OnmsAlarm]] or alarm ID.
- Optionaluser: string
  The user to ack the alarm as. (Only administrators have the right to do this.)
Returns Promise<void>
Version
ReST v1+
- Defined in src/dao/AlarmDAO.ts:123

clear

clear(alarm: number | OnmsAlarm): Promise<void>
Clear an alarm.
Parameters
- alarm: number | OnmsAlarm
  The [[OnmsAlarm]] or alarm ID.
Returns Promise<void>
Version
ReST v1+
- Defined in src/dao/AlarmDAO.ts:168

closeTicket

closeTicket(alarm: number | OnmsAlarm): Promise<void>
Close the ticket associated with the given alarm.
Parameters
- alarm: number | OnmsAlarm
  The [[OnmsAlarm]] or alarm ID.
Returns Promise<void>
Version
ReST v2
- Defined in src/dao/AlarmDAO.ts:247

createTicket

createTicket(alarm: number | OnmsAlarm): Promise<void>
Create a trouble ticket for the specified alarm.
Parameters
- alarm: number | OnmsAlarm
  The [[OnmsAlarm]] or alarm ID.
Returns Promise<void>
Version
ReST v2
- Defined in src/dao/AlarmDAO.ts:209

deleteJournalMemo

deleteJournalMemo(alarm: number | OnmsAlarm): Promise<void>
Delete the journal memo ticket associated with the given alarm.
Parameters
- alarm: number | OnmsAlarm
  The [[OnmsAlarm]] or alarm ID.
Returns Promise<void>
Version
ReST v2
- Defined in src/dao/AlarmDAO.ts:302

deleteStickyMemo

deleteStickyMemo(alarm: number | OnmsAlarm): Promise<void>
Delete the sticky memo ticket associated with the given alarm.
Parameters
- alarm: number | OnmsAlarm
  The [[OnmsAlarm]] or alarm ID.
Returns Promise<void>
Version
ReST v2
- Defined in src/dao/AlarmDAO.ts:292

escalate

escalate(alarm: number | OnmsAlarm): Promise<void>
Escalate an alarm.
Parameters
- alarm: number | OnmsAlarm
  The [[OnmsAlarm]] or alarm ID.
Returns Promise<void>
Version
ReST v1+
- Defined in src/dao/AlarmDAO.ts:155

find

find(filter?: Filter): Promise<OnmsAlarm[]>
Find matching alarms.
Parameters
- Optionalfilter: Filter
  The filter to use when querying.
Returns Promise<OnmsAlarm[]>
An array of [[OnmsAlarm]] objects.

Version
ReST v1+
Overrides AbstractDAO.find
- Defined in src/dao/AlarmDAO.ts:66

findValues

findValues(propertyId: string, options?: any): Promise<any>
Finds the values for the given propertyId, if it exists.
Parameters
- propertyId: string
  The propertyId to find the values for
- Optionaloptions: any
  Some additional options. May be implementer dependent, such as limit, or value restrictions
Returns Promise<any>
A promise containing the values.
Inherited from AbstractDAO.findValues
- Defined in src/dao/AbstractDAO.ts:107

get

get(id: number): Promise<OnmsAlarm>
Fetch an alarm.
Parameters
- id: number
  The alarm's ID.
Returns Promise<OnmsAlarm>
An [[OnmsAlarm]].

Version
ReST v1+
Overrides AbstractDAO.get
- Defined in src/dao/AlarmDAO.ts:47

`Protected`getApiVersion

getApiVersion(): number
Retrieve the API version from the currently configured server.

Returns number
Inherited from AbstractDAO.getApiVersion
- Defined in src/dao/AbstractDAO.ts:240

`Protected`getCount

getCount(data: any, status?: number): number
A convenience method to make it easy for implementers to extract the count (or totalCount) values from response data.
Parameters
- data: any
- Optionalstatus: number
Returns number
Inherited from AbstractDAO.getCount
- Defined in src/dao/BaseDAO.ts:139

getData

getData(result: OnmsResult<any>): OnmsAlarm[]
Extracts the data from an HTTP Request result.
Parameters
- result: OnmsResult<any>
  the HTTP Request result.
Returns OnmsAlarm[]
An array of [[OnmsAlarm]] objects.
- Defined in src/dao/AlarmDAO.ts:96

getFilterProcessor

getFilterProcessor(): Promise<IFilterProcessor>
Returns the Promise for a [[IFilterProcessor]].

Returns Promise<IFilterProcessor>
Inherited from AbstractDAO.getFilterProcessor
- Defined in src/dao/AbstractDAO.ts:39

getPropertiesCache

getPropertiesCache(): Promise<any>
Returns or creates a cache of properties for this dao.

Returns Promise<any>
the cache for this dao. It is created if it does not exist.
Inherited from AbstractDAO.getPropertiesCache
- Defined in src/dao/AbstractDAO.ts:84

`Protected`onSetServer

onSetServer(server: OnmsServer): void
Parameters
- server: OnmsServer
Returns void
Inherit Doc
Inherited from AbstractDAO.onSetServer
- Defined in src/dao/AbstractDAO.ts:123

`Protected`parseResultList

parseResultList(
    result: any,
    dataFieldName: string,
    path: string,
    mapCallbackFunction: any,
): any[]
Fetches the data from the result and verfifes that the dataFieldName exists in the data property. If it does not exist, an exception is thrown.
Parameters
- result: any
  The result to fetch the data from
- dataFieldName: string
  The property name (basically result.data[dataFieldName].
- path: string
  The path where the result was fetched from. This is for error handling
- mapCallbackFunction: any
  Callback function to convert each entry from result.data[dataFieldName].
Returns any[]
Inherited from AbstractDAO.parseResultList
- Defined in src/dao/AbstractDAO.ts:142

saveJournalMemo

saveJournalMemo(
    alarm: number | OnmsAlarm,
    body: string,
    user?: string,
): Promise<void>
Create or update the journal memo associated with the alarm.
Parameters
- alarm: number | OnmsAlarm
  The [[OnmsAlarm]] or alarm ID.
- body: string
  The memo body
- Optionaluser: string
  The user to update the memo as. (Only administrators have the right to do this.)
Returns Promise<void>
Version
ReST v2
- Defined in src/dao/AlarmDAO.ts:282

saveStickyMemo

saveStickyMemo(
    alarm: number | OnmsAlarm,
    body: string,
    user?: string,
): Promise<void>
Create or update the sticky memo associated with the alarm.
Parameters
- alarm: number | OnmsAlarm
  The [[OnmsAlarm]] or alarm ID.
- body: string
  The memo body
- Optionaluser: string
  The user to update the memo as. (Only administrators have the right to do this.)
Returns Promise<void>
Version
ReST v2
- Defined in src/dao/AlarmDAO.ts:269

searchProperties

searchProperties(): Promise<SearchProperty[]>
Get the list properties that can be used in queries.

Returns Promise<SearchProperty[]>
Version
ReST v2
Inherited from AbstractDAO.searchProperties
- Defined in src/dao/AbstractDAO.ts:65

searchProperty

searchProperty(id: string): Promise<SearchProperty>
Gets the property identified by the id if it exists.
Parameters
- id: string
  The id to search the property by.
Returns Promise<SearchProperty>
Inherited from AbstractDAO.searchProperty
- Defined in src/dao/AbstractDAO.ts:74

`Protected`searchPropertyPath

searchPropertyPath(): string
The path to the alarm search properties endpoint.

Returns string
Overrides AbstractDAO.searchPropertyPath
- Defined in src/dao/AlarmDAO.ts:425

setTTicketId

setTTicketId(alarm: number | OnmsAlarm, ticketId: string): Promise<void>
Associate a ticket ID with the alarm.
Parameters
- alarm: number | OnmsAlarm
  The [[OnmsAlarm]] or alarm ID.
- ticketId: string
  The ticket ID.
Returns Promise<void>
Version
ReST v1+
- Defined in src/dao/AlarmDAO.ts:182

setTTicketState

setTTicketState(
alarm: number | OnmsAlarm,
state: OnmsTroubleTicketState,
): Promise<void>
Update the state of the ticket associated with the alarm.
Parameters
- alarm: number | OnmsAlarm
  The [[OnmsAlarm]] or alarm ID.
- state: OnmsTroubleTicketState
  The ticket state.
Returns Promise<void>
Version
ReST v1+
- Defined in src/dao/AlarmDAO.ts:196

`Protected`toDate

toDate(from: any): Moment
Convert the given value to a date, or undefined if it cannot be converted.
Parameters
- from: any
Returns Moment
Deprecated
use [[Util.toDate]] instead.
Inherited from AbstractDAO.toDate
- Defined in src/dao/BaseDAO.ts:161

`Protected`toNumber

toNumber(from: any): number
Convert the given value to a number, or undefined if it cannot be converted.
Parameters
- from: any
Returns number
Deprecated
use [[Util.toNumber]] instead.
Inherited from AbstractDAO.toNumber
- Defined in src/dao/BaseDAO.ts:169

triggerTicketUpdate

triggerTicketUpdate(alarm: number | OnmsAlarm): Promise<void>
Notify OpenNMS it should fetch updated ticket state for an alarm from the remote ticketing system.
Parameters
- alarm: number | OnmsAlarm
  The [[OnmsAlarm]] or alarm ID.
Returns Promise<void>
Version
ReST v2
- Defined in src/dao/AlarmDAO.ts:228

unacknowledge

unacknowledge(alarm: number | OnmsAlarm, user?: string): Promise<void>
Un-acknowledge an alarm.
Parameters
- alarm: number | OnmsAlarm
  The [[OnmsAlarm]] or alarm ID.
- Optionaluser: string
Returns Promise<void>
Version
ReST v1+
- Defined in src/dao/AlarmDAO.ts:139

`Protected`useJson

useJson(): boolean
Whether or not to use JSON when making ReST requests.

Returns boolean
Inherited from AbstractDAO.useJson
- Defined in src/dao/BaseDAO.ts:128

`Protected`visitClause

visitClause(clause: Clause, visitor: IFilterVisitor): void
"visits" a filter clause, applying it to the filter visitor
Parameters
- clause: Clause
  the clause to visit
- visitor: IFilterVisitor
  the visitor impl to invoke
Returns void
Inherited from AbstractDAO.visitClause
- Defined in src/dao/AbstractDAO.ts:164

`Protected`visitFilter

visitFilter(filter: Filter, visitor: IFilterVisitor): void
Iterate over a Filter object and its children.
Parameters
- filter: Filter
  the filter to visit
- visitor: IFilterVisitor
  the class to invoke while visiting the filter
Returns void
Inherited from AbstractDAO.visitFilter
- Defined in src/dao/AbstractDAO.ts:187

Class AlarmDAO

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns AlarmDAO

Accessors

http

Returns IOnmsHTTP

Parameters

Returns void

server

Returns OnmsServer

Parameters

Returns void

Methods

acknowledge

Parameters

Returns Promise<void>

Version

clear

Parameters

Returns Promise<void>

Version

closeTicket

Parameters

Returns Promise<void>

Version

createTicket

Parameters

Returns Promise<void>

Version

deleteJournalMemo

Parameters

Returns Promise<void>

Version

deleteStickyMemo

Parameters

Returns Promise<void>

Version

escalate

Parameters

Returns Promise<void>

Version

find

Parameters

Returns Promise<OnmsAlarm[]>

Version

findValues

Parameters

Returns Promise<any>

get

Parameters

Returns Promise<OnmsAlarm>

Version

ProtectedgetApiVersion

Returns number

ProtectedgetCount

Parameters

Returns number

getData

Parameters

Returns OnmsAlarm[]

getFilterProcessor

Returns Promise<IFilterProcessor>

getPropertiesCache

Returns Promise<any>

ProtectedonSetServer

Parameters

Returns void

Inherit Doc

ProtectedparseResultList

Parameters

Returns any[]

saveJournalMemo

Parameters

`Protected`getApiVersion

`Protected`getCount

`Protected`onSetServer

`Protected`parseResultList

`Protected`searchPropertyPath

`Protected`toDate

`Protected`toNumber

`Protected`useJson

`Protected`visitClause

`Protected`visitFilter