Final Class: ListDataProviderView

Oracle® JavaScript Extension Toolkit (JET)
8.0.0
F18189-01

Signature:

final class ListDataProviderView<K, D, Kin, Din> implements DataProvider<K, D>

QuickNav

Fields

Methods


ListDataProviderView

Version:
  • 8.0.0
Since:
  • 4.1.0
Module:
  • ojlistdataproviderview

Module usage

See JET Module Loading for an overview of module usage within JET.

Javascript Import Format
define(['ojs/ojlistdataproviderview'], function(ListDataProviderView) {
 // Application should call API on ListDataProviderView 
})
Typescript Import Format
//This class is exported directly as module. To import it
import ListDataProviderView= require("ojs/ojlistdataproviderview");

Generic Parameters
ParameterDescription
KType of output key
DType of output data
KinType of input key
DinType of input data

JET In Typescript

A detailed description of working with JET elements and classes in your typescript project can be found at: JET Typescript Usage.

Final classes in JET

Classes in JET are generally final and do not support subclassing. At the moment, final is not enforced. However, this will likely change in an upcoming JET release.

Description

Provides list based optimizations for oj.DataProvider. Supports fetchFirst starting at arbitrary key or index offset, sortCriteria, and field mapping. Please see the select demos for examples of DataMapping Select

Constructor

new ListDataProviderView(dataProvider, options)

Parameters:
Name Type Argument Description
dataProvider DataProvider<K, D> the DataProvider.
options Object <optional>
 Options for the ListDataProviderView
Properties
Name Type Argument Description
from Kin <optional>
 key to start fetching from. This will be applied first before offset is applied.
offset number <optional>
 offset to start fetching from.
sortCriteria Array<SortCriterion<D>> <optional>
 oj.sortCriteria to apply to the data.
dataMapping DataMapping<K, D, Kin, Din> <optional>
 mapping to apply to the data.
attributes Array<string | FetchAttribute> <optional>
 fetch attributes to apply
filterCriterion DataFilter.Filter<D> <optional>
 filter criterion to apply. If the DataProvider does not support filtering then ListDataProviderView will do local filtering of the data.

Fields

attributes

Optional fetch attributes to apply
Since:
  • 4.1.0

dataMapping

Optional dataMapping to apply
Since:
  • 4.1.0

filterCriterion

Optional filter criterion to apply
Since:
  • 7.0.0

from :Kin

Optional key to start fetching from.
Since:
  • 4.1.0

offset :number

Optional offset to start fetching from. Should be greater than or equal to zero. If a negative offset is used then it will be treated as zero.
Since:
  • 4.1.0

sortCriteria

Optional sortCriteria to apply
Since:
  • 4.1.0

Methods

addEventListener(eventType: string, listener: EventListener): void

containsKeys(params: FetchByKeysParameters<K>): Promise<ContainsKeysResults<K>>

Check if there are rows containing the specified keys
Parameters:
Name Type Description
params oj.FetchByKeysParameters Fetch by keys parameters
Since:
  • 4.1.0
Returns:
Promise which resolves to oj.ContainsKeysResults
Type
Promise.<oj.ContainsKeysResults>

dispatchEvent(evt: Event): boolean

fetchByKeys(params: FetchByKeysParameters<K>): Promise<FetchByKeysResults<K, D>>

Fetch rows by keys
Parameters:
Name Type Description
params oj.FetchByKeysParameters Fetch by keys parameters
Since:
  • 4.1.0
Returns:
Promise which resolves to oj.FetchByKeysResults
Type
Promise.<oj.FetchByKeysResults>

fetchByOffset(params: FetchByOffsetParameters<D>): Promise<FetchByOffsetResults<K, D>>

Fetch rows by offset
Parameters:
Name Type Description
params oj.FetchByOffsetParameters Fetch by offset parameters
Since:
  • 4.2.0
Returns:
Promise which resolves to oj.FetchByOffsetResults
Type
Promise.<oj.FetchByOffsetResults>

fetchFirst(params?: FetchListParameters<D>): AsyncIterable<FetchListResult<K, D>>

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

getCapability(capabilityName: string): any

Determines whether this DataProvider supports certain feature.
Parameters:
Name Type Description
capabilityName string capability name. Supported capability names are determined by the underlying dataprovider.
Since:
  • 4.1.0
Returns:
capability information or null if unsupported
Type
Object

getTotalSize() : {Promise.<number>}

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>

isEmpty() : {"yes"|"no"|"unknown"}

Return a string that indicates if this data provider is empty
Returns:
a string that indicates if this data provider is empty. Valid values are: "yes": this data provider is empty. "no": this data provider is not empty. "unknown": it is not known if this data provider is empty until a fetch is made.
Type
"yes" | "no" | "unknown"

removeEventListener(eventType: string, listener: EventListener): void