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: IOnmsHTTP | IHasHTTP): SituationFeedbackDAO
Parameters
- impl: IOnmsHTTP | IHasHTTP
Returns SituationFeedbackDAO
Overrides BaseDAO.constructor
- Defined in src/dao/SituationFeedbackDAO.ts:17

Accessors

http

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

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

server

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

Returns OnmsServer
Inherited from BaseDAO.server
- Defined in src/dao/BaseDAO.ts:68
set server(s: OnmsServer): void
Parameters
- s: 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
- Optionalstatus: number
Returns number
Inherited from BaseDAO.getCount
- Defined in src/dao/BaseDAO.ts:139

getData

getData(result: any): OnmsSituationFeedback[]
Extracts the data from an HTTP Request result.
Parameters
- result: any
  the HTTP Request result.
Returns OnmsSituationFeedback[]
An array of [[OnmsSituationFeedback]] objects.
- Defined in src/dao/SituationFeedbackDAO.ts:79

getFeedback

getFeedback(situationId: number): Promise<OnmsSituationFeedback[]>
Retrieve feedback.
Parameters
- situationId: number
  The alarmId of the Situation to use when querying.
Returns Promise<OnmsSituationFeedback[]>
An array of [[OnmsSituationFeedback]] objects.

Version
ReST v1
- 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?: OnmsServer): void
Called whenever the OpenNMS server has changed.
Parameters
- Optionalserver: OnmsServer
  the new server
Returns void
Inherited from BaseDAO.onSetServer
- Defined in src/dao/BaseDAO.ts:121

saveFeedback

saveFeedback(
feedback: OnmsSituationFeedback[],
situationId: number,
): Promise<void>
Submit Correlation Feedback for a Situation.
Parameters
- feedback: OnmsSituationFeedback[]
  The [[OnmsSituationFeedback]].
- situationId: number
  The alarmId of the Situation to use when querying.
Returns Promise<void>
Version
ReST v1
- 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.
Parameters
- from: any
Returns Moment
Deprecated
use [[Util.toDate]] instead.
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.
Parameters
- from: any
Returns number
Deprecated
use [[Util.toNumber]] instead.
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