Final Class: DataSource

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

QuickNav

Methods


DataSource extends oj.EventSource

Version:
  • 8.0.0
Since:
  • 1.0
Module:
  • ojdatasource-common

Module usage

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

Javascript Import Format
define(['ojs/ojdatasource-common'], function(datasourceCommon) {
 // Application should call API on datasourceCommon.DataSource 
})

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

Object representing data used by table and grid components
Deprecated:
Since Description
5.0.0 Use DataProvider instead.

Constructor

(abstract) new DataSource(data)

Parameters:
Name Type Description
data Object data supported by the components
Deprecated:
Since Description
5.0.0 Use DataProvider instead.

Methods

getCapability(feature) : {string|null}

Determines whether this DataSource supports the specified feature.
Parameters:
Name Type Description
feature string the feature in which its capabilities is inquired.
Returns:
the capability of the specified feature. Returns null if the feature is not recognized.
Type
string | null

handleEvent(eventType, event) : {boolean}

Handle the event
Parameters:
Name Type Description
eventType string event type
event Object event
Inherited From:
Returns:
Returns false if event is cancelled
Type
boolean

Init() : {undefined}

Initializes the instance.
Returns:
Type
undefined

off(eventType, eventHandler) : {void}

Detach an event handler.

Application can call this if it no longer wants to be notified of an event that it has attached an handler to using the on method.

Parameters:
Name Type Description
eventType string eventType
eventHandler function(Object) event handler function
Inherited From:
Returns:
Type
void

on(eventType, eventHandler) : {void}

Attach an event handler.

Application can call this if it wants to be notified of an event. It can call the off method to detach the handler when it no longer wants to be notified.

Parameters:
Name Type Description
eventType string eventType
eventHandler function(Object) event handler function
Inherited From:
Returns:
Type
void