lov - APEXlang Reference

`lov`

Parent: app

Children: columnlocation in (localDatabase); location in (restEnabledSql); location in (jsonDualityView); location in (jsonSource); location in (restSource); location in (sampleData), entrylocation = staticValues, parameterlocation = restSource and restSource is set and restSource supports HAS_SYNC_HAS_NO_ARRAY_COLUMNS and useLocalTable = false; location = restSource and restSource is set and restSource supports HAS_ARRAY_COLUMNS and restSource supports HAS_SYNC_ALL_ARRAY_COLUMNS and useLocalTable = false; location = restSource and restSource is set and restSource supports HAS_ARRAY_COLUMNS and nestedRows supports IS_SYNCED and useLocalTable = false

Direct Properties:

Property	Type	Required	Default Value	Details
`name`	`string`	Yes		data type=`string`; maxLen=255; textCase=`UPPER` Enter the name of this list of values.

Property Groups:

source

Property	Type	Required	Default Value	Details
`location`	`enum`	Yes	`localDatabase`	data type=`string`; lov=`STATIC` Valid values: `staticValues` `localDatabase` `restEnabledSql` `restSource` `jsonDualityView` `jsonSource` `sampleData`
`remoteServer`	`reference`	Yes		data type=`reference`; lov=`COMPONENT`; references=`restEnabledSqlDatabase` Applies when`location = restEnabledSql`
`sampleData`	`enum`	Yes		data type=`string`; lov=`STATIC` Valid values: `employees` `tasks` `products` `projects` Applies when`location = sampleData`
`type`	`enum`	Yes	`tableView`	data type=`string`; lov=`STATIC` Valid values: `tableView` `sqlQuery` `functionBody` `propertyGraph` `legacySqlQuery` Applies when`location in (localDatabase)location in (restEnabledSql)`
`tableOwner`	`string`	No		data type=`string`; maxLen=32767 Applies when`location in (localDatabase) and type = tableViewlocation in (restEnabledSql) and type = tableView`
`tableName`	`string`	Yes		data type=`string`; maxLen=128 Applies when`location in (localDatabase) and type = tableViewlocation in (restEnabledSql) and type = tableView`
`whereClause`	`multiline string`	No		data type=`multiline string`; maxLen=4000 Applies when`location in (localDatabase) and type = tableViewlocation in (restEnabledSql) and type = tableView`
`graphOwner`	`string`	No		data type=`string`; maxLen=32767 Applies when`location in (localDatabase) and type = propertyGraphlocation in (restEnabledSql) and type = propertyGraph`
`graphName`	`string`	Yes		data type=`string`; maxLen=32767 Applies when`location in (localDatabase) and type = propertyGraphlocation in (restEnabledSql) and type = propertyGraph`
`matchClause`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`location in (localDatabase) and type = propertyGraphlocation in (restEnabledSql) and type = propertyGraph`
`columnsClause`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`location in (localDatabase) and type = propertyGraphlocation in (restEnabledSql) and type = propertyGraph`
`whereClause`	`multiline string`	No		data type=`multiline string`; maxLen=4000 Applies when`location in (localDatabase) and type = propertyGraphlocation in (restEnabledSql) and type = propertyGraph`
`sqlQuery`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`location in (localDatabase) and type = sqlQuerylocation in (restEnabledSql) and type = sqlQuery`
`sqlQuery`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`location in (localDatabase) and type = legacySqlQuerylocation in (restEnabledSql) and type = legacySqlQuery`
`language`	`enum`	Yes	`plsql`	data type=`string`; lov=`STATIC` Valid values: `plsql` `javaScript-mle` Applies when`location in (localDatabase) and type = functionBodylocation in (restEnabledSql) and type = functionBody`
`plsqlFunctionBody`	`multiline string`	Yes		data type=`multiline string`; maxLen=32767 Applies when`location in (localDatabase) and type = functionBody and language = plsqllocation in (restEnabledSql) and type = functionBody and language = plsql`
`javaScriptFunctionBody`	`multiline string`	Yes		data type=`multiline string`; maxLen=32767 Applies when`location in (localDatabase) and type = functionBody and language = javaScript-mlelocation in (restEnabledSql) and type = functionBody and language = javaScript-mle`
`restSource`	`reference`	Yes		data type=`reference`; lov=`COMPONENT`; references=`restDataSource` Applies when`location = restSource`
`jsonDualityView`	`reference`	Yes		data type=`reference`; lov=`COMPONENT`; references=`jsonDualityView` Applies when`location = jsonDualityView`
`jsonSource`	`reference`	Yes		data type=`reference`; lov=`COMPONENT`; references=`jsonSource` Applies when`location = jsonSource`
`optimizerHint`	`string`	No		data type=`string`; maxLen=255 Applies when`location in (localDatabase)location in (restEnabledSql)location in (restSource)location in (jsonDualityView)location in (jsonSource)`

