Interface: NestedFilter

Oracle® JavaScript Extension Toolkit (JET)
13.0.1

F52697-01

Since:
  • 13.0.0
Module:
  • ojdataprovider

QuickNav

Fields

Description

Defines a kind of DataFilter.Filter which applies to the nested filters.

This interface supports one or multiple levels of filter definition nested inside it. See NestedFilterDef for additional details and examples.


Usage

Signature:

interface NestedFilter<D> extends NestedFilterDef<D>, BaseDataFilter<D>

Generic Parameters
ParameterDescription
DType of Data
Typescript Import Format
//To use this interface, import as below.
import {NestedFilter} from "ojs/ojdataprovider";

For additional information visit:


Fields

attribute :AttributeFilterDef.AttributeExpression|string

Property which contains an expression specifies which attribute to filter on.
Since:
  • 13.0.0
Inherited From:

criterion :(AttributeFilterDef.<D>|AttributeExprFilterDef.<D>|ExtendedCompoundFilterDef.<D>|NestedFilterDef.<D>)

Types of FilterDefs which can be nested inside the NestedFilterDef applying on the attribute. The following types are supported:
  • AttributeFilterDef
  • AttributeExprFilterDef
  • ExtendedCompoundFilterDef
  • NestedFilterDef
  • TextFilterDef
Since:
  • 13.0.0
Inherited From:

op :NestedFilterDef.NestedOperator

Operator to apply for the filter. Valid operator defined in the NestedFilterOperator is the string:
  • $exists If the attribute exists, there is a potential match if criterion matches. If the attribute does not exist or is invalid, there is no match.
Since:
  • 13.0.0
Inherited From:

Methods

filter(item: D, index?: number, array?: Array<D>): boolean;

Specifies a filter function which has the same signature as the the callback which is specified for the JS Array.filter(): https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter This function will be optionally used by the DataProvider to do local filtering. This function is required by the DataProvider so that it is possible for DataProvider implementations to at least do local filtering.
Parameters:
Name Type Argument Description
item any The current element being processed in the array.
index number <optional>
The index of the current element being processed in the array.
array Array <optional>
The array filter was called upon.
Since:
  • 8.0.0
Inherited From:
Returns:
True if the element satisfies the filter.
Type
boolean