Interface: FetchByKeysParameters

Oracle® JavaScript Extension Toolkit (JET)
9.0.0

F24343-01

Signature:

interface FetchByKeysParameters<K>

QuickNav

Fields

FetchByKeysParameters

Version:
  • 9.0.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 {FetchByKeysParameters} from "ojs/ojdataprovider";
Generic Parameters
ParameterDescription
KType of Key

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 methods DataProvider#fetchByKeys and DataProvider#containsKeys

Fields

(static) Scope :string

Scope enum

Scope supported

Properties:
Name Type Default Description
local string local Local refers to the current fetched data.
global string global Global is the entire data set
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