source {
  location: staticValues
  remoteServer: @component
  sampleData: employees
  type: tableView
  tableOwner: value
  tableName: value
  whereClause: ```sql
    value
  ```
  graphOwner: value
  graphName: value
  matchClause: ```
    value
  ```
  columnsClause: ```
    value
  ```
  sqlQuery: ```sql
    value
  ```
  language: plsql
  plsqlFunctionBody: ```plsql
    value
  ```
  javaScriptFunctionBody: ```javascript-mle
    value
  ```
  restSource: @component
  jsonDualityView: @component
  jsonSource: @component
  optimizerHint: value
}

dataProfile

Property	Type	Required	Details
`nestedRows`	`reference`	No	data type=`reference`; lov=`COMPONENT`; references=`dataProfileColumn` Applies when`location = restSource and restSource supports HAS_ARRAY_COLUMNS`
`nestedRows`	`reference`	No	data type=`reference`; lov=`COMPONENT`; references=`dataProfileColumn` Applies when`location = jsonDualityView and jsonDualityView supports HAS_ARRAY_COLUMNS`
`nestedRows`	`reference`	No	data type=`reference`; lov=`COMPONENT`; references=`dataProfileColumn` Applies when`location = jsonSource and jsonSource supports HAS_ARRAY_COLUMNS`

dataProfile {
  nestedRows: @component
}

restSynchronization

Property	Type	Required	Default Value	Details
`useLocalTable`	`boolean`	Yes	`false`	data type=`boolean` Applies when`location = restSource and restSource supports HAS_SYNC_HAS_NO_ARRAY_COLUMNSlocation = restSource and restSource supports HAS_ARRAY_COLUMNS and restSource supports HAS_SYNC_ALL_ARRAY_COLUMNSlocation = restSource and restSource supports HAS_ARRAY_COLUMNS and nestedRows supports IS_SYNCED`

restSynchronization {
  useLocalTable: false
}

externalFilterAndOrderBy

Property	Type	Required	Default Value	Details
`enabled`	`boolean`	Yes	`false`	data type=`boolean` Applies when`location = restSource and restSource is set and restSource supports HAS_SYNC_HAS_NO_ARRAY_COLUMNS and useLocalTable in (false)location = restSource and restSource is set and restSource supports HAS_SYNC_HAS_NO_ARRAY_COLUMNS and useLocalTable in ($NULL$)location = restSource and restSource is set and restSource supports HAS_ARRAY_COLUMNS and restSource supports HAS_SYNC_ALL_ARRAY_COLUMNS and useLocalTable in (false)location = restSource and restSource is set and restSource supports HAS_ARRAY_COLUMNS and restSource supports HAS_SYNC_ALL_ARRAY_COLUMNS and useLocalTable in ($NULL$)location = restSource and restSource is set and restSource supports HAS_ARRAY_COLUMNS and nestedRows supports IS_SYNCED and useLocalTable in (false)location = restSource and restSource is set and restSource supports HAS_ARRAY_COLUMNS and nestedRows supports IS_SYNCED and useLocalTable in ($NULL$)`
`filter`	`multiline string`	No		data type=`multiline string`; maxLen=4000 Applies when`location = restSource and restSource is set and restSource supports HAS_SYNC_HAS_NO_ARRAY_COLUMNS and useLocalTable in (false) and enabled = truelocation = restSource and restSource is set and restSource supports HAS_SYNC_HAS_NO_ARRAY_COLUMNS and useLocalTable in ($NULL$) and enabled = truelocation = restSource and restSource is set and restSource supports HAS_ARRAY_COLUMNS and restSource supports HAS_SYNC_ALL_ARRAY_COLUMNS and useLocalTable in (false) and enabled = truelocation = restSource and restSource is set and restSource supports HAS_ARRAY_COLUMNS and restSource supports HAS_SYNC_ALL_ARRAY_COLUMNS and useLocalTable in ($NULL$) and enabled = truelocation = restSource and restSource is set and restSource supports HAS_ARRAY_COLUMNS and nestedRows supports IS_SYNCED and useLocalTable in (false) and enabled = truelocation = restSource and restSource is set and restSource supports HAS_ARRAY_COLUMNS and nestedRows supports IS_SYNCED and useLocalTable in ($NULL$) and enabled = true`
`orderBy`	`multiline string`	No		data type=`multiline string`; maxLen=255 Applies when`location = restSource and restSource is set and restSource supports HAS_SYNC_HAS_NO_ARRAY_COLUMNS and useLocalTable in (false) and enabled = truelocation = restSource and restSource is set and restSource supports HAS_SYNC_HAS_NO_ARRAY_COLUMNS and useLocalTable in ($NULL$) and enabled = truelocation = restSource and restSource is set and restSource supports HAS_ARRAY_COLUMNS and restSource supports HAS_SYNC_ALL_ARRAY_COLUMNS and useLocalTable in (false) and enabled = truelocation = restSource and restSource is set and restSource supports HAS_ARRAY_COLUMNS and restSource supports HAS_SYNC_ALL_ARRAY_COLUMNS and useLocalTable in ($NULL$) and enabled = truelocation = restSource and restSource is set and restSource supports HAS_ARRAY_COLUMNS and nestedRows supports IS_SYNCED and useLocalTable in (false) and enabled = truelocation = restSource and restSource is set and restSource supports HAS_ARRAY_COLUMNS and nestedRows supports IS_SYNCED and useLocalTable in ($NULL$) and enabled = true`

externalFilterAndOrderBy {
  enabled: false
  filter: ```
    value
  ```
  orderBy: ```
    value
  ```
}

localPostProcessing

Property	Type	Required	Default Value	Details
`type`	`enum`	No		data type=`string`; lov=`STATIC` Valid values: `whereOrderByClause` `sqlQuery` `plsqlFunctionBody` Applies when`location = restSource and restSource is set`
`whereClause`	`multiline string`	No		data type=`multiline string`; maxLen=4000 Applies when`location = restSource and restSource is set and type = whereOrderByClause`
`sqlQuery`	`multiline string`	Yes		data type=`multiline string`; maxLen=32767 Applies when`location = restSource and restSource is set and type = sqlQuery`
`language`	`enum`	Yes	`plsql`	data type=`string`; lov=`STATIC` Valid values: `plsql` `javaScript-mle` Applies when`location = restSource and restSource is set and type = plsqlFunctionBody`
`plsqlFunctionBody`	`multiline string`	Yes		data type=`multiline string`; maxLen=32767 Applies when`location = restSource and restSource is set and type = plsqlFunctionBody and language = plsql`
`javaScriptFunctionBody`	`multiline string`	Yes		data type=`multiline string`; maxLen=32767 Applies when`location = restSource and restSource is set and type = plsqlFunctionBody and language = javaScript-mle`
`type`	`enum`	No		data type=`string`; lov=`STATIC` Valid values: `whereOrderByClause` `sqlQuery` `plsqlFunctionBody` Applies when`location = jsonDualityView and jsonDualityView is set`
`whereClause`	`multiline string`	No		data type=`multiline string`; maxLen=4000 Applies when`location = jsonDualityView and jsonDualityView is set and type = whereOrderByClause`
`sqlQuery`	`multiline string`	Yes		data type=`multiline string`; maxLen=32767 Applies when`location = jsonDualityView and jsonDualityView is set and type = sqlQuery`
`language`	`enum`	Yes	`plsql`	data type=`string`; lov=`STATIC` Valid values: `plsql` `javaScript-mle` Applies when`location = jsonDualityView and jsonDualityView is set and type = plsqlFunctionBody`
`plsqlFunctionBody`	`multiline string`	Yes		data type=`multiline string`; maxLen=32767 Applies when`location = jsonDualityView and jsonDualityView is set and type = plsqlFunctionBody and language = plsql`
`javaScriptFunctionBody`	`multiline string`	Yes		data type=`multiline string`; maxLen=32767 Applies when`location = jsonDualityView and jsonDualityView is set and type = plsqlFunctionBody and language = javaScript-mle`
`type`	`enum`	No		data type=`string`; lov=`STATIC` Valid values: `whereOrderByClause` `sqlQuery` `plsqlFunctionBody` Applies when`location = jsonSource and jsonSource is set`
`whereClause`	`multiline string`	No		data type=`multiline string`; maxLen=4000 Applies when`location = jsonSource and jsonSource is set and type = whereOrderByClause`
`sqlQuery`	`multiline string`	Yes		data type=`multiline string`; maxLen=32767 Applies when`location = jsonSource and jsonSource is set and type = sqlQuery`
`language`	`enum`	Yes	`plsql`	data type=`string`; lov=`STATIC` Valid values: `plsql` `javaScript-mle` Applies when`location = jsonSource and jsonSource is set and type = plsqlFunctionBody`
`plsqlFunctionBody`	`multiline string`	Yes		data type=`multiline string`; maxLen=32767 Applies when`location = jsonSource and jsonSource is set and type = plsqlFunctionBody and language = plsql`
`javaScriptFunctionBody`	`multiline string`	Yes		data type=`multiline string`; maxLen=32767 Applies when`location = jsonSource and jsonSource is set and type = plsqlFunctionBody and language = javaScript-mle`

localPostProcessing {
  type: whereOrderByClause
  whereClause: ```sql
    value
  ```
  sqlQuery: ```sql
    value
  ```
  language: plsql
  plsqlFunctionBody: ```plsql
    value
  ```
  javaScriptFunctionBody: ```javascript-mle
    value
  ```
}

remoteCache

Property	Type	Required	Default Value	Details
`caching`	`enum`	No		data type=`string`; lov=`STATIC` Valid values: `allUsers` `user` `session` Applies when`location = restEnabledSql`
`timeout`	`multiline string`	Yes		data type=`multiline string`; maxLen=255 Applies when`location = restEnabledSql and caching is set`

remoteCache {
  caching: allUsers
  timeout: ```
    value
  ```
}

columnMapping

Property	Type	Required	Default Value	Details
`return`	`string`	Yes		data type=`string`; maxLen=32767 Applies when`location in (localDatabase)location in (localDatabase) and location in (restEnabledSql)location in (restEnabledSql) and location in (localDatabase)location in (restEnabledSql)location in (sampleData) and location in (localDatabase)location in (sampleData) and location in (restEnabledSql)location in (jsonDualityView) and location in (localDatabase)location in (jsonDualityView) and location in (restEnabledSql)location in (jsonSource) and location in (localDatabase)location in (jsonSource) and location in (restEnabledSql)location in (restSource) and location in (localDatabase)location in (restSource) and location in (restEnabledSql)`
`display`	`string`	No		data type=`string`; maxLen=32767 Applies when`location in (localDatabase)location in (localDatabase) and location in (restEnabledSql)location in (restEnabledSql) and location in (localDatabase)location in (restEnabledSql)location in (sampleData) and location in (localDatabase)location in (sampleData) and location in (restEnabledSql)location in (jsonDualityView) and location in (localDatabase)location in (jsonDualityView) and location in (restEnabledSql)location in (jsonSource) and location in (localDatabase)location in (jsonSource) and location in (restEnabledSql)location in (restSource) and location in (localDatabase)location in (restSource) and location in (restEnabledSql)`
`defaultSort`	`string`	No		data type=`string`; maxLen=32767 Applies when`location in (localDatabase)location in (localDatabase) and location in (restEnabledSql)location in (restEnabledSql) and location in (localDatabase)location in (restEnabledSql)location in (sampleData) and location in (localDatabase)location in (sampleData) and location in (restEnabledSql)location in (jsonDualityView) and location in (localDatabase)location in (jsonDualityView) and location in (restEnabledSql)location in (jsonSource) and location in (localDatabase)location in (jsonSource) and location in (restEnabledSql)location in (restSource) and location in (localDatabase)location in (restSource) and location in (restEnabledSql)`
`sortDirection`	`enum`	Yes	`ascNullsLast`	data type=`string`; lov=`STATIC` Valid values: `ascNullsLast` `ascNullsFirst` `descNullsLast` `descNullsFirst` Applies when`location in (localDatabase) and defaultSort is setlocation in (localDatabase) and location in (restEnabledSql) and defaultSort is setlocation in (restEnabledSql) and location in (localDatabase) and defaultSort is setlocation in (restEnabledSql) and defaultSort is setlocation in (sampleData) and location in (localDatabase) and defaultSort is setlocation in (sampleData) and location in (restEnabledSql) and defaultSort is setlocation in (jsonDualityView) and location in (localDatabase) and defaultSort is setlocation in (jsonDualityView) and location in (restEnabledSql) and defaultSort is setlocation in (jsonSource) and location in (localDatabase) and defaultSort is setlocation in (jsonSource) and location in (restEnabledSql) and defaultSort is setlocation in (restSource) and location in (localDatabase) and defaultSort is setlocation in (restSource) and location in (restEnabledSql) and defaultSort is set`
`group`	`string`	No		data type=`string`; maxLen=32767 Applies when`location in (localDatabase) and defaultSort is setlocation in (localDatabase) and location in (restEnabledSql) and defaultSort is setlocation in (restEnabledSql) and location in (localDatabase) and defaultSort is setlocation in (restEnabledSql) and defaultSort is setlocation in (sampleData) and location in (localDatabase) and defaultSort is setlocation in (sampleData) and location in (restEnabledSql) and defaultSort is setlocation in (jsonDualityView) and location in (localDatabase) and defaultSort is setlocation in (jsonDualityView) and location in (restEnabledSql) and defaultSort is setlocation in (jsonSource) and location in (localDatabase) and defaultSort is setlocation in (jsonSource) and location in (restEnabledSql) and defaultSort is setlocation in (restSource) and location in (localDatabase) and defaultSort is setlocation in (restSource) and location in (restEnabledSql) and defaultSort is set`
`groupSortDirection`	`enum`	Yes	`ascNullsLast`	data type=`string`; lov=`STATIC` Valid values: `ascNullsLast` `ascNullsFirst` `descNullsLast` `descNullsFirst` Applies when`location in (localDatabase) and defaultSort is set and group is setlocation in (localDatabase) and location in (restEnabledSql) and defaultSort is set and group is setlocation in (restEnabledSql) and location in (localDatabase) and defaultSort is set and group is setlocation in (restEnabledSql) and defaultSort is set and group is setlocation in (sampleData) and location in (localDatabase) and defaultSort is set and group is setlocation in (sampleData) and location in (restEnabledSql) and defaultSort is set and group is setlocation in (jsonDualityView) and location in (localDatabase) and defaultSort is set and group is setlocation in (jsonDualityView) and location in (restEnabledSql) and defaultSort is set and group is setlocation in (jsonSource) and location in (localDatabase) and defaultSort is set and group is setlocation in (jsonSource) and location in (restEnabledSql) and defaultSort is set and group is setlocation in (restSource) and location in (localDatabase) and defaultSort is set and group is setlocation in (restSource) and location in (restEnabledSql) and defaultSort is set and group is set`
`icon`	`string`	No		data type=`string`; maxLen=32767 Applies when`location in (localDatabase)location in (localDatabase) and location in (restEnabledSql)location in (restEnabledSql) and location in (localDatabase)location in (restEnabledSql)location in (sampleData) and location in (localDatabase)location in (sampleData) and location in (restEnabledSql)location in (jsonDualityView) and location in (localDatabase)location in (jsonDualityView) and location in (restEnabledSql)location in (jsonSource) and location in (localDatabase)location in (jsonSource) and location in (restEnabledSql)location in (restSource) and location in (localDatabase)location in (restSource) and location in (restEnabledSql)`
`quickPickRank`	`string`	No		data type=`string`; maxLen=32767 Applies when`location in (localDatabase)location in (localDatabase) and location in (restEnabledSql)location in (restEnabledSql) and location in (localDatabase)location in (restEnabledSql)`
`oracleTextIndex`	`string`	No		data type=`string`; maxLen=32767 Applies when`location in (localDatabase)location in (localDatabase) and location in (restEnabledSql)location in (restEnabledSql) and location in (localDatabase)location in (restEnabledSql)`

columnMapping {
  return: value
  display: value
  defaultSort: value
  sortDirection: ascNullsLast
  group: value
  groupSortDirection: ascNullsLast
  icon: value
  quickPickRank: value
  oracleTextIndex: value
}

advanced

Property	Type	Required	Default Value	Details
`staticId`	`string`	Yes		data type=`string`; maxLen=255

advanced {
  staticId: value
}

subscription

Property	Type	Required	Default Value	Details
`master`	`reference`	No		data type=`reference`; lov=`COMPONENT`; references=`lov`

subscription {
  master: @component
}

comments

Property	Type	Required	Default Value	Details
`comments`	`multiline string`	No		data type=`multiline string`; maxLen=4000

comments {
  comments: ```
    value
  ```
}

APEXlang Example

lov sample (
    name: value
    source {
        location: staticValues
        remoteServer: @component
        sampleData: employees
        type: tableView
        tableOwner: value
        tableName: value
        whereClause: ```sql
          value
        ```
        graphOwner: value
        graphName: value
        matchClause: ```
          value
        ```
        columnsClause: ```
          value
        ```
        sqlQuery: ```sql
          value
        ```
        language: plsql
        plsqlFunctionBody: ```plsql
          value
        ```
        javaScriptFunctionBody: ```javascript-mle
          value
        ```
        restSource: @component
        jsonDualityView: @component
        jsonSource: @component
        optimizerHint: value
    }
    dataProfile {
        nestedRows: @component
    }
    restSynchronization {
        useLocalTable: false
    }
    externalFilterAndOrderBy {
        enabled: false
        filter: ```
          value
        ```
        orderBy: ```
          value
        ```
    }
    localPostProcessing {
        type: whereOrderByClause
        whereClause: ```sql
          value
        ```
        sqlQuery: ```sql
          value
        ```
        language: plsql
        plsqlFunctionBody: ```plsql
          value
        ```
        javaScriptFunctionBody: ```javascript-mle
          value
        ```
    }
    remoteCache {
        caching: allUsers
        timeout: ```
          value
        ```
    }
    columnMapping {
        return: value
        display: value
        defaultSort: value
        sortDirection: ascNullsLast
        group: value
        groupSortDirection: ascNullsLast
        icon: value
        quickPickRank: value
        oracleTextIndex: value
    }
    advanced {
        staticId: value
    }
    subscription {
        master: @component
    }
    comments {
        comments: ```
          value
        ```
    }
)