Qorus Integration Engine®  5.0.12_git
Public Member Methods | Public Attributes | List of all members
com.qoretechnologies.qorus.ConfigItem Class Reference

Public Member Methods

 ConfigItem (String description)
 
ConfigItem withType (String type)
 
ConfigItem withDefaultValue (Object default_value)
 
ConfigItem withStrictlyLocal (boolean strictly_local)
 
ConfigItem withStrictlyLocal ()
 
ConfigItem withConfigGroup (String config_group)
 
ConfigItem withAllowedValues (Object allowed_values)
 
ConfigItem withSensitive (boolean sensitive)
 
ConfigItem withSensitive ()
 
ConfigItem withPrefix (String prefix)
 set the prefix More...
 

Public Attributes

String type = "string"
 
String description
 
Object default_value
 
boolean strictly_local = false
 
boolean sensitive = false
 
String config_group = "Default"
 
Object allowed_values
 
String prefix
 

Detailed Description

Hash of config item info

Constructor & Destructor Documentation

◆ ConfigItem()

com.qoretechnologies.qorus.ConfigItem.ConfigItem ( String  description)
inline

Create the object with the given name and description

Member Function Documentation

◆ withAllowedValues()

ConfigItem com.qoretechnologies.qorus.ConfigItem.withAllowedValues ( Object  allowed_values)
inline

Set the allowed values

◆ withConfigGroup()

ConfigItem com.qoretechnologies.qorus.ConfigItem.withConfigGroup ( String  config_group)
inline

Set the config group

Since
Qorus 4.0.3

◆ withDefaultValue()

ConfigItem com.qoretechnologies.qorus.ConfigItem.withDefaultValue ( Object  default_value)
inline

Set the default value

◆ withPrefix()

ConfigItem com.qoretechnologies.qorus.ConfigItem.withPrefix ( String  prefix)
inline

set the prefix

Since
Qorus 4.1

◆ withSensitive() [1/2]

ConfigItem com.qoretechnologies.qorus.ConfigItem.withSensitive ( )
inline

Set the sensitive flag

Since
Qorus 4.1

◆ withSensitive() [2/2]

ConfigItem com.qoretechnologies.qorus.ConfigItem.withSensitive ( boolean  sensitive)
inline

Set the sensitive flag

Since
Qorus 4.1

◆ withStrictlyLocal() [1/2]

ConfigItem com.qoretechnologies.qorus.ConfigItem.withStrictlyLocal ( )
inline

Set the strictly local flag

Since
Qorus 4.1

◆ withStrictlyLocal() [2/2]

ConfigItem com.qoretechnologies.qorus.ConfigItem.withStrictlyLocal ( boolean  strictly_local)
inline

Set the strictly local flag

Since
Qorus 4.0.3

◆ withType()

ConfigItem com.qoretechnologies.qorus.ConfigItem.withType ( String  type)
inline

Set the type

Member Data Documentation

◆ allowed_values

Object com.qoretechnologies.qorus.ConfigItem.allowed_values

The list of allowed value for the configuration item

◆ config_group

String com.qoretechnologies.qorus.ConfigItem.config_group = "Default"

The group of the configuration item

◆ default_value

Object com.qoretechnologies.qorus.ConfigItem.default_value

The default value of the configuration item

◆ description

String com.qoretechnologies.qorus.ConfigItem.description

The description of the configuration item

◆ prefix

String com.qoretechnologies.qorus.ConfigItem.prefix

The prefix of the configuration item

Since
Qorus 4.1

◆ sensitive

boolean com.qoretechnologies.qorus.ConfigItem.sensitive = false

Treat the value as sensitive (mask in the UI)?

Since
Qorus 4.1

◆ strictly_local

boolean com.qoretechnologies.qorus.ConfigItem.strictly_local = false

Allow the item to be overridden at the next level?

Since
Qorus 4.0.3

◆ type

String com.qoretechnologies.qorus.ConfigItem.type = "string"

The type of the configuration item

The documentation for this class was generated from the following file: