Interface: FetchByOffsetParameters

Oracle® JavaScript Extension Toolkit (JET)
11.0.0

F37993-01

Since:
  • 4.1.0
Module:
  • ojdataprovider

QuickNav

Fields

Description

Defines the parameters to the DataProvider method DataProvider#fetchByOffset


Usage

Signature:

interface FetchByOffsetParameters<D> extends FetchListParameters<D>

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

For additional information visit:


Fields

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

attributes to include in the result. If specified, then at least these set of attributes will be included in each row results. If not specified then the default attributes will be included.
Since:
  • 6.1.0

(nullable) clientId :symbol

Optional symbol that can uniquely identify the consumer of the DataProvider. Each consumer can call Symbol() to obtain a unique symbol, which can be stored and reused on each subsequent call to fetchFirst. Note that Symbol() returns a different unique symbol every time, so it should not be called every time the consumer calls fetchFirst. There should only be one active iterator per clientId. All previous iterators obtained with the same clientId should be considered invalid. This is used to optimize resource usage in some DataProvider implementations.
Since:
  • 9.0.0
Inherited From:

(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
Inherited From:
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};

offset :number

The offset used for the fetch call.
Since:
  • 4.1.0

(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
Inherited From:

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

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