Interface: FetchAttribute

Oracle® JavaScript Extension Toolkit (JET)
9.0.0

F24343-01

Signature:

interface FetchAttribute

QuickNav

Fields

FetchAttribute

Version:
  • 9.0.0
Since:
  • 6.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 {FetchAttribute} from "ojs/ojdataprovider";

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 stucture of attribute objects in FetchListParameters#attributes

Fields

(nullable) attributes :Array.<(string|FetchAttribute)>

Optional attributes property which specifies at least which attributes of the value we want to include. If not specified then the default attributes are included. If the value is a primitive then this is ignored. Expressions like "!" and "@default" are also supported. @default indicates the default attributes the implementation chooses to include in the result, by default. e.g. ['!lastName', '@default'] for everything except 'lastName'. For only 'firstName' and 'lastName' we'd have ['firstName', 'lastName']. Order does not matter when @default is used with field exclusions "!". This can be nested. e.g. ['!lastName', '@default', {name: 'location', attributes: ['address line 1', 'address line 2']}]. When specified attributes, exclusions and @default are all present as in [‘id’, ‘firstName’, ‘!lastName’, ‘@default’, ‘email’], this means that all default attributes (including 'id', 'firstName', and 'email') except for 'lastName' will be included. Also, a string value for attribute is equivalent to an object value with only name. e.g. ['lastName', 'firstName'] is the same as [{name: 'lastName'}, {name: 'firstName'}]
Since:
  • 6.1.0

name :string

The name of the attribute or sub object or related object.
Since:
  • 6.1.0