Interface: AttributeFilterDef

Oracle® JavaScript Extension Toolkit (JET)
7.1.0

F18183-01

Signature:

interface AttributeFilterDef<D>

QuickNav

Fields


PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

AttributeFilterDef

Version:
  • 7.1.0
Since:
  • 7.0.0
Module:
  • ojdataprovider

Module usage

See JET Module Loading for an overview of module usage within JET.

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

JET In Typescript

A detailed description of working with JET elements and classes in your typescript project can be found at: JET Typescript Usage.

The interface for oj.AttributeFilterDef

Fields

attribute :string

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Optional property which specifies which attribute to filter on. This is provided for backward compatibility and has been deprecated. Please specify attribute/value pairs in the value property instead.
Deprecated:
Since Description
7.0.0 Use attribute pair values in the value property instead. e.g. value: {DepartmentId: 10}
Since:
  • 7.0.0

op :string

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Operator to apply for the filter. Valid operators defined in the AttributeFilterOperator union type are the strings:
  • $co The entire operator value must be a substring of the attribute value for a match.
  • $eq The attribute and operator values must be identical for a match.
  • $ew The entire operator value must be a substring of the attribute value matching at the end of the attribute value. This criterion is satisfied if the two strings are identical.
  • $pr If the attribute has a non-empty or non-null value, or if it contains a non-empty node for complex attributes, there is a match.
  • $gt If the attribute value is greater than the operator value, there is a match.
  • $ge If the attribute value is greater than or equal to the operator value, there is a match.
  • $lt If the attribute value is less than the operator value, there is a match.
  • $le If the attribute value is less than or equal to the operator value, there is a match.
  • $ne The attribute and operator values are not identical.
  • $regex If the attribute value satisfies the regular expression, there is a match.
  • $sw The entire operator value must be a substring of the attribute value, starting at the beginning of the attribute value. This criterion is satisfied if the two strings are identical.
Since:
  • 7.0.0

value :any

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Specifies the value to filter for. This can be a primitive or object. If a primitive is specified, then the attribute property must be used in conjunction. However, that type of usage is only provided for backwards compatibility and has been deprecated. Therefore, value should be an object which specifies attribute/value pairs to filter on. The op will be applied to each attribute/value pair and the whole will be AND'd. For subobjects, please specify them in a nested structure.
Since:
  • 7.0.0