All Classes and Interfaces
Class
Description
Common base class for every chart definition builder returned by
ChartBuilder, such as
ScatterChart, TimeSeriesChart, and BarLineChart.Common base class for the click-event configuration builders returned by
AbstractChartBuilder.onRowClick() and AbstractChartBuilder.onCellClick(), and by each
concrete chart type's own onClick() method, for example ScatterChart.onClick().Common base class for the "additional measure" builders returned by a concrete series type's own
addAdditionalMeasure() method, for example ScatterChart.ScatterAdditionalMeasure or
BarLineChart.BarLineAdditionalMeasure.Common base class for the Options object returned by every chart type's
AbstractChartBuilder.getOptions(),
for example ScatterChart.ScatterOptions or BarLineChart.BarLineOptions.Common base class for the series builders returned by every chart type's
addSeries() or
getSeries() method, for example ScatterChart.ScatterSeries or
BarLineChart.BarLineSeries.Utility class to work with Action Items in Groovy code
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
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.This class implements a histogram that adapts to an unknown data distribution.
Auxiliary interface for inline functor object.
The aggregation formula applied to a chart series' measure or additional measure, set with
AbstractChartMeasures.withAggregation(AggregationFormula) or an
equivalent withAggregation method on a concrete series or axis type.The constants defined in this interface are typically used as the
targetPage parameter when defining
links to jump from a dashboard to other parts of the UI.Provides means for output elements' formatting.
Builder for an auxiliary reference line on a chart, obtained from
AbstractChartBuilder.addAuxLine() rather than instantiated directly.A straight
AuxLine shape, y = yIntercept + steepness * x, obtained from
AuxLine.withLine() rather than instantiated directly.A piecewise
AuxLine shape defined by explicit (X, Y) points, obtained from
AuxLine.withSteppedLine() rather than instantiated directly.A single vertical
AuxLine shape at a fixed X axis value, obtained from
AuxLine.withVerticalLine() rather than instantiated directly.A named color for an auxiliary reference line or trend line overlay, set with
AuxLine.setColor(AuxLineColor) or
TrendLine.setColor(AuxLineColor).Identifies which shape an
AuxLine overlay renders as.Builder for a Bar & Line Chart, obtained via
ChartBuilder.newBarLine() rather than
instantiated directly.A further measure on a
BarLineChart.BarLineSeries beyond its primary Y axis measure, obtained from
BarLineChart.BarLineSeries.addAdditionalMeasure() rather than instantiated directly.The Options for a
BarLineChart, obtained from BarLineChart.getOptions() rather than
instantiated directly.A single series of a
BarLineChart, obtained from BarLineChart.addSeries() rather than
instantiated directly.Builder for a Box Plot Chart, obtained via
ChartBuilder.newBoxplot() rather than instantiated
directly.A further measure on a
BoxplotChart.BoxplotSeries beyond its primary Y axis Box Plot expression, obtained from
BoxplotChart.BoxplotSeries.addAdditionalMeasure() rather than instantiated directly.The Options for a
BoxplotChart, obtained from BoxplotChart.getOptions() rather than
instantiated directly.A single series of a
BoxplotChart, obtained from BoxplotChart.addSeries() rather than
instantiated directly.Builder for a Bubble Chart, obtained via
ChartBuilder.newBubble() rather than instantiated
directly.A further measure on a
BubbleChart.BubbleSeries beyond its X axis, Y axis, and bubble size measures, obtained
from BubbleChart.BubbleSeries.addAdditionalMeasure() rather than instantiated directly.The Options for a
BubbleChart, obtained from BubbleChart.getOptions() rather than
instantiated directly.A single series of a
BubbleChart, obtained from BubbleChart.addSeries() rather than
instantiated directly.The bubble size measure of a
BubbleChart.BubbleSeries, obtained from
BubbleChart.BubbleSeries.setBubbleSize(String) rather than instantiated directly.Builder class for input type Button
InputType.BUTTONThis is the shared builder interface for Quotes, RebateAgreements, Contracts and Sales Compensation.
Some important notes on the sequence in which changes to the document structure are processed:
Any modifying action (adding lines, inputs, or a structure object, and so on) IS NOT executed as per sequence of the Groovy logic!
Some important notes on the sequence in which changes to the document structure are processed:
Any modifying action (adding lines, inputs, or a structure object, and so on) IS NOT executed as per sequence of the Groovy logic!
CalculationFlowActionBuilder is the starting point of an interface that
allows you define actions within calculation flow logic.The calculation flow
action builder is available in calculation flow by this call:
Note that you will find full code snippets in the
def builder = actionBuilderNote that you will find full code snippets in the
"Command Templates/Calculation Flow Examples" inside calculation
flow formulas UI.Enumeration of existing CalculationResultTypes.
This action starts calculation of selected CFS.
This class is a DTO that holds information about jobs that should be executed next.
Namespace holding the concrete click-event builders for chart Dashboard events:
ChartEvents.OnChartClick (a
chart-type-specific onClick(), for example ScatterChart.onClick()),
ChartEvents.OnRowClick (from AbstractChartBuilder.onRowClick()), and ChartEvents.OnCellClick (from
AbstractChartBuilder.onCellClick()).The click-event builder for a cell click on a chart's Data tab, obtained from
AbstractChartBuilder.onCellClick() rather than instantiated directly.Base class for a chart-type-specific
onClick() click-event builder, for example
ScatterChart.ScatterOnChartClick or BarLineChart.BarLineOnChartClick.The click-event builder for a row click on a chart's Data tab, obtained from
AbstractChartBuilder.onRowClick() rather than instantiated directly.Namespace holding the three intermediate tiers that select which of
AbstractChartMeasures' optional
methods a concrete additional-measure type re-exposes as public: ChartMeasures.Basic (aggregation formula
selection), ChartMeasures.Type (adds per-measure rendering type and Z axis placement, extends Basic), and
ChartMeasures.EmbeddedBoxplot (adds embedded boxplot overlay support, extends Type).Re-exposes
AbstractChartMeasures.withAggregation(String),
AbstractChartMeasures.withAggregation(net.pricefx.common.api.chart.AggregationFormula),
AbstractChartMeasures.withFormula(), AbstractChartMeasures.withPercent(),
AbstractChartMeasures.withPerUnit(), AbstractChartMeasures.withAverage(), and
AbstractChartMeasures.withTotal() as public; the tier extended by a concrete
additional-measure type that supports none of ChartMeasures.Type's or ChartMeasures.EmbeddedBoxplot's further
options, for example ScatterChart.ScatterAdditionalMeasure or
PieChart.PieAdditionalMeasure.Re-exposes
AbstractChartMeasures.withBoxplotField() and
AbstractChartMeasures.withBoxplotExpression() as public, on top of everything
ChartMeasures.Type exposes; the tier extended by a concrete additional-measure type whose series supports an
embedded box plot overlay, for example BarLineChart.BarLineAdditionalMeasure or
TimeSeriesChart.TimeSeriesAdditionalMeasure.Re-exposes
AbstractChartMeasures.setType(net.pricefx.common.api.chart.SeriesType) and
AbstractChartMeasures.setOnZAxis(Boolean) as public, on top of everything ChartMeasures.Basic
exposes; the tier extended by a concrete additional-measure type that can render itself differently
from its series' primary measure or plot itself on a Z axis, for example
HistogramChart.HistogramAdditionalMeasure or
DetailedTimeSeriesChart.DetailedTimeSeriesAdditionalMeasure.Namespace holding the five intermediate tiers that select which of
AbstractChartOptions' optional
methods a concrete chart type's Options class re-exposes as public: ChartOptions.Basic (title, subtitle,
legend, tooltips), ChartOptions.XYLabels (adds X/Y axis labels, extends Basic), ChartOptions.XYMinMax (adds
X/Y numeric bounds, extends XYLabels), ChartOptions.ZAxis (adds Y bounds, a Z axis, and period
comparison, extends XYLabels independently of XYMinMax), and ChartOptions.EmbeddedBoxplot (adds
embedded boxplot axis bounds, extends ZAxis).Re-exposes
AbstractChartOptions.setTitle(String), AbstractChartOptions.setSubtitle(String),
AbstractChartOptions.setHideLegend(Boolean), and AbstractChartOptions.setHideTooltips(Boolean)
as public; the tier extended by a concrete Options type that supports none of this class's more
specific tiers, for example WaterfallChart.WaterfallOptions or
WaterfallComparisonChart.WaterfallComparisonOptions.Re-exposes
AbstractChartOptions.setBoxplotAxisLabel(String),
AbstractChartOptions.setBoxplotAxisMin(BigDecimal), and
AbstractChartOptions.setBoxplotAxisMax(BigDecimal) as public, on top of everything
ChartOptions.ZAxis exposes; the tier extended by a concrete Options type whose series supports an embedded
box plot overlay, for example BarLineChart.BarLineOptions or
TimeSeriesChart.TimeSeriesOptions.Re-exposes
AbstractChartOptions.setXLabel(String) and AbstractChartOptions.setYLabel(String)
as public, on top of everything ChartOptions.Basic exposes; the tier extended by a concrete Options
type that labels its X and Y axes but supports neither ChartOptions.XYMinMax's nor ChartOptions.ZAxis's further
bounds, for example HeatmapChart.HeatmapOptions or PieChart.PieOptions.Re-exposes
AbstractChartOptions.setXMin(BigDecimal), AbstractChartOptions.setXMax(BigDecimal),
AbstractChartOptions.setYMin(BigDecimal), and AbstractChartOptions.setYMax(BigDecimal) as
public, on top of everything ChartOptions.XYLabels exposes; the tier extended by a concrete Options
type whose X and Y axes are both plain numeric scales worth bounding, for example
ScatterChart.ScatterOptions or BubbleChart.BubbleOptions.Re-exposes
AbstractChartOptions.setYMin(BigDecimal), AbstractChartOptions.setYMax(BigDecimal),
AbstractChartOptions.setShowZAxis(Boolean), AbstractChartOptions.setZLabel(String),
AbstractChartOptions.setZMin(BigDecimal), AbstractChartOptions.setZMax(BigDecimal), and
AbstractChartOptions.setComparison(Boolean) as public, on top of everything
ChartOptions.XYLabels exposes; the tier extended by a concrete Options type with a Z axis or period
comparison but no X axis bounds, for example BoxplotChart.BoxplotOptions or
HistogramChart.HistogramOptions.Namespace holding the three intermediate tiers that select which of
AbstractChartSeries' optional
methods a concrete series type re-exposes as public: ChartSeries.Basic (the methods common to nearly
every series), ChartSeries.EmbeddedBoxplot (adds an embedded boxplot overlay, extends Basic), and
ChartSeries.Aggregation (adds aggregation-by/band-by grouping, also extends Basic).Re-exposes
AbstractChartSeries.setAggregationBy(String), AbstractChartSeries.setBandBy(String),
and AbstractChartSeries.setShowBandByLegend(Boolean) as public, and adds
ChartSeries.Aggregation.getBandByOptions(); the tier extended by a concrete series type that supports aggregation-by and
band-by grouping, for example ScatterChart.ScatterSeries or BubbleChart.BubbleSeries.Re-exposes
AbstractChartSeries.setHideDataLabels(Boolean) as public; the tier extended by
a concrete series type that supports hiding data labels but none of ChartSeries.EmbeddedBoxplot's or
ChartSeries.Aggregation's further options.Re-exposes
AbstractChartSeries.setType(SeriesType), AbstractChartSeries.setShowBoxplot(Boolean),
AbstractChartSeries.setBoxplotAxis(), and AbstractChartSeries.setWhisker(WhiskerType) as
public; the tier extended by a concrete series type that supports an embedded box plot overlay,
for example BarLineChart.BarLineSeries or TimeSeriesChart.TimeSeriesSeries.Identifies which kind of chart a
ChartBuilderResult represents.ClaimContext is used for configuration of
Configure Channel Management.
Deprecated.
This is needed because of binary backward compatibility, but it's also referenceable from Groovy!
Deprecated.
This is needed because of binary backward compatibility, but it's also referenceable from Groovy!
Deprecated.
This is needed because of binary backward compatibility, but it's also referenceable from Groovy!
Selects how a
HeatmapChart's color axis maps values to color, set
with
HeatmapChart.HeatmapOptions.setColorAxisType(ColorAxisType).Chooses how a chart renders a period comparison enabled with
ChartOptions.ZAxis.setComparison(Boolean), set with
BarLineChart.BarLineOptions.setComparisonType(ComparisonType) or
DetailedTimeSeriesChart.DetailedTimeSeriesOptions.setComparisonType(ComparisonType).Context for manipulating a Sales Compensation object in a compensation header calculation logic.
A helper interface that assists in manipulating the compensation object.
This is a helper object that is used to build up code generated content of a Compensation.
This class is used to transport a configurator entry.
This class is used to transport an array of configurator entries
Builder class for input type Configurator or InlineConfigurator
(
InputType.CONFIGURATOR or InputType.INLINECONFIGURATOR)This class represents the input parameter, the input field.
Please read notes in
CalculableLineItemCollectionBuilder on how to use this builder.A helper interface that assists in manipulating the contract object.
This is a helper object that is used to build up code-generated content of a Contract.
CustomerGroup
Builder class for input type Customer
InputType.CUSTOMERUtility class to work with Custom Forms in Groovy code
Helper class to create Custom Forms.
Helper class to work with Custom Forms statuses.
Helper class for all operations on Custom Forms.
Example:
Example:
Helper class to recalculate Custom Forms.
Helper class to update Custom Forms.
Helper class to work with Workflow statuses.
CustomFormCollectionBuilder is the starting point of an interface that allows you to manipulate
a custom form object in a custom form header calculation logic.
The header calculation is executed twice: Once as 'pre phase' and once after that as 'post phase'.
Use
The header calculation is executed twice: Once as 'pre phase' and once after that as 'post phase'.
Use
isPrePhase() and isPostPhase() methods to detect the current phase.DashboardApi interface is used for configuration of
Embedded Dashboards.This class is used to generate the definition of a so-called controller dashboard portlet (or wizard).
Builder class for input type
DashboardInputs.Builder class for input type
DashboardPopup.This action starts calculation of selected data load.
Provides an API to query and load PA data from a formula context.
Helper class mainly for working with dates and time periods as used in the PriceAnalyzer module.
API for loading data into a
DMDataFeed or DMTable from a formula context.A reusable definition of a filtered subset ("slice") of a PA DataSet (Datamart, DataSource...): a combination
of
CustomerGroup, ProductGroup, and CalendarUtil.TimePeriod inclusions and exclusions, plus arbitrary
other Filters added with DatamartContext.DataSlice.addFilter(Filter).API for building a PA query in a formula context.
Deprecated.
Use
PublicGroovyAPI.queryApi() to query PA data insteadProvides access to a QueryResult in a formula context.
Represents the data of a PA field collection (Data Feed, Data Source, Datamart, etc.) and provides methods to work with it.
Builder for a Data Table, obtained via
ChartBuilder.newDataTable() rather than instantiated
directly.A measure column on a
DataTableChart.DataTableSeries, obtained from DataTableChart.DataTableSeries.addAdditionalMeasure()
rather than instantiated directly.The Options for a
DataTableChart, obtained from DataTableChart.getOptions() rather than
instantiated directly.A single series of a
DataTableChart, obtained from DataTableChart.addSeries() rather
than instantiated directly.The underlying storage/serialization primitive type of a value, lower-level than a Datamart
FieldType,
whose FieldType.toDataType() maps each field type down to one of these constants.Builder class for input type DateRangeUserEntry
InputType.DATERANGEUSERENTRY.Builder for a Detailed Time Series Chart, obtained via
ChartBuilder.newDetailedTimeSeries()
rather than instantiated directly.A measure column on a
DetailedTimeSeriesChart.DetailedTimeSeriesSeries, obtained from
DetailedTimeSeriesChart.DetailedTimeSeriesSeries.addAdditionalMeasure() rather than instantiated directly.The Options for a
DetailedTimeSeriesChart, obtained from
DetailedTimeSeriesChart.getOptions() rather than instantiated directly.A single series of a
DetailedTimeSeriesChart, obtained from
DetailedTimeSeriesChart.addSeries() rather than instantiated directly.Builder for a chart's Dictionary, the Data Analyzer panel that controls formatting of dates, numbers, and
other display labels (see the Dictionary option in the Data Analyzer UI), obtained from
AbstractChartBuilder.getDictionary() rather than instantiated directly.DistCalcFormulaContext is a groovy api exposed through the 'dist' binding when running a
DistributedCalculation DL (PA DataLoad job).
DistFormulaContext is a groovy api exposed through the 'dist' binding when evaluating the logic
for a DistributedCalculation DL through invocation of the datamart.formulaparams and datamart.distcalcexec
endpoints.
Builder class for input type DMFilter
InputType.DMDIMFILTER.Builder class for input type DMFilterBuilder
InputType.DMFILTERBUILDER.Builder class for input type DMFilterBuilder
InputType.DMFILTERBUILDERMULTIPLE.Builder class for input type
DmQueryBuilder.All possible event type constants.
This action starts exporting or archiving.
Builder for computing a chart measure or axis from a Datamart Expression instead of a plain field, obtained
from
AbstractChartMeasures.withExpression(), AbstractChartMeasures.withBoxplotExpression(),
AggrFieldAxis.withExpression(), or NonAggrFieldAxis.withExpression() rather than instantiated
directly.An Expression used to specify either output values or logic criteria of a
PipelineStage.Collection of
Expression building methodsEnumeration of existing FieldFormatTypes.
The business/logical data type of a Datamart field, set with
DMField.setType(FieldType).
A
Filter is used by the Search class to specify a
restriction on what results should be returned in the search.Builder class for input type FilterBuilder
InputType.FILTERBUILDER.A comparison, string-matching, null-check, set-membership, or logical-combination operator for a chart
series filter condition, used with
Filters.addFilter(String, net.pricefx.common.api.chart.FilterOperator),
Filters.addFilter(String, net.pricefx.common.api.chart.FilterOperator, Object),
or, for the logical-combination constants (FilterOperator.AND, FilterOperator.OR, FilterOperator.NOT),
Filters.addFilters(net.pricefx.common.api.chart.FilterOperator).Builder for a group of data filters on a chart series, obtained from
AbstractChartSeries.getFilters(),
AbstractChartSeries.addFilters(), AbstractChartSeries.addFilters(FilterOperator),
AbstractChartSeries.addProductsFilter(), AbstractChartSeries.addCustomersFilter(),
AbstractChartSeries.addAggregationsFilter(), or from Filters.addFilters(FilterOperator) on an outer
Filters group, rather than instantiated directly.Represents a set of property changes to apply to a form input.
A container layout node used to group form inputs with an optional heading and collapsible behaviour.
Defines input builder methods shared across form phases.
The root builder for a form's visual layout, obtained via
form.layout() in the Init phase (see FormInitApi.layout()).A modal layout node used to display form inputs in a popup dialog with an optional heading.
A row layout node used to arrange inputs horizontally within a form.
Builder for attaching an Analytics Calculation Logic (created under Administration > Logics >
Calculation Logic > Analytics) to a series, obtained from
AbstractChartSeries.setFormula() rather
than instantiated directly.The
FormValueOptionsApi is exposed to form logics through the form binding
during the valueOptions phase.List of grouping builder to be used in
PipelineStage.aggregateByGroups(Function, Function)Represents a list of groupings to be used in
PipelineStage.aggregateByGroups(Function, Function)Builder for a Heatmap, obtained via
ChartBuilder.newHeatmap() rather than instantiated
directly.A further measure on a
HeatmapChart.HeatmapSeries beyond its color axis measure, obtained from
HeatmapChart.HeatmapSeries.addAdditionalMeasure() rather than instantiated directly.Builder for a
HeatmapChart's continuous color gradient (ColorAxisType.INTERPOLATED),
obtained from HeatmapChart.HeatmapOptions.withInterpolatedColorAxis() rather than instantiated directly.The Options for a
HeatmapChart, obtained from HeatmapChart.getOptions() rather than
instantiated directly.Builder for a
HeatmapChart's discrete, banded color axis (ColorAxisType.RANGED),
obtained from HeatmapChart.HeatmapOptions.withRangedColorAxis() rather than instantiated directly.The single series of a
HeatmapChart, obtained from HeatmapChart.getSeries() rather than
instantiated directly.Builder for a Histogram, obtained via
ChartBuilder.newHistogram() rather than instantiated
directly.A measure column on a
HistogramChart.HistogramSeries, obtained from
HistogramChart.HistogramSeries.addAdditionalMeasure() rather than instantiated directly.The Options for a
HistogramChart, obtained from HistogramChart.getOptions() rather than
instantiated directly.The single series of a
HistogramChart, obtained from HistogramChart.getSeries() rather
than instantiated directly.Input Builder Factory class as a convenient way to create inputs (user entries, context parameters).
Builder class for input type InputMatrix
InputType.INPUTMATRIXEnumeration of existing InputTypes.
IRebateRecordGroupManager is the interface that allows you to manipulate
a RebateRecordGroup (RRG type code) in a calculation logic.
The RebateRecordManager API is exposed to Groovy logic elements in the following contexts:
In a RebateAgreement/Compensation calculation (type codes 'RBA' / 'CO'), when the logic context's '
currentItem' is an individual line item (type codes 'RBALI' / 'COLI').
In a RebateAgreement/Compensation 'read-only' evaluation (when opening an uneditable Rebate Agreement or Compensation); currentItem is 'RBALI'.
In a RebateRecordSet/CompensationRecordSet calculation, the formula context's 'currentItem' is an individual RebateRecord (type codes 'RR / COR').
The API can be accessed via the rebateRecords Groovy binding variable.Marker interface for parallel sub steps in
ReviewStepDefinition in a creation workflow.Marker interface for sequential sub steps in
ReviewStepDefinition in a creation workflow.Represents a scored item recommendation calculated by logic.
Chooses which end of a series' ranked rows a Top-N/Bottom-N limit keeps, set with a concrete series type's
setLimitTo(LimitPosition, java.math.BigDecimal, LimitType) method, for example
PieChart.PieSeries.setLimitTo(LimitPosition, java.math.BigDecimal, LimitType).Builder for a series' Top-N/Bottom-N row limit, obtained from
AbstractChartSeries.setLimitTo(net.pricefx.common.api.chart.LimitPosition, java.math.BigDecimal, net.pricefx.common.api.chart.LimitType)
rather than instantiated directly.Chooses what kind of Top-N/Bottom-N limit a series applies, set with a concrete series type's
setLimitTo(net.pricefx.common.api.chart.LimitPosition, java.math.BigDecimal, LimitType) method.A helper interface that assists in navigating and reading a Calculable Line Item Collection (CLIC) document's
line items: a Quote, Contract, Rebate Agreement, Sales Compensation, or Custom Form.
Represents a line item, a folder, or the document root of a CLIC document (a Quote, Contract, Rebate
Agreement, Sales Compensation, or Custom Form), obtained from
LineItemHelper.getRoot(),
LineItemHelper.findByLineId(String), LineItemHelper.findAllWithLabel(String), or
LineItemHelper.LineItem.getChildren()/LineItemHelper.LineItem.getParent()/LineItemHelper.LineItem.getSiblings()/LineItemHelper.LineItem.getSubLineItems() rather
than instantiated directly.Review sub-step information.
A closeable iterator over
LineItemHelper.LineItem elements, backed either by a streaming DB
cursor or by an already materialized list.This action starts calculation of selected LPG for all skus or restricted set
of skus.
This action starts calculation of selected manual pricelist.
Provides access to a QueryResult in a formula context, in the form of a two-dimension matrix.
The ModelCalcFormulaContext is exposed to model logics through the
model binding, when calculating a model.If nothing is specified, all the steps of the model will be calculated.
The
ModelCalculationFormulaContext is exposed to model calculation logics through the model binding.The
ModelEvaluationFormulaContext is exposed to model evaluation logics through the model binding.A ModelEvaluator exposes a previously prepared/trained/calculated model to non-PO modules (Groovy logics).
Deprecated.
Represents a tree that can be fetched in various manners.
Represents an in-memory tree that can be walked up and down.
Represents an in-memory tree.
The ModelFormulaContext is exposed to model logics through the
model binding.Representation of a node in a model tree (see for ex.
Represents a
LookupTable owned by a ModelObjectRepresents a
LookupTable owned by a ModelObject with mutable operationsThe
ModelParallelCalculationFormulaInitContext is exposed to model parallel calculation logics through the model binding.The
ModelParallelCalculationFormulaItemContext is exposed to model parallel calculation logics through the model binding.The
ModelParallelCalculationFormulaSummaryContext is exposed to model parallel calculation logics through the model binding.The
ModelPMMLContext is exposed to model evaluations and calculations via model binding.An evaluable PMML model.
The representation of a Model Schedule accessible from a read-only context.
A builder object helping to add or update a model schedule.
Builder class for input type MultiTierEntry
InputType.MULTITIERENTRY.Builder for a series' non-aggregated axis or embedded box plot field, obtained from
AbstractChartSeries.protectedSetNonAggrFieldAxisX(String),
AbstractChartSeries.protectedSetNonAggrFieldAxisY(String), or
AbstractChartSeries.setBoxplotAxis() rather than instantiated directly.The
NotificationApi interface is used for configuring Notifications.This action renews the object references of a partition.
Builder class for input type Option and Options
(
InputType.OPTION and InputType.OPTIONS).Collection of methods used to specify Orders for
PipelineStage.sortBy(Function) stage.API that can be accessed via the 'payoutRecords' binding (available in the RebateRecord calculation context — i.e., when calculating a RebateRecord in a RebateRecordCalculation task), or via the 'accrualRecords' binding (available in the CompensationRecord calculation context).
Builder class for input type ProductGroup, CustomerGroup and SellerGroup
Builder for a Pie Chart, obtained via
ChartBuilder.newPie() rather than instantiated directly.A measure column on a
PieChart.PieSeries, obtained from PieChart.PieSeries.addAdditionalMeasure() rather
than instantiated directly.The Options for a
PieChart, obtained from PieChart.getOptions() rather than instantiated
directly.A single series of a
PieChart, obtained from PieChart.addSeries() rather than
instantiated directly.Builder for the aggregated measure that determines a
PieChart.PieSeries' slice sizes, obtained from
PieChart.PieSeries.setSize(String) rather than instantiated directly.The atomic building bock of QueryApi queries.
The result type to be consumed by the function given to
PipelineStage.stream(Function).A representation of a result row accessible as an immutable map view.
Common interface for the portlet behavior.
ABORT is used as default
This action starts calculation of selected pricelist.
ProductGroup
Builder class for input type Product
InputType.PRODUCT.A DTO that describes a product reference
This interface represents what can be reached in the Groovy element syntax as
api.Type returned by the stream(...) methods.
QueryAPI
QuoteBuilder is the starting point of an interface that allows you to manipulate
a quote object in a quote header calculation logic.
The header calculation is executed twice: Once before the calculation of the individual line items (= pre phase) and once after that (= post phase).
Usually code should only apply in one phase.
The header calculation is executed twice: Once before the calculation of the individual line items (= pre phase) and once after that (= post phase).
Usually code should only apply in one phase.
A helper interface that assists in manipulating the quote object.
Extends
QuoteHelper with operations that are only available when the persisted quote
calculation processor is enabled on the QuoteType, i.e. when the line items live in the database
rather than in the serialized quote.This is a helper object that is used to build up the code-generated content of a quote.
Builder class for input type RangeSlider
InputType.RANGESLIDER.Builder for a Rebate Agreement Template (RAT).
Builder for a Rebate Agreement created from a Rebate Agreement Template (RAT).
Context for manipulating a Rebate Agreement object in a rebate agreement header calculation logic.
A helper interface that assists in manipulating the rebate agreement object.
This is a helper object that is used to build up code-generated content of a Rebate Agreement.
This action starts calculation of selected rebate record set records.
Holds a FlexChart returned from a logic element.
The Gauge widget class implements a graphical speedometer-style gauge for displaying a measurement by means of a needle
on a dial.
Holds a Highcharts chart definition returned from a logic element.
The menu that opens when the user clicks a point in the chart.
An item of the context menu.
Defines what happens when the user clicks a point in the chart.
An event that the chart triggers when the user clicks a point.
Holds a Highmaps map definition returned from a logic element.
This class is used to transport a calculated matrix-style result.
Object representing a button that handles multi-row actions.
Create a link/button that should do some desired action to pricefx backend (unity only)
[url:"pricelistmanager.revoke..../...", payload: [... : ...], successMessage: "hey, it is ok!"
List of other cells (to be shown as dropdown inline)
Create a link/button that should do initiate download from pricefx backend (unity only)
[url:"pricelistmanager.fetchpdf..../...", payload: [... : ...]]
Implemented by helpers of document types that support a review workflow (e.g. quotes, contracts).
A step in the Creation Workflow where line items are sent for review.
Marker interface for parallel sub steps in
ReviewStepDefinition in a creation workflow.Marker interface for sub steps in
ReviewStepDefinition in a creation workflow which are processed in sequence one by one.A sub step in the Creation Workflow where a line item is sent for review by a particular user group.
Builder for a Scatter Chart, obtained via
ChartBuilder.newScatter() rather than instantiated
directly.A measure column on a
ScatterChart.ScatterSeries, obtained from ScatterChart.ScatterSeries.addAdditionalMeasure()
rather than instantiated directly.The Options for a
ScatterChart, obtained from ScatterChart.getOptions() rather than
instantiated directly.A single series of a
ScatterChart, obtained from ScatterChart.addSeries() rather than
instantiated directly.This action is helping you to get an information about schedule as seen in the UI + if needed alter it.
An object which can be part of the output or input of a
PipelineStage.An object which represents a QueryApi
Expression and which can be part of the output or input of
a PipelineStage as it is also SelectableSellerGroup
Builder class for input type Seller
InputType.SELLER.Chooses how a series or additional measure itself is rendered, independently of the chart's overall type, set
with a concrete series or measure type's
setType(SeriesType) method (or an equivalent method on a
concrete series type), for example
DetailedTimeSeriesChart.DetailedTimeSeriesSeries.setType(SeriesType)
or ChartSeries.EmbeddedBoxplot.setType(SeriesType), for example
rendering one series of a Bar & Line Chart as a line while its other series render as bars.Builder class for basic input types.
This action starts calculation of selected simulation.
Builder class for input type Slider
InputType.SLIDER.Chooses the sort direction for a series or dimension, set with a concrete series type's
withSortByAxisX(SortType) or withSortByAxisY(SortType) method (or an equivalent method on a
concrete series type), for example
BoxplotChart.BoxplotSeries.withSortByAxisX(SortType) or
BoxplotChart.BoxplotSeries.withSortByAxisY(SortType), or with
PieChart.PieSeries.withSortByCategories(SortType).Class for splicing process of Condition Records.
Unifying (and very limited) JDBC ResultSet like API to a forward-only cursor on a query result, either from a Hibernate or PA query.
Builder class for input type StringUserEntry
InputType.STRINGUSERENTRY.This class acts as a DTO for PricelistItems that are enriched by some price list header information.
SystemPortlet objects are intended as output of logic/formula elements to be rendered by the UI.
This class is the central starting point for in-memory data table operations.
Collection of accessor to Pricefx domain tables as
Tables.Table objects.A representation of a set of columns of a concrete or virtual table.
A concrete domain table
Chooses whether a Multi Tier Entry input's tiers are sorted by their target value ascending or descending,
set with
MultiTierInputBuilder.setSortType(TieredValueSortType).Chooses whether a Multi Tier Entry input validates its entered tiers, set with
MultiTierInputBuilder.setValidationType(TieredValueValidationType).Builder for a Time Series Chart, obtained via
ChartBuilder.newTimeSeries() rather than
instantiated directly.A measure column on a
TimeSeriesChart.TimeSeriesSeries, obtained from
TimeSeriesChart.TimeSeriesSeries.addAdditionalMeasure() rather than instantiated directly.The Options for a
TimeSeriesChart, obtained from TimeSeriesChart.getOptions() rather than
instantiated directly.A single series of a
TimeSeriesChart, obtained from TimeSeriesChart.addSeries() rather
than instantiated directly.Builder for a Time Series Scatter Chart, obtained via
ChartBuilder.newTimeSeriesScatter()
rather than instantiated directly.A measure column on a
TimeSeriesScatterChart.TimeSeriesScatterSeries, obtained from
TimeSeriesScatterChart.TimeSeriesScatterSeries.addAdditionalMeasure() rather than instantiated directly.The Options for a
TimeSeriesScatterChart, obtained from
TimeSeriesScatterChart.getOptions() rather than instantiated directly.A single series of a
TimeSeriesScatterChart, obtained from
TimeSeriesScatterChart.addSeries() rather than instantiated directly.Builder for a trend line overlay on a chart series, obtained from
AbstractChartSeries.withTrendLine() rather than instantiated directly.Builder class for input type Lookup
InputType.LOOKUP.Builder for a Waterfall Chart, obtained via
ChartBuilder.newWaterfall() rather than
instantiated directly.Builder for the aggregation formula applied to a
WaterfallChart.WaterfallSeries' ADD and
SUBTRACT columns, obtained from WaterfallChart.WaterfallSeries.getAggregation() rather than instantiated
directly.The Options for a
WaterfallChart, obtained from WaterfallChart.getOptions() rather than
instantiated directly.The single series of a
WaterfallChart, obtained from WaterfallChart.getSeries() rather
than instantiated directly.Chooses what kind of column a
WaterfallChart.WaterfallSeries or
WaterfallComparisonChart.WaterfallComparisonSeries adds to its
bridge, set with
WaterfallChart.WaterfallSeries.addWaterfallColumn(WaterfallColumnType, String, String)
or the analogous method on a Waterfall Comparison Chart's series.Builder for a Waterfall Comparison Chart, obtained via
ChartBuilder.newWaterfallComparison()
rather than instantiated directly.Builder for the aggregation formula applied to a
WaterfallComparisonChart.WaterfallComparisonSeries' ADD and
SUBTRACT columns, obtained from WaterfallComparisonChart.WaterfallComparisonSeries.getAggregation() rather than
instantiated directly.The Options for a
WaterfallComparisonChart, obtained from
WaterfallComparisonChart.getOptions() rather than instantiated directly.A single waterfall of a
WaterfallComparisonChart, obtained from
WaterfallComparisonChart.addSeries() rather than instantiated directly.Chooses the statistical method used to compute a box plot's whisker (minimum/maximum) bounds.
Window function building methods.
This class is basically the type of object, which is exposed in the workflow logic by
the binding variable
workflowThis structure represents an entire workflow with multiple steps.
This structure describes each workflow step in detail
Makes sure that a result appears "as-is" in the logic result.
This is the base class for all exceptions that can occurs using the Expression Class.