Class EventDAO

Data access for OnmsEvent objects.

Hierarchy

AbstractDAO<number, OnmsEvent>
- EventDAO

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new EventDAO(impl: IHasHTTP | IOnmsHTTP): EventDAO

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

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

find

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

Overrides AbstractDAO.find
- Defined in dao/EventDAO.ts:39
Get an event, given a filter.

Parameters
- Optional filter: Filter
Returns Promise<OnmsEvent[]>

get

get(id: number): Promise<OnmsEvent>

Overrides AbstractDAO.get
- Defined in dao/EventDAO.ts:31
Get an event, given the event's ID.

Parameters
- id: number
Returns Promise<OnmsEvent>

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

Protected getOptions

getOptions(filter?: Filter): OnmsHTTPOptions

Inherited from AbstractDAO.getOptions
- Defined in dao/AbstractDAO.ts:157
Create an OnmsHTTPOptions object for DAO calls given an optional filter.

Parameters
- Optional filter: Filter
  
  the filter to use
Returns OnmsHTTPOptions

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/EventDAO.ts:116
The path to the event search properties endpoint.

Returns string

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

Generated using TypeDoc