Package net.pricefx.formulaengine.scripting.inputbuilder

Class DashboardInputsInputBuilder

Object

AbstractInputBuilder<DashboardInputsInputBuilder,Map<String,Object>>

DashboardInputsInputBuilder

public class DashboardInputsInputBuilder
extends AbstractInputBuilder<DashboardInputsInputBuilder,Map<String,Object>>

Builder class for input type DashboardInputs.

Since:

11.1 Paper Plane

Nested Class Summary

Nested classes/interfaces inherited from class AbstractInputBuilder

AbstractInputBuilder.InputWidth

Field Summary

Fields inherited from class AbstractInputBuilder

builderContext, cp

Constructor Summary

Constructors

Constructor	Description
DashboardInputsInputBuilder(InputBuilderContext builderContext, String paramName, String dashboardName, String... portletPath)

Method Summary

Modifier and Type	Method	Description
protected Object	_getInput()
DashboardInputsInputBuilder	setMaximumDepth(int embeddedLevels)	If the Dashboard features Embedded Dashboard portlets, the FE will find out about all inputs recursively.
DashboardInputsInputBuilder	setPortletPath(String... portletPath)	If the Dashboard features Embedded Dashboard portlets, the FE will find out about all inputs recursively.

Methods inherited from class AbstractInputBuilder

addOrUpdateInput, addToConfiguratorEntry, addToConfiguratorEntry, buildContextParameter, buildMap, getInput, self, setAccessCode, setAlign, setAllValueTypesTracking, setAlwaysEditable, setAppearance, setAutoComplete, setAutoFocus, setCaption, setConfigValues, setCustomAttributeName, setCustomAttributeValue, setDefaultValueTracking, setDefaultWidth, setDisabled, setDisplayMode, setErrorMessage, setExportable, setFirstRunTracking, setFlex, setHelpLink, setHelpText, setIcon, setIconPosition, setImportable, setLabel, setLabelPlacement, setLabelStyle, setLabelTranslations, setLayoutGridName, setNoRefresh, setParameterGroup, setPlaceholderText, setPreviousValueTracking, setReadOnly, setRequired, setShowInline, setSize, setSuccessMessage, setTheme, setTitle, setTrackedValue, setUserGroupEdit, setUserGroupEdit, setUserGroupView, setValue, setValueChangeTracking, setValueHint, setWarningMessage, setWidth

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DashboardInputsInputBuilder

public DashboardInputsInputBuilder(InputBuilderContext builderContext,
 String paramName,
 String dashboardName,
 String... portletPath)

Method Details

_getInput

protected Object _getInput()

Specified by:

_getInput in class AbstractInputBuilder<DashboardInputsInputBuilder,Map<String,Object>>

setPortletPath

public DashboardInputsInputBuilder setPortletPath(String... portletPath)

If the Dashboard features Embedded Dashboard portlets, the FE will find out about all inputs recursively. After executing the top level Dashboard to get its inputs, it will look for the portlet named portletPath[0] and if it's an Embedded Dashbaard, it will execute it to get its inputs. And the same process is repeated if a portlet named portletPath[1] exists and happens to be an Embedded Dashboard.

Setting this parameter will reset setMaximumDepth(int) to portletPath.length

Parameters:

portletPath - portlet name, or list of portlet names leading to the desired portlet for which all input should be extracted

Returns:

self

setMaximumDepth

public DashboardInputsInputBuilder setMaximumDepth(int embeddedLevels)

If the Dashboard features Embedded Dashboard portlets, the FE will find out about all inputs recursively. After executing the top level Dashboard to get its inputs (level 0) it will look for Embedded Dashbaards, and it will execute them to get their inputs (level 1). And the same process is repeated for any Embedded Dashboard, up to the embeddedLevels value is reached.

The absolute maximum is 4 if a PortletPath is defined, and only 2 no PortletPath is defined.

Parameters:

embeddedLevels - maximum recursion level if embedded Dashboards are found - defaults to 1

Returns:

self