Interface: FetchByKeysParameters

Oracle® JavaScript Extension Toolkit (JET)
15.1.0
F83698-01

Since:
  • 4.1.0
Module:
  • ojdataprovider

QuickNav

Fields

Description

Defines the parameters to the DataProvider methods DataProvider#fetchByKeys and DataProvider#containsKeys


Usage

Signature:

interface FetchByKeysParameters<K>

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

For additional information visit:


Fields

(static) Scope :string

Scope enum

Scope supported

Properties:
Name Type Default Description
global string global Global is the entire data set
local string local Local refers to the current fetched data.
Since:
  • 9.0.0

(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

keys :Set<K>

Keys for rows to fetch
Since:
  • 4.1.0

(nullable) scope :FetchByKeysParameters.Scope :('local'|'global')

Optional string describing local or global data set to fetch. Local refers to the current fetched data whereas global is the entire data set. The usage is primarily directed towards selection where a selection is on a different part of the data set than that of the local data set.
Since:
  • 7.0.0

(nullable) signal :AbortSignal

The AbortSignal from AbortController. A signal associated with fetchByKeys so that this request can be aborted later.
Since:
  • 14.0.0