Interface: FetchListParameters

Oracle® JavaScript Extension Toolkit (JET)
7.1.0

F18183-01

Signature:

interface FetchListParameters<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.

FetchListParameters

Version:
  • 7.1.0
Since:
  • 4.1.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 {FetchListParameters} 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.FetchListParameters

Fields

(nullable) attributes :Array<string | FetchAttribute>

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

Optional attributes to include in the result. If specified, then at least these set of attributes must be included in each row in the data array in the FetchListResult. If not specified then the default attributes must be included.
Since:
  • 6.1.0

(nullable) filterCriterion :AttributeFilter<D> | CompoundFilter<D> | FilterOperator<D>

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

Optional filter criterion to apply. The filter criterion would be composed of a supported Filter such as a AttributeFilter or a CompoundFilter.
Since:
  • 4.1.0

size :number

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

Optional number of rows to fetch starting from offset. If fewer than that number of rows exist, the fetch will succeed but be truncated.
Since:
  • 4.1.0

(nullable) sortCriteria :Array<SortCriterion<D>>

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

Optional sort criteria to apply.
Since:
  • 4.1.0