Loading...
Searching...
No Matches
DataProvider::ActionOptionInfo Struct Reference

Data provider action option definition. More...

`#include <DataProviderActionCatalog.qc.dox.h>`

## Public Attributes

*softlist< hash< AllowedValueInfo > > | allowed_values
| List of allowed values (enum)
bool | allowed_values_creatable
| Does the option accept values not defined in allowed_values too?
*string | default_ref_data
| A tag allowing the default value to be returned dynamically as reference data.
auto | default_value
| Any default value for the option.
*softlist< softstring > | depends_on
| A list of other options that must be set before this option can be chosen.
string | desc
| Description of the option with markdown rendering.
bool | disabled
| Is this option disabled?
string | display_name
| Display name of the option.
*string | dynamic_type
| A tag allowing the type of the option to be retrieved at runtime.
*softlist< hash< AllowedValueInfo > > | element_allowed_values
| List of allowed values for elements of list types (enum)
bool | element_allowed_values_creatable
| Does the option accept values not defined in element_allowed_values too?
*string | element_ref_data
| A tag allowing element allowed values to be returned dynamically as element reference data.
auto | example_value
| An optional example value for the option.
*string | loc
| Option location for record-based data providers and data providers provided by a class.
bool | multiselect
| Are allowed values elements of the list's element type that indicate what values the list can have?
*softlist< softstring > | on_change
| Any information about how to react to changes.
bool | preselected
| If the option should be preselected.
bool | readonly
| Is this option read-only?
*string | ref_data
| A tag allowing allowed values to be returned dynamically as reference data.
bool | required
| Is the option required or not?
*list< string > | required_groups
| Is the option part of a required group?
bool | sensitive
| Is the option value sensitive?
string | short_desc
| Short description of the option in plain text.
bool | structural_determinate
| Does the value of this option determine the structure of other options?
AbstractDataProviderType | type
| Data type of the option.

## Detailed Description

Data provider action option definition.

## Member Data Documentation

## default_ref_data

*string DataProvider::ActionOptionInfo::default_ref_data

A tag allowing the default value to be returned dynamically as reference data.

The value is the name of the reference data; if allowed_values are not present, calls will be made to AbstractDataProvider::getReferenceDataValue() in the available DataProvider when resolving application actions if this attribute is set

## depends_on

*softlist<softstring> DataProvider::ActionOptionInfo::depends_on

A list of other options that must be set before this option can be chosen.

Each element in the list is either

- a string: giving a single option that the element depends on
- a list of strings: giving a group of options, one of which must be set before this option can be chosen

## element_ref_data

*string DataProvider::ActionOptionInfo::element_ref_data

A tag allowing element allowed values to be returned dynamically as element reference data.

The value is the name of the element reference data; if allowed_values are not present, calls will be made to AbstractDataProvider::getElementReferenceData() in the available DataProvider when resolving application actions if this attribute is set

## loc

*string DataProvider::ActionOptionInfo::loc

Option location for record-based data providers and data providers provided by a class.

values:

- `where:` in the where clause
- `options:` in the options argument
- `set:` in the set argument for update statements
- `constructor:` option to be used in the class constructor

## ref_data

*string DataProvider::ActionOptionInfo::ref_data

A tag allowing allowed values to be returned dynamically as reference data.

The value is the name of the reference data; if allowed_values are not present, calls will be made to AbstractDataProvider::getReferenceData() in the available DataProvider when resolving application actions if this attribute is set

## required_groups

*list<string> DataProvider::ActionOptionInfo::required_groups

Is the option part of a required group?

A required group is a group of options of which at least one must be set