Class IpInterfaceDAO

Data access for [[OnmsIpInterface]] objects.

Hierarchy

AbstractDAO<number, Model.OnmsIpInterface>
- IpInterfaceDAO

Index

Constructors

constructor

new IpInterfaceDAO(impl: API.IOnmsHTTP | API.IHasHTTP): DAO.IpInterfaceDAO
Parameters
- impl: API.IOnmsHTTP | API.IHasHTTP
Returns DAO.IpInterfaceDAO
Overrides AbstractDAO<number, OnmsIpInterface>.constructor
- Defined in src/dao/IpInterfaceDAO.ts:15

Accessors

http

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

Returns API.IOnmsHTTP
Inherited from AbstractDAO.http
- Defined in src/dao/BaseDAO.ts:56
set http(impl: API.IOnmsHTTP): void
Parameters
- impl: API.IOnmsHTTP
Returns void
Inherited from AbstractDAO.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 AbstractDAO.server
- Defined in src/dao/BaseDAO.ts:68
set server(s: API.OnmsServer): void
Parameters
- s: API.OnmsServer
Returns void
Inherited from AbstractDAO.server
- Defined in src/dao/BaseDAO.ts:76

Methods

find

find(filter?: API.Filter): Promise<Model.OnmsIpInterface[]>
Search for IP interfaces, given an optional filter.
Parameters
- Optionalfilter: API.Filter
Returns Promise<Model.OnmsIpInterface[]>
Overrides AbstractDAO.find
- Defined in src/dao/IpInterfaceDAO.ts:40

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<Model.OnmsIpInterface>
Get an IP interface, given the interface's ID.
Parameters
- id: number
  The interface's ID.
Returns Promise<Model.OnmsIpInterface>
Overrides AbstractDAO.get
- Defined in src/dao/IpInterfaceDAO.ts:24

`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

getFilterProcessor

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

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

`Protected`getOptions

getOptions(filter?: API.Filter): Promise<API.OnmsHTTPOptionsBuilder>
Create an [[OnmsHTTPOptions]] object for DAO calls given an optional filter.
Parameters
- Optionalfilter: API.Filter
  the filter to use
Returns Promise<API.OnmsHTTPOptionsBuilder>
Inherited from AbstractDAO.getOptions
- Defined in src/dao/AbstractDAO.ts:201

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: API.OnmsServer): void
Parameters
- server: API.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

searchProperties

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

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

searchProperty

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

`Protected`searchPropertyPath

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

Returns string
Overrides AbstractDAO.searchPropertyPath
- Defined in src/dao/IpInterfaceDAO.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 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

`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: API.Clause, visitor: API.IFilterVisitor): void
"visits" a filter clause, applying it to the filter visitor
Parameters
- clause: API.Clause
  the clause to visit
- visitor: API.IFilterVisitor
  the visitor impl to invoke
Returns void
Inherited from AbstractDAO.visitClause
- Defined in src/dao/AbstractDAO.ts:164

`Protected`visitFilter

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

Class IpInterfaceDAO

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns DAO.IpInterfaceDAO

Accessors

http

Returns API.IOnmsHTTP

Parameters

Returns void

server

Returns API.OnmsServer

Parameters

Returns void

Methods

find

Parameters

Returns Promise<Model.OnmsIpInterface[]>

findValues

Parameters

Returns Promise<any>

get

Parameters

Returns Promise<Model.OnmsIpInterface>

ProtectedgetApiVersion

Returns number

ProtectedgetCount

Parameters

Returns number

getFilterProcessor

Returns Promise<API.IFilterProcessor>

ProtectedgetOptions

Parameters

Returns Promise<API.OnmsHTTPOptionsBuilder>

getPropertiesCache

Returns Promise<any>

ProtectedonSetServer

Parameters

Returns void

Inherit Doc

ProtectedparseResultList

Parameters

Returns any[]

searchProperties

Returns Promise<API.SearchProperty[]>

Version

searchProperty

Parameters

Returns Promise<API.SearchProperty>

ProtectedsearchPropertyPath

Returns string

ProtectedtoDate

Parameters

Returns Moment

Deprecated

ProtectedtoNumber

Parameters

Returns number

Deprecated

ProtecteduseJson

Returns boolean

ProtectedvisitClause

Parameters

Returns void

ProtectedvisitFilter

Parameters

Returns void

Settings

On This Page

`Protected`getApiVersion

`Protected`getCount

`Protected`getOptions

`Protected`onSetServer

`Protected`parseResultList

`Protected`searchPropertyPath

`Protected`toDate

`Protected`toNumber

`Protected`useJson

`Protected`visitClause

`Protected`visitFilter