Class Filter

A query filter for DAOs.

param: the model type (OnmsAlarm, OnmsEvent, etc.)

Hierarchy

NestedRestriction
- Filter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Filter(...clauses: Clause[]): Filter

Inherited from NestedRestriction.constructor
- Defined in api/NestedRestriction.ts:11
Parameters
- Rest ...clauses: Clause[]
Returns Filter

Properties

clauses

clauses: Clause[] = [] as Clause[]

The clauses containing the nested restrictions and their logical operators.

limit

limit: number = 1000

how many results to get back by default

Methods

withAndRestriction

withAndRestriction(restriction: Restriction | NestedRestriction): this

Inherited from NestedRestriction.withAndRestriction
- Defined in api/NestedRestriction.ts:23
Adds an additional restriction using the logical AND operator.

Parameters
- restriction: Restriction | NestedRestriction
Returns this

withOrRestriction

withOrRestriction(restriction: Restriction | NestedRestriction): this

Inherited from NestedRestriction.withOrRestriction
- Defined in api/NestedRestriction.ts:18
Adds an additional restriction using the logical OR operator.

Parameters
- restriction: Restriction | NestedRestriction
Returns this

Generated using TypeDoc