Uses of Class
net.pricefx.server.dto.calculation.ContextParameter

Packages that use ContextParameter

Package	Description
net.pricefx.formulaengine.forms	The Forms 2.0 API for building dynamic forms from a Form logic.
net.pricefx.formulaengine.scripting	Root package of the public Groovy API available to Pricefx logics.
net.pricefx.formulaengine.scripting.inputbuilder	Builders for logic inputs (user entries and context parameters).
net.pricefx.server.dto.calculation	The objects a calculation logic returns to format, display or configure its results.

Uses of ContextParameter in net.pricefx.formulaengine.forms

Methods in net.pricefx.formulaengine.forms that return ContextParameter

Modifier and Type	Method	Description
ContextParameter	FormLayout.addChild(ContextParameter input)	Attaches a built input directly to this layout, without wrapping it in a row, container or modal.

Methods in net.pricefx.formulaengine.forms with parameters of type ContextParameter

Modifier and Type	Method	Description
FormContainer	FormContainer.addChild(ContextParameter child)	Attaches a built input directly to this container.
ContextParameter	FormLayout.addChild(ContextParameter input)	Attaches a built input directly to this layout, without wrapping it in a row, container or modal.
FormLayoutNode	FormLayoutNode.addChild(ContextParameter child)	Attaches a built input directly to this node, without wrapping it in a further row, container or modal.
FormModal	FormModal.addChild(ContextParameter child)	Attaches a built input directly to this modal.
FormRow	FormRow.addChild(ContextParameter child)	Attaches a built input directly to this row.
FormChange	FormActionApi.insertAfter(String inputName, ContextParameter... inputsToAdd)	Inserts one or more new input definitions after the specified existing input.

Method parameters in net.pricefx.formulaengine.forms with type arguments of type ContextParameter

Modifier and Type	Method	Description
FormChange	FormChange.setAddAfter(List<ContextParameter> inputs)

Uses of ContextParameter in net.pricefx.formulaengine.scripting

Methods in net.pricefx.formulaengine.scripting that return ContextParameter

Modifier and Type	Method	Description
ContextParameter	PublicGroovyAPI.getParameter(String parameterName)	Retrieves an already generated (in the previous logic code) input parameter in the form of a ContextParameter object.

Uses of ContextParameter in net.pricefx.formulaengine.scripting.inputbuilder

Fields in net.pricefx.formulaengine.scripting.inputbuilder declared as ContextParameter

Modifier and Type	Field	Description
protected ContextParameter	AbstractInputBuilder.cp

Methods in net.pricefx.formulaengine.scripting.inputbuilder that return ContextParameter

Modifier and Type	Method	Description
ContextParameter	AbstractInputBuilder.addToFormLayout(FormLayoutNode layout)	Builds the input field definition and adds it to the specified form layout.
ContextParameter	AbstractInputBuilder.buildContextParameter()	Builds and returns the input field definition object.
ContextParameter	AbstractInputBuilder.buildFormInput()	Builds the input field definition the same way as AbstractInputBuilder.getInput() and returns the resulting ContextParameter object.
static ContextParameter	DmFilter.createDmFilterContextParameter(String paramName)
static ContextParameter	VLookupBuilder.createVLookupContextParameter(PersistedObjectService objectService, Date targetDate, String name)
static ContextParameter	VLookupBuilder.createVLookupContextParameterWithSimulation(InputBuilderContext builderContext, PersistedObjectService objectService, String name)

Methods in net.pricefx.formulaengine.scripting.inputbuilder that return types with arguments of type ContextParameter

Modifier and Type	Method	Description
static List<ContextParameter>	TreeInputBuilder.Mapper.toContextParameters(Collection<?> collection)

Methods in net.pricefx.formulaengine.scripting.inputbuilder with parameters of type ContextParameter

Modifier and Type	Method	Description
CollapseInputBuilder<T>	CollapseInputBuilder.addInput(ContextParameter contextParameter)	Add parameter to the ContextParameters list.
RowInputBuilder<T>	RowInputBuilder.addInput(ContextParameter contextParameter)	Adds a new input for InputBuilder.

Uses of ContextParameter in net.pricefx.server.dto.calculation

Methods in net.pricefx.server.dto.calculation that return ContextParameter

Modifier and Type	Method	Description
ContextParameter	ContextParameter.applyType(InputType inputType)	Changes the input type of this input.
ContextParameter	ContextParameter.copyWithoutValue()	Not intended for public use.
ContextParameter	ConfiguratorEntry.createParameter(InputType type, String name)	Creates a parameter and adds it to the list of inputs.
ContextParameter	ConfiguratorEntry.createParameter(InputType type, String name, Date targetDate)	Creates a parameter and adds it to the list of inputs.
ContextParameter	ConfiguratorEntry.getFirstInput()	Gets the first context parameter.
ContextParameter	ConfiguratorEntry.getInputByName(String name)	Get ContextParameter by provided name
ContextParameter	ContextParameter.setAddUnknownValues(Boolean addUnknownValues)	Sets whether the user can add values that are not among the options of an OPTIONS input.
ContextParameter	ContextParameter.setAlwaysEditable(Boolean alwaysEditable)	Sets the input field as always editable.
ContextParameter	ContextParameter.setConfigParameter(String paramName, Object value)	Adds an additional configuration parameter/option to the input – a parameterConfig property.
ContextParameter	ContextParameter.setFilter(Map<String,Object> filter)	Sets the filter of this input, as a map.
ContextParameter	ContextParameter.setFilters(Filter... filters)	Sets the filter of this input from one or more Filter objects.
ContextParameter	ContextParameter.setFormattingOption(String optionName, Object value)	Sets (adds or updates) a formatting option (how the input field is displayed) within the formattingOptions map.
ContextParameter	ContextParameter.setLabel(String label)	Sets the label of the input parameter to the given text.
ContextParameter	ContextParameter.setLabelTranslations(String labelTranslations)	Sets the translations of the label as a JSON string.
ContextParameter	ContextParameter.setLabelTranslationsFromMap(Map<String,String> translations)	Sets the translations of the label.
ContextParameter	ContextParameter.setLogActivity(Boolean logActivity)	Sets whether the changes of this input are recorded in the activity log of the document.
ContextParameter	ContextParameter.setParameterConfig(Map<String,Object> parameterConfig)	Sets the behavior of the input field.
ContextParameter	ContextParameter.setParameterGroup(String parameterGroup)	Allows you to create collapsible sections that organize inputs in the UI.
ContextParameter	ContextParameter.setReadOnly(Boolean readOnly)	Sets the input field as read-only.
ContextParameter	ContextParameter.setRequired(Boolean required)	Sets, if it's mandatory for the input parameter to have a value.
ContextParameter	ContextParameter.setStoreAuditTrail(Boolean storeAuditTrail)	Sets whether the logged changes of this input are kept as an audit trail.
ContextParameter	ConfiguratorEntry.setTrackedValue(String name, Object value)	Sets the ContextParameter value, enriched by the groovy logic value tracking feature.
ContextParameter	ContextParameter.setTypedId(String typedId)	Sets the typed ID returned by getTypedId().
ContextParameter	ContextParameter.setURL(String url)	Sets the URL property of the input.
ContextParameter	ContextParameter.setUserGroupView(String userGroupView)	Sets the userGroupView property for the input.
ContextParameter	ContextParameter.setUserGroupView(List<String> userGroupsView)	Sets the userGroupView property for the input.
ContextParameter	ContextParameter.setValue(Object value)	Set initial/default value of the input parameter.
ContextParameter	ContextParameter.setValueHint(String hint)	Sets the value hint: a text that the UI shows with the value of the input.
ContextParameter	ContextParameter.setValueOptions(String[] valueOptions)	Sets list of options used in the dropdown input field.
ContextParameter	ContextParameter.setValueOptions(List<String> valueOptions)	Sets the options of the drop-down input field, as a list.

Methods in net.pricefx.server.dto.calculation that return types with arguments of type ContextParameter

Modifier and Type	Method	Description
List<ContextParameter>	ConfiguratorEntry.getInputs()	Gets the list of context parameters.
List<ContextParameter>	ContextParameter.getInputs()	Returns the nested inputs of a ROW or COLLAPSE input.

Methods in net.pricefx.server.dto.calculation with parameters of type ContextParameter

Modifier and Type	Method	Description
void	ContextParameter.addInput(ContextParameter contextParameter)	Adds a nested input.
ConfiguratorEntry	ConfiguratorEntry.addParameter(ContextParameter input)	Deprecated. Use ConfiguratorEntry.createParameter(ContextParameter) instead.
ConfiguratorEntry	ConfiguratorEntry.createParameter(ContextParameter input)	Creates a parameter and adds it to the list of inputs.
ConfiguratorEntry	ConfiguratorEntry.createParameter(ContextParameter input, Closure<?> defaultValue)	Creates a parameter and adds it to the list of inputs.
void	ContextParameter.setIfNotNull(ContextParameter original)	Not intended for public use.
void	ContextParameter.update(ContextParameter cp)	Not intended for public use.

Method parameters in net.pricefx.server.dto.calculation with type arguments of type ContextParameter

Modifier and Type	Method	Description
void	ConfiguratorEntry.setInputs(List<ContextParameter> inputs)	Sets the list of context parameters.