DataProvider::DataProviderOptionInfo hashdecl Reference

Data provider option info. More...

#include <AbstractDataProvider.qc.dox.h>

Public Attributes
*softlist< hash< Util::AllowedValueInfo > >	allowed_values
	List of allowed values (enum)
auto	default_value
	Any default value.
string	desc
	The option description.
string	display_name
	Option display name.
auto	example_value
	Any optional example value for the option.
*bool	preselected
	Should this option be preselected?
*string	ref_data
	A tag allowing allowed values to be returned dynamically as reference data.
bool	required = False
	Required flag.
bool	sensitive = False
	Is the option value sensitive?
*string	short_desc
	Option short description in plain text.
softlist< AbstractDataProviderType >	type
	The option value type or types.

Detailed Description

Data provider option info.

Member Data Documentation

example_value

auto DataProvider::DataProviderOptionInfo::example_value

Any optional example value for the option.

This value must be in the one of the types in the type list

ref_data

*string DataProvider::DataProviderOptionInfo::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

bool DataProvider::DataProviderOptionInfo::required = False

Required flag.

Note

This attribute is ignored for cases when multiple combinations of options may be valid such as for data provider constructor options