Interface: ExtendedCompoundFilter

Oracle® JavaScript Extension Toolkit (JET)
17.1.0
G12196-01

Since:
  • 13.0.0
Module:
  • ojdataprovider

QuickNav

Fields

Methods

Description

Defines a kind of DataFilter.Filter which applies to the extended compound filters. It supports a combination of multiple filter definitions with "$and" or "$or" operator. See ExtendedCompoundFilterDef for additional details and examples.

ExtendedCompoundFilter supports all filter patterns that CompoundFilter supports, Additionally, ExtendedCompoundFilter also supports NestedFilterDef and TextFilterDef filter definitions which CompoundFilter does not support. While CompoundFilter can be used for backward compatibility reasons, ExtendedCompoundFilterDef should be used in place of CompoundFilterDef going forward.


Usage

Signature:

interface ExtendedCompoundFilter<D> extends ExtendedCompoundFilterDef<D>, BaseDataFilter<D>

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

For additional information visit:


Fields

criteria :Array.<(AttributeFilterDef.<D>|AttributeExprFilterDef.<D>|ExtendedCompoundFilterDef.<D>|NestedFilterDef.<D>|TextFilterDef)>

Array of FilterDefs that can be combined together using the operator. Each FilterDef in the array can be one of the following types:
  • AttributeFilterDef
  • AttributeExprFilterDef
  • ExtendedCompoundFilterDef
  • NestedFilterDef
  • TextFilterDef
Since:
  • 13.0.0
Inherited From:

op :CompoundFilterDef.CompoundOperator

Operator to apply for the filter. Valid operators defined in the CompoundFilterOperator union type are the strings:
  • $and The filters in the criteria array will be AND'd.
  • $or The filters in the criteria array will be OR'd.
Since:
  • 7.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