Class SituationFeedbackDAO

Data access for OnmsSituationFeedback objects.

Hierarchy

BaseDAO
- SituationFeedbackDAO

Index

Constructors

Accessors

Methods

getCount getData getFeedback getTags onSetServer saveFeedback toDate toNumber useJson

Constructors

constructor

new SituationFeedbackDAO(impl: API.IOnmsHTTP | API.IHasHTTP): DAO.SituationFeedbackDAO
Parameters
- impl: API.IOnmsHTTP | API.IHasHTTP
Returns DAO.SituationFeedbackDAO
Overrides BaseDAO.constructor
- Defined in src/dao/SituationFeedbackDAO.ts:17

Accessors

http

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

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

server

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

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

Methods

`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
- Optional status: number
Returns number
Inherited from BaseDAO.getCount
- Defined in src/dao/BaseDAO.ts:139

getData

getData(result: any): Model.OnmsSituationFeedback[]
Extracts the data from an HTTP Request result.

Returns
An array of OnmsSituationFeedback objects.
Parameters
- result: any
  
  the HTTP Request result.
Returns Model.OnmsSituationFeedback[]
- Defined in src/dao/SituationFeedbackDAO.ts:79

getFeedback

getFeedback(situationId: number): Promise<Model.OnmsSituationFeedback[]>
Retrieve feedback.

Version
ReST v1

Returns
An array of OnmsSituationFeedback objects.
Parameters
- situationId: number
  
  The alarmId of the Situation to use when querying.
Returns Promise<Model.OnmsSituationFeedback[]>
- Defined in src/dao/SituationFeedbackDAO.ts:28

getTags

getTags(prefix: string): Promise<string[]>
Retrieve the tags for a given prefix
Parameters
- prefix: string
  
  the prefix associated with the tags
Returns Promise<string[]>
- Defined in src/dao/SituationFeedbackDAO.ts:48

`Protected` onSetServer

onSetServer(server?: API.OnmsServer): void
Called whenever the OpenNMS server has changed.
Parameters
- Optional server: API.OnmsServer
  
  the new server
Returns void
Inherited from BaseDAO.onSetServer
- Defined in src/dao/BaseDAO.ts:121

saveFeedback

saveFeedback(feedback: Model.OnmsSituationFeedback[], situationId: number): Promise<void>
Submit Correlation Feedback for a Situation.

Version
ReST v1
Parameters
- feedback: Model.OnmsSituationFeedback[]
  
  The OnmsSituationFeedback.
- situationId: number
  
  The alarmId of the Situation to use when querying.
Returns Promise<void>
- Defined in src/dao/SituationFeedbackDAO.ts:69

`Protected` toDate

toDate(from: any): Moment
Convert the given value to a date, or undefined if it cannot be converted.

Deprecated
use Util.toDate instead.
Parameters
- from: any
Returns Moment
Inherited from BaseDAO.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.

Deprecated
use Util.toNumber instead.
Parameters
- from: any
Returns number
Inherited from BaseDAO.toNumber
- Defined in src/dao/BaseDAO.ts:169

`Protected` useJson

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

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

Generated using TypeDoc