config Taglib documentation

Tag getOption config:getOption(...)

Gets an option value. The returned value is of type String.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the option value.
name	true	false	java.lang.String
Name of the option to retrieve.
defaultValue	false	true	java.lang.String
If the option value is not set, the given default value will be returned.
component	false	true	com.exalead.cv360.config.elements.CustomComponentParameterContainer
The component we want to retrieve the option from. Object is of type MashupPage, Row, Cell or Widget. By defaults the widget in the current context is used.
doEval	false	false	boolean
Specifies whether to eval or not the option. Defaults to the option configuration.
feed	false	true	com.exalead.access.feedapi.ResultFeed
For evaluated options, you can evaluate feeds expressions by specifying a ResultFeed.
feeds	false	true	com.exalead.access.feedapi.ResultFeed
For evaluated options, you can evaluate feeds expressions by specifying a Map(String, ResultFeed).
entry	false	true	com.exalead.access.feedapi.Entry
For evaluated options, you can evaluate entry expressions by specifying an Entry.
category	false	true	com.exalead.access.feedapi.AbstractCategory
For evaluated options, you can evaluate CATEGORY expressions by specifying a MergedCategory.
aggregation	false	true	java.lang.String
For evaluated options, you can specifies on which aggregation the given category is based. Defaults to 'count'.
facet	false	true	com.exalead.access.feedapi.MergedFacet
For evaluated options, you can evaluate FACET expressions by specifying a MergedFacet.
meta	false	true	com.exalead.access.feedapi.Meta
For evaluated options, you can evaluate META expressions by specifying a Meta.
isHighlighted	false	false	boolean
For evaluated options, you can enable/disable the highlighting.
isXmlEscaped	false	false	boolean
For evaluated options, you can enable/disable the XML escaping.
isJsEscaped	false	false	boolean
For evaluated options, you can enable/disable the JS escaping.
isHtmlEscaped	false	false	boolean
For evaluated options, you can enable/disable the HTML escaping.
isUrlEncoded	false	false	boolean
For evaluated options, you can enable/disable the URL encoding.

↑

Tag getOptions config:getOptions(...)

Gets an option values. The returned value is of type List(String).

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the option values.
name	true	false	java.lang.String
Name of the option to retrieve.
defaultValue	false	true	java.lang.String
If the option value is not set, the given default value will be returned.
component	false	true	com.exalead.cv360.config.elements.CustomComponentParameterContainer
The component we want to retrieve the option from. Object is of type MashupPage, Row, Cell or Widget. By defaults the widget in the current context is used.
doEval	false	false	boolean
Specifies whether to eval or not the option. Defaults to the option configuration.
feed	false	true	com.exalead.access.feedapi.ResultFeed
For evaluated options, you can evaluate feeds expressions by specifying a ResultFeed.
feeds	false	true	com.exalead.access.feedapi.ResultFeed
For evaluated options, you can evaluate feeds expressions by specifying a Map(String, ResultFeed).
entry	false	true	com.exalead.access.feedapi.Entry
For evaluated options, you can evaluate entry expressions by specifying an Entry.
category	false	true	com.exalead.access.feedapi.AbstractCategory
For evaluated options, you can evaluate CATEGORY expressions by specifying a MergedCategory.
aggregation	false	true	java.lang.String
For evaluated options, you can specifies on which aggregation the given category is based. Defaults to 'count'.
facet	false	true	com.exalead.access.feedapi.MergedFacet
For evaluated options, you can evaluate FACET expressions by specifying a MergedFacet.
meta	false	true	com.exalead.access.feedapi.Meta
For evaluated options, you can evaluate META expressions by specifying a Meta.
isHighlighted	false	false	boolean
For evaluated options, you can enable/disable the highlighting.
isXmlEscaped	false	false	boolean
For evaluated options, you can enable/disable the XML escaping.
isJsEscaped	false	false	boolean
For evaluated options, you can enable/disable the JS escaping.
isHtmlEscaped	false	false	boolean
For evaluated options, you can enable/disable the HTML escaping.
isUrlEncoded	false	false	boolean
For evaluated options, you can enable/disable the URL encoding.

↑

Tag getOptionComposite config:getOptionComposite(...)

Gets an option composite value. The returned value is of type String[] or Map(String, String).

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
separator	false	false	java.lang.String
The separator used for the composite option, by default it will retrieve the one from the configuration.
mapIndex	false	false	boolean
Specifies whether to map or not indexes with the option name.
var	false	false	java.lang.String
Name of the exported variable for the option value.
name	true	false	java.lang.String
Name of the option to retrieve.
defaultValue	false	true	java.lang.String
If the option value is not set, the given default value will be returned.
component	false	true	com.exalead.cv360.config.elements.CustomComponentParameterContainer
The component we want to retrieve the option from. Object is of type MashupPage, Row, Cell or Widget. By defaults the widget in the current context is used.
doEval	false	false	boolean
Specifies whether to eval or not the option. Defaults to the option configuration.
feed	false	true	com.exalead.access.feedapi.ResultFeed
For evaluated options, you can evaluate feeds expressions by specifying a ResultFeed.
feeds	false	true	com.exalead.access.feedapi.ResultFeed
For evaluated options, you can evaluate feeds expressions by specifying a Map(String, ResultFeed).
entry	false	true	com.exalead.access.feedapi.Entry
For evaluated options, you can evaluate entry expressions by specifying an Entry.
category	false	true	com.exalead.access.feedapi.AbstractCategory
For evaluated options, you can evaluate CATEGORY expressions by specifying a MergedCategory.
aggregation	false	true	java.lang.String
For evaluated options, you can specifies on which aggregation the given category is based. Defaults to 'count'.
facet	false	true	com.exalead.access.feedapi.MergedFacet
For evaluated options, you can evaluate FACET expressions by specifying a MergedFacet.
meta	false	true	com.exalead.access.feedapi.Meta
For evaluated options, you can evaluate META expressions by specifying a Meta.
isHighlighted	false	false	boolean
For evaluated options, you can enable/disable the highlighting.
isXmlEscaped	false	false	boolean
For evaluated options, you can enable/disable the XML escaping.
isJsEscaped	false	false	boolean
For evaluated options, you can enable/disable the JS escaping.
isHtmlEscaped	false	false	boolean
For evaluated options, you can enable/disable the HTML escaping.
isUrlEncoded	false	false	boolean
For evaluated options, you can enable/disable the URL encoding.

↑

Tag getOptionsComposite config:getOptionsComposite(...)

Gets an option composite values. The returned value is of type List(String[]) or List(Map(String, String)).

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
separator	false	false	java.lang.String
The separator used for the composite option, by default it will retrieve the one from the configuration.
mapIndex	false	false	boolean
Specifies whether to map or not indexes with the option name.
var	false	false	java.lang.String
Name of the exported variable for the option values.
name	true	false	java.lang.String
Name of the option to retrieve.
defaultValue	false	true	java.lang.String
If the option value is not set, the given default value will be returned.
component	false	true	com.exalead.cv360.config.elements.CustomComponentParameterContainer
The component we want to retrieve the option from. Object is of type MashupPage, Row, Cell or Widget. By defaults the widget in the current context is used.
doEval	false	false	boolean
Specifies whether to eval or not the option. Defaults to the option configuration.
feed	false	true	com.exalead.access.feedapi.ResultFeed
For evaluated options, you can evaluate feeds expressions by specifying a ResultFeed.
feeds	false	true	com.exalead.access.feedapi.ResultFeed
For evaluated options, you can evaluate feeds expressions by specifying a Map(String, ResultFeed).
entry	false	true	com.exalead.access.feedapi.Entry
For evaluated options, you can evaluate entry expressions by specifying an Entry.
category	false	true	com.exalead.access.feedapi.AbstractCategory
For evaluated options, you can evaluate CATEGORY expressions by specifying a MergedCategory.
aggregation	false	true	java.lang.String
For evaluated options, you can specifies on which aggregation the given category is based. Defaults to 'count'.
facet	false	true	com.exalead.access.feedapi.MergedFacet
For evaluated options, you can evaluate FACET expressions by specifying a MergedFacet.
meta	false	true	com.exalead.access.feedapi.Meta
For evaluated options, you can evaluate META expressions by specifying a Meta.
isHighlighted	false	false	boolean
For evaluated options, you can enable/disable the highlighting.
isXmlEscaped	false	false	boolean
For evaluated options, you can enable/disable the XML escaping.
isJsEscaped	false	false	boolean
For evaluated options, you can enable/disable the JS escaping.
isHtmlEscaped	false	false	boolean
For evaluated options, you can enable/disable the HTML escaping.
isUrlEncoded	false	false	boolean
For evaluated options, you can enable/disable the URL encoding.

↑

Tag setOption config:setOption(...)

Sets an option value.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
name	true	true	java.lang.String
Name of the option to configure.
value	true	true	java.lang.String
Value to set for the option.
component	true	true	com.exalead.cv360.config.elements.CustomComponentParameterContainer
The component we want to retrieve the option from. Object is of type MashupPage, Row, Cell or Widget. By defaults the widget in the current context is used.

↑

Tag evalTriggers config:evalTriggers(...)

Evaluate its body if the triggers contained in the given component or dataWidgetWrapper evaluates to 'true'.

Body Content: scriptless

Attribute name	Required	Runtime Expression Evaluation	Type
component	false	true	com.exalead.cv360.searchui.configuration.v10.TriggerContainer
The component that contains the triggers to evaluate. Object is of type MashupPage, Row or Cell.
dataWidgetWrapper	false	true	com.exalead.cv360.searchui.widgets.DataWidgetWrapper
The widget that contains the triggers to evaluate. Object is of type DataWidgetWrapper. Defaults to the current widget context.
feeds	false	true	java.util.Map
The ResultFeed to use for the triggers evaluation. Object is of type Map(String, ResultFeed).