Interface: FetchListParameters

Oracle® JavaScript Extension Toolkit (JET)
9.2.0
F30740-01

Signature:

interface FetchListParameters<D>

QuickNav

Fields

FetchListParameters

Version:
  • 9.2.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.

Description

Defines the parameters to the DataProvider method DataProvider#fetchFirst

Fields

(nullable) attributes :Array.<(string|FetchAttribute)>

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
Examples
['!lastName', '@default'] // all attributes except lastName
['!lastName', '@default', {name: 'location', attributes: ['address line 1', 'address line 2']}] // nested example

(nullable) filterCriterion :DataFilter.Filter.<D>

Optional filter criterion to apply. The filter criterion would be composed of a supported DataFilter.Filter such as a AttributeFilter, AttributeExprFilter, CompoundFilter. TextFilter
Since:
  • 4.1.0
Example
let filterDef = {op: '$or', criteria: [{op: '$eq', value: {name: 'Bob'}}, {op: '$gt', value: {level: 'Low'}}]};
let filter = FilterFactory.getFilter(filterDef); // create a standard filter using the filterFactory.
let fetchListParam = {filterCriterion: filter, size: 5};

(nullable) size :number

Optional number of rows to fetch. If fewer than that number of rows exist, the fetch will succeed but be truncated. A value of -1 will return all rows or the maximum size supported by the DataProvider. If the size is not specified, then the DataProvider implementation will determine how many rows to return.
Since:
  • 4.1.0

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

Optional sort criteria to apply.
Since:
  • 4.1.0
Example
[{attribute: 'DepartmentName', direction: 'ascending'}]