Class AlarmDAO

Data access for OnmsAlarm objects.

Hierarchy

AbstractDAO<number, OnmsAlarm>
- AlarmDAO

Index

Constructors

constructor

Accessors

Constructors

constructor

new AlarmDAO(impl: IHasHTTP | IOnmsHTTP): AlarmDAO

Overrides AbstractDAO.constructor
- Defined in dao/AlarmDAO.ts:36
Parameters
- impl: IHasHTTP | IOnmsHTTP
Returns AlarmDAO

Accessors

filterProcessor

get filterProcessor(): IFilterProcessor
set filterProcessor(impl: IFilterProcessor): void

Inherited from AbstractDAO.filterProcessor
- Defined in dao/AbstractDAO.ts:70
Returns IFilterProcessor
Inherited from AbstractDAO.filterProcessor
- Defined in dao/AbstractDAO.ts:83
Parameters
- impl: IFilterProcessor
Returns void

http

get http(): IOnmsHTTP
set http(impl: IOnmsHTTP): void

Inherited from AbstractDAO.http
- Defined in dao/AbstractDAO.ts:62
The HTTP implementation to use internally when making DAO requests.

Returns IOnmsHTTP
Inherited from AbstractDAO.http
- Defined in dao/AbstractDAO.ts:66
The HTTP implementation to use internally when making DAO requests.

Parameters
- impl: IOnmsHTTP
Returns void

Methods

acknowledge

acknowledge(alarm: number | OnmsAlarm, user?: string): Promise<void>

- Defined in dao/AlarmDAO.ts:96
Acknowledge an alarm.

version

ReST v1+

Parameters
- alarm: number | OnmsAlarm
- Optional user: string
  
  The user to ack the alarm as. (Only administrators have the right to do this.)
Returns Promise<void>

clear

clear(alarm: number | OnmsAlarm): Promise<void>

- Defined in dao/AlarmDAO.ts:138
Clear an alarm.

version

ReST v1+

Parameters
- alarm: number | OnmsAlarm
  
  The OnmsAlarm or alarm ID.
Returns Promise<void>

closeTicket

closeTicket(alarm: number | OnmsAlarm): Promise<void>

- Defined in dao/AlarmDAO.ts:229
Close the ticket associated with the given alarm.

version

ReST v2

Parameters
- alarm: number | OnmsAlarm
  
  The OnmsAlarm or alarm ID.
Returns Promise<void>

createTicket

createTicket(alarm: number | OnmsAlarm): Promise<void>

- Defined in dao/AlarmDAO.ts:179
Create a trouble ticket for the specified alarm.

version

ReST v2

Parameters
- alarm: number | OnmsAlarm
  
  The OnmsAlarm or alarm ID.
Returns Promise<void>

deleteJournalMemo

deleteJournalMemo(alarm: number | OnmsAlarm): Promise<void>

- Defined in dao/AlarmDAO.ts:290
Delete the journal memo ticket associated with the given alarm.

version

ReST v2

Parameters
- alarm: number | OnmsAlarm
  
  The OnmsAlarm or alarm ID.
Returns Promise<void>

deleteStickyMemo

deleteStickyMemo(alarm: number | OnmsAlarm): Promise<void>

- Defined in dao/AlarmDAO.ts:280
Delete the sticky memo ticket associated with the given alarm.

version

ReST v2

Parameters
- alarm: number | OnmsAlarm
  
  The OnmsAlarm or alarm ID.
Returns Promise<void>

escalate

escalate(alarm: number | OnmsAlarm): Promise<void>

- Defined in dao/AlarmDAO.ts:125
Escalate an alarm.

version

ReST v1+

Parameters
- alarm: number | OnmsAlarm
  
  The OnmsAlarm or alarm ID.
Returns Promise<void>

find

find(filter?: Filter): Promise<OnmsAlarm[]>

Overrides AbstractDAO.find
- Defined in dao/AlarmDAO.ts:64
Find matching alarms.

version

ReST v1+

Parameters
- Optional filter: Filter
  
  The filter to use when querying.
Returns Promise<OnmsAlarm[]>

An array of OnmsAlarm objects.

get

get(id: number): Promise<OnmsAlarm>

Overrides AbstractDAO.get
- Defined in dao/AlarmDAO.ts:50
Fetch an alarm.

version

ReST v1+

Parameters
- id: number
  
  The alarm's ID.
Returns Promise<OnmsAlarm>

An OnmsAlarm.

Protected getApiVersion

getApiVersion(): number

Inherited from AbstractDAO.getApiVersion
- Defined in dao/AbstractDAO.ts:205
Retrieve the API version from the currently configured server.

Returns number

Protected getCount

getCount(data: any): number

Inherited from AbstractDAO.getCount
- Defined in dao/AbstractDAO.ts:139
A convenience method to make it easy for implementers to extract the count (or totalCount) values from response data.

Parameters
- data: any
Returns number

saveJournalMemo

saveJournalMemo(alarm: number | OnmsAlarm, body: string, user?: string): Promise<void>

- Defined in dao/AlarmDAO.ts:270
Create or update the journal memo associated with the alarm.

version

ReST v2

Parameters
- alarm: number | OnmsAlarm
  
  The OnmsAlarm or alarm ID.
- body: string
  
  The memo body
- Optional user: string
  
  The user to update the memo as. (Only administrators have the right to do this.)
Returns Promise<void>

saveStickyMemo

saveStickyMemo(alarm: number | OnmsAlarm, body: string, user?: string): Promise<void>

- Defined in dao/AlarmDAO.ts:257
Create or update the sticky memo associated with the alarm.

version

ReST v2

Parameters
- alarm: number | OnmsAlarm
  
  The OnmsAlarm or alarm ID.
- body: string
  
  The memo body
- Optional user: string
  
  The user to update the memo as. (Only administrators have the right to do this.)
Returns Promise<void>

searchProperties

searchProperties(): Promise<SearchProperty[]>

Inherited from AbstractDAO.searchProperties
- Defined in dao/AbstractDAO.ts:103
Get the list properties that can be used in queries.

version

ReST v2

Returns Promise<SearchProperty[]>

Protected searchPropertyPath

searchPropertyPath(): string

Overrides AbstractDAO.searchPropertyPath
- Defined in dao/AlarmDAO.ts:392
The path to the alarm search properties endpoint.

Returns string

setTTicketId

setTTicketId(alarm: number | OnmsAlarm, ticketId: string): Promise<void>

- Defined in dao/AlarmDAO.ts:152
Associate a ticket ID with the alarm.

version

ReST v1+

Parameters
- alarm: number | OnmsAlarm
  
  The OnmsAlarm or alarm ID.
- ticketId: string
  
  The ticket ID.
Returns Promise<void>

setTTicketState

setTTicketState(alarm: number | OnmsAlarm, state: OnmsTroubleTicketState): Promise<void>

- Defined in dao/AlarmDAO.ts:166
Update the state of the ticket associated with the alarm.

version

ReST v1+

Parameters
- alarm: number | OnmsAlarm
  
  The OnmsAlarm or alarm ID.
- state: OnmsTroubleTicketState
  
  The ticket state.
Returns Promise<void>

Protected toDate

toDate(from: any): Moment | undefined

Inherited from AbstractDAO.toDate
- Defined in dao/AbstractDAO.ts:170
Convert the given value to a date, or undefined if it cannot be converted.

Parameters
- from: any
Returns Moment | undefined

Protected toNumber

toNumber(from: any): number | undefined

Inherited from AbstractDAO.toNumber
- Defined in dao/AbstractDAO.ts:180
Convert the given value to a number, or undefined if it cannot be converted.

Parameters
- from: any
Returns number | undefined

triggerTicketUpdate

triggerTicketUpdate(alarm: number | OnmsAlarm): Promise<void>

- Defined in dao/AlarmDAO.ts:204
Notify OpenNMS it should fetch updated ticket state for an alarm from the remote ticketing system.

version

ReST v2

Parameters
- alarm: number | OnmsAlarm
  
  The OnmsAlarm or alarm ID.
Returns Promise<void>

unacknowledge

unacknowledge(alarm: number | OnmsAlarm): Promise<void>

- Defined in dao/AlarmDAO.ts:112
Un-acknowledge an alarm.

version

ReST v1+

Parameters
- alarm: number | OnmsAlarm
  
  The OnmsAlarm or alarm ID.
Returns Promise<void>

Generated using TypeDoc