Class: FilterFactory

Oracle® JavaScript Extension Toolkit (JET)
18.0.0
G12199-01

Since:
  • 7.0.0
Module:
  • ojdataprovider

QuickNav

Methods

Description

Provides the ability to construct filters which can be used for FetchListParameters#filterCriterion. Note is it not a requirement to use this factory to construct filters based on the filter definition. Applications can construct their own filters which implement the interface DataFilter.Filter


Usage

Signature:

class FilterFactory<D>

Javascript Import Format
define(['ojs/ojdataprovider'], function(dataprovider) {
 // Application should call API on dataprovider.FilterFactory 
})
Typescript Import Format
//To import this class, use the format below.
import {FilterFactory} from "ojs/ojdataprovider";

For additional information visit:


Methods

(static) getFilter(options: {filterDef: DataFilter.FilterDef<any>, filterOptions?: any}): DataFilter.Filter<any>

This function is used to pass in a filter definition and returns a filter which can be used with DataProviders. It essentially takes the filter definition and then adds a local filter() function which is required when used for a DataProvider filterCriterion.
Parameters:
Name Type Description
options Object Options for the getFilter() function
Properties
Name Type Argument Description
filterDef DataFilter.FilterDef The filter definition for the filter to be returned.
filterOptions any <optional>
 Options for the filter such as textFilterAttributes which lists the attributes to filter on for TextFilter.
Since:
  • 7.0.0
Returns:

Returns either an AttributeFilter, AttributeExprFilter, ExtendedCompoundFilter, NestedFilter, or TextFilter depending on whether a AttributeFilterDef, ExtendedCompoundFilterDef, NestedFilterDef was passed in.

Type
DataFilter.Filter