Interface: IteratingDataProvider

Oracle® JavaScript Extension Toolkit (JET)
4.2.0

E91398-01

QuickNav

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

oj. IteratingDataProvider extends EventTarget

Version:
  • 4.2.0
Since:
  • 4.1.0
The interface for oj.IteratingDataProvider
Since:
  • 4.1.0
Deprecated:

Methods

fetchFirst(params) → {AsyncIterable.<oj.FetchListResult>}

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Fetch the first block of data.
Parameters:
Name Type Argument Description
params oj.FetchListParameters <optional>
fetch parameters
See:
Returns:
AsyncIterable with oj.FetchListResult
Type
AsyncIterable.<oj.FetchListResult>

getCapability(capabilityName) → {Object}

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Determines whether this DataProvider supports a certain feature.
Parameters:
Name Type Argument Description
capabilityName string <optional>
capability name. If unspecified, returns all supported capabilities. Supported capability names are: sort
Returns:
capability information or null if unsupported
Type
Object

getTotalSize() → {Promise.<number>}

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Return the total number of rows in this dataprovider
Returns:
Returns a Promise which resolves to the total number of rows. -1 is unknown row count.
Type
Promise.<number>