Package net.pricefx.server.dto.calculation

package net.pricefx.server.dto.calculation

The objects a calculation logic returns to format, display or configure its results.

Most of these objects are what a logic element returns when its result needs more than a plain value. Such an object formats a value, holds a gauge or a chart, defines a controller portlet, or holds a Configurator section. A recommendation logic returns scored items. Two helper APIs work with Action Items and Custom Forms.

Entry point: each type comes from a call on api, such as api.attributedResult() or api.newGauge(). The example formats an output.

 def margin = out.MarginPct
 return api.attributedResult(margin)
         .withBackgroundColor(margin < 0.30 ? "red" : null)
         .withTextColor(margin < 0.30 ? "white" : null)
 

Configurators are a legacy input mechanism. Since version 17.0, new implementations use Forms 2.0. An existing Configurator logic builds a section with input builders:

 def entry = api.createConfiguratorEntry()
 api.inputBuilderFactory()
         .createOptionEntry("SalesOrg")
         .setOptions(["Europe", "USA"])
         .addToConfiguratorEntry(entry)
 return entry
 

Reference

• AttributedResult formats an output value, such as its colors and suffix.
• WrappedResult keeps a result as-is in the logic result, such as a list or an array.
• ResultGauge holds a gauge that shows a value in a range divided into colored sectors.
• ResultHighchart holds a Highcharts chart definition.
• ResultHighmap holds a Highmaps map definition.
• ResultFlexChart holds a FlexChart. New projects use ResultHighchart instead.
• DashboardController defines a controller portlet of HTML snippets and buttons.
• ContextParameter configures an input field, such as its label and default value.
• ConfiguratorEntry holds a section of a Configurator form: a set of inputs and an optional message.
• ConfiguratorEntryArray holds several Configurator sections returned from one logic element.
• ItemRecommendation is a scored item recommendation for cross-sell and up-sell.
• ActionItemApi creates, updates, recalculates and deletes Action Items.
• CustomFormApi works with Custom Forms.

See Also:

• Forms 2.0 (Knowledge Base)

Related Packages

Package	Description
net.pricefx.server.dto	Typed records that describe price list items, product references and tiered values.
net.pricefx.server.dto.calculation.dashboard	Embedding one dashboard in another, so that the embedded one reacts to events.
net.pricefx.server.dto.calculation.notification	Sending notifications to users and user groups.

Class	Description
ActionItemApi	Utility class to work with Action Items in Groovy code
ActionItemApi.ActionItemBuilder	Helper class to create Action Items. The class exposes several methods of the type setXX() for properties of the Action Item. The Action Item is then created in the database by invoking the create method.
AttributedResult	Provides means for output elements' formatting.
ConfiguratorEntry	Holds a section of a Configurator form: a set of inputs that share a purpose, and an optional message shown above them.
ConfiguratorEntryArray	Holds several Configurator sections returned from one logic element.
ContextParameter	This class represents the input parameter, the input field.
CustomFormApi	Utility class to work with Custom Forms in Groovy code
CustomFormApi.CustomFormBuilder	Helper class to create Custom Forms.
CustomFormApi.DocumentActionApi	Helper class to work with Custom Forms statuses.
CustomFormApi.OperationsApi	Helper class for all operations on Custom Forms. Example:
CustomFormApi.RecalculateApi	Helper class to recalculate Custom Forms.
CustomFormApi.UpdateApi	Helper class to update Custom Forms.
CustomFormApi.WorkflowActionApi	Helper class to work with Workflow statuses.
DashboardController	This class is used to generate the definition of a so-called controller dashboard portlet (or wizard).
ItemRecommendation	Represents a scored item recommendation calculated by logic.
ResultFlexChart	Holds a FlexChart returned from a logic element.
ResultGauge	The Gauge widget class implements a graphical speedometer-style gauge for displaying a measurement by means of a needle on a dial.
ResultHighchart	Holds a Highcharts chart definition returned from a logic element.
ResultHighchart.ContextMenu	The menu that opens when the user clicks a point in the chart.
ResultHighchart.ContextMenuItem	An item of the context menu.
ResultHighchart.OnPointClick	Defines what happens when the user clicks a point in the chart.
ResultHighchart.TriggerEvent	An event that the chart triggers when the user clicks a point.
ResultHighmap	Holds a Highmaps map definition returned from a logic element.
WrappedResult	Makes sure that a result appears "as-is" in the logic result.