Interface: FetchFirstCapability

Oracle® JavaScript Extension Toolkit (JET)
12.1.0

F52696-01

Since:
  • 10.0.0
Module:
  • ojdataprovider

QuickNav

Fields

Description

Defines the result to the DataProvider method DataProvider#getCapability for capability "fetchFirst"


Usage

Signature:

interface FetchFirstCapability

Typescript Import Format
//To use this interface, import as below.
import {FetchFirstCapability} from "ojs/ojdataprovider";

For additional information visit:


Fields

(nullable) attributeFilter :AttributeFilterCapability

Optional detailed attribute filter capability information
Since:
  • 10.0.0

(nullable) caching :('all'|'none'|'visitedByCurrentIterator')

Optional detailed caching capability information. Valid values are:
  • "all": indicates that all data are cached and access is fast. For example, if the data is available from an array or other local data structures.
  • "none": indicates that none of the data is cached and access can be slow. For example, if the data is available from a remote endpoint.
  • "visitedByCurrentIterator": indicates that data fetched by current iterator is cached. For example, if the data is available from a remote endpoint but may be cached locally for faster access.
Since:
  • 10.0.0

iterationSpeed :"immediate"|"delayed"

The speed of iteration. Possible values are:
  • "immediate": the iteration speed is immediate. Specifically, the iterator returned by fetchFirst is capable of returning a Promise that is resolved with results immediately.
  • "delayed": the iteration speed is delayed. Specifically, the iterator returned by fetchFirst might not be able to return results immediately.
Since:
  • 10.0.0

(nullable) totalFilteredRowCount :('exact'|'none')

Indicates whether total filtered row count can be returned. The total filtered row count is a count of all the rows that can be iterated after applying any filterCriterion. Possible values are:
  • "exact": The exact total filtered row count can be returned through the iterator results.
  • "none": Total filtered row count cannot be returned.
Since:
  • 12.0.0