Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NodeDAO

Data access for OnmsNode objects.

Hierarchy

Implements

Index

Constructors

constructor

Accessors

http

server

Methods

fetch

  • Given a node, fetch all the sub-model objects for that node. (ipInterfaces, snmpInterfaces, etc.)

    Parameters

    Returns Promise<OnmsNode>

find

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

    • Optional options: any

      Some additional options. May be implementer dependent, such as limit, or value restrictions

    Returns Promise<any>

    A promise containing the values.

get

  • get(id: number, recurse?: boolean): Promise<OnmsNode>
  • Get an node, given the node's ID.

    Parameters

    • id: number

      The node's ID.

    • Default value recurse: boolean = false

      Optionally fetch all sub-model objects. (ipInterface, etc.)

    Returns Promise<OnmsNode>

Protected getApiVersion

  • getApiVersion(): number

Protected getCount

  • getCount(data: any): number
  • A convenience method to make it easy for implementers to extract the count (or totalCount) values from response data.

    Parameters

    • data: any

    Returns number

getFilterProcessor

Private getNodeId

  • getNodeId(node: number | OnmsNode): number | undefined

Protected getOptions

getPropertiesCache

  • getPropertiesCache(): Promise<any>

ipInterfaces

Protected onSetServer

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[]

searchProperties

searchProperty

Protected searchPropertyPath

  • searchPropertyPath(): string

services

snmpInterfaces

Protected toDate

  • toDate(from: any): Moment | undefined
  • 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
  • Convert the given value to a number, or undefined if it cannot be converted.

    Parameters

    • from: any

    Returns number | undefined

Protected useJson

  • useJson(): boolean

Protected visitClause

Protected visitFilter

Generated using TypeDoc