Package net.pricefx.formulaengine.scripting.inputbuilder

Class DmQueryBuilderInputBuilder

Object

AbstractInputBuilder<DmQueryBuilderInputBuilder,Map<String,Object>>

DmQueryBuilderInputBuilder

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

Builder class for input type DmQueryBuilder.

Since:

11.0 Paper Plane

Nested Class Summary

Nested classes/interfaces inherited from class AbstractInputBuilder

AbstractInputBuilder.InputWidth

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ALLOWED_SOURCES

Fields inherited from class AbstractInputBuilder

builderContext, cp

Method Summary

Modifier and Type	Method	Description
protected Object	_getInput()
DmQueryBuilderInputBuilder	withSeriesSourceTypes(String... sourcesTypes)	Set an explicit list of source types to be allowed as series source in the UI.

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, setLogActivity, setNoRefresh, setParameterGroup, setPlaceholderText, setPreviousValueTracking, setReadOnly, setRequired, setShowInline, setSize, setStoreAuditTrail, setSuccessMessage, setTab, setTheme, setTitle, setTrackedValue, setUserGroupEdit, setUserGroupEdit, setUserGroupView, setUserGroupView, setValue, setValueChangeTracking, setValueHint, setWarningMessage, setWidth

Methods inherited from class Object

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

Field Details

ALLOWED_SOURCES

protected static final String ALLOWED_SOURCES

See Also:

• Constant Field Values

Method Details

_getInput

protected Object _getInput()

Specified by:

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

withSeriesSourceTypes

public DmQueryBuilderInputBuilder withSeriesSourceTypes(String... sourcesTypes)

Set an explicit list of source types to be allowed as series source in the UI. Only the last call to this method is relevant, previous settings will be lost.

Valid values are:

• DM - Datamart
• DMM - DM Model (legacy Price Optimizer)
• DMDS - Data Source
• DMR - Rollup
• DMT - MO Table
• MO - Model Object

Sources available by default if this method is not used: DM, DMM, DMR, DMT, MO (i.e. no Data Sources)

Example:

     if(api.isInputGenerationExecution()) {
        return api.inputBuilderFactory()
          .createDmQueryBuilder('queryBuilder')
          .withSeriesSourceTypes('DM', 'DMDS')
          .getInput()
     }

     return input.queryBuilder
 

NOTE: sourcesTypes can also be provided as an ArrayList

Parameters:

sourcesTypes - list of typeCodes representing PA tables

Returns:

DmQueryBuilderInputBuilder with updated filters

Since:

16.0 Black Cat