Package net.pricefx.server.dto.calculation

Class ConfiguratorEntryArray

Object

AbstractPortletDto

ConfiguratorEntryArray

All Implemented Interfaces:

Serializable, Portlet, ComplexCalculationResult

public class ConfiguratorEntryArray
extends AbstractPortletDto
implements ComplexCalculationResult

Holds several Configurator sections returned from one logic element.

Create an instance with api.createConfiguratorEntryArray(entries) and return it from a logic element. Each entry is a ConfiguratorEntry, which is one section with its inputs. Use an array when one element must return several independent sections, for example in a library logic that builds parts of a form for several places.

Configurators are a legacy input mechanism. Since version 17.0, use Forms 2.0 for new implementations instead.

Example:

 def yearSection = api.createConfiguratorEntry()
 yearSection.setMessage("Filter by Year")
 api.inputBuilderFactory()
         .createIntegerUserEntry("year")
         .setLabel("Year")
         .addToConfiguratorEntry(yearSection)

 def countrySection = api.createConfiguratorEntry()
 countrySection.setMessage("Filter by Country")
 api.inputBuilderFactory()
         .createStringUserEntry("country")
         .setLabel("Country Code")
         .addToConfiguratorEntry(countrySection)

 return api.createConfiguratorEntryArray(yearSection, countrySection)
 

See Also:

• PublicGroovyAPI.createConfiguratorEntryArray(Object...)
• Interactive Forms - Configurators
• Forms 2.0
• Serialized Form

Field Summary

Fields inherited from class AbstractPortletDto

dragDropEnabled, layout, messages, resizingEnabled

Fields inherited from interface Portlet

UNIT_GRID, UNIT_PX

Constructor Summary

Constructors

Constructor	Description
ConfiguratorEntryArray()	Not intended for public use.

Method Summary

Modifier and Type	Method	Description
void	addEntry(ConfiguratorEntry e)	Adds a configurator entry to this array.
List<ConfiguratorEntry>	getEntries()	Returns the configurator entries of this array.
String	getResultType()	Returns the result type of the configurator entry array.
void	setEntries(List<ConfiguratorEntry> entries)	Replaces the configurator entries of this array.

Methods inherited from class AbstractPortletDto

getLabelOverride, layout, setLabelOverride, setLayout, value, withDragDrop, withError, withHeight, withHeight, withInfo, withLabelOverride, withLayout, withLayout, withLayout, withResizing, withTab, withWarning, withWidth, withWidth

Methods inherited from class Object

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

Constructor Details

ConfiguratorEntryArray

public ConfiguratorEntryArray()

Not intended for public use. Use api.createConfiguratorEntryArray() instead.

See Also:

• PublicGroovyAPI.createConfiguratorEntryArray(Object...)

Method Details

getEntries

public List<ConfiguratorEntry> getEntries()

Returns the configurator entries of this array.

Returns:

The configurator entries.

setEntries

public void setEntries(List<ConfiguratorEntry> entries)

Replaces the configurator entries of this array.

Parameters:

entries - The configurator entries.

addEntry

public void addEntry(ConfiguratorEntry e)

Adds a configurator entry to this array.

Parameters:

e - The configurator entry to add.

getResultType

public String getResultType()

Returns the result type of the configurator entry array.

Specified by:

getResultType in interface ComplexCalculationResult

Returns:

Always "CONFIGURATORENTRYARRAY".