DataProvider::ActionOptionInfo hashdecl Reference

Data provider action option definition. More...

#include <DataProviderActionCatalog.qc.dox.h>

Public Attributes
*softlist< hash< AllowedValueInfo > >	allowed_values
	List of allowed values (enum)
auto	default_value
	Any default value for the option.
*list< string >	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.
string	display_name
	Display name of the option.
*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	preselected
	If the option should be preselected.
*string	ref_data
	A tag allowing allowed values to be returned dynamically as reference data.
bool	required
	Is the option required or not?
bool	sensitive
	Is the option value sensitive?
string	short_desc
	Short description of the option in plain text.
AbstractDataProviderType	type
	Data type of the option.

Detailed Description

Data provider action option definition.

Member Data Documentation

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