All Classes and Interfaces
Class
Description
Utility class to work with Action Items in Groovy code
This class implements a histogram that adapts to an unknown data distribution.
Auxiliary interface for inline functor object.
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.
Methods of this class are mostly self-explanatory
or equivalent to the Highcharts methods described at
HighCharts.Chart.
Created by petercipov on 22/03/16.
Methods of this class are mostly self-explanatory
or equivalent to the Highcharts methods, described at
HighCharts.Chart.
Methods of this class are mostly self-explanatory
or equivalent to the Highcharts methods described at
HighCharts.Chart.
Builder class for input type Button
InputType.BUTTONThis is the shared builder class for Quotes, RebateAgreements and Contracts.
Some important notes on the sequence in which changes to the document structure are processed:
Any modifying action (adding lines, inputs etc. or a structure object etc.)
Some important notes on the sequence in which changes to the document structure are processed:
Any modifying action (adding lines, inputs etc. or a structure object etc.)
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.
ClaimContext is used for configuration of
Configure Channel Management.
Represents a column and its metadata description.
IMPORTANT: Please read super class notes on sequence of execution!
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 class 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 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 DataSlice defines a set of filters to be applied to a PA DataSet (Datamart, DataSource...).
API for building a PA query in a formula context.
Provides 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.
Methods of this class are mostly self-explanatory
or equivalent to the Highcharts methods described at
HighCharts.Chart.
Builder class for input type DateRangeUserEntry
InputType.DATERANGEUSERENTRY.Methods of this class are mostly self-explanatory
or equivalent to the Highcharts methods described at
HighCharts.Chart.
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 DMFilterBuilder
InputType.DMFILTERBUILDER.Builder class for input type DMFilterBuilder
InputType.DMFILTERBUILDER.Builder class for input type
DmQueryBuilder.All possible event type constants.
This action starts exporting or archiving.
An Expression used to specify either output values or logic criteria of a
PipelineStage.Collection of
Expression building methodsEnumeration of existing FieldFormatTypes.
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.Methods of this class are mostly self-explanatory
or equivalent to the Highcharts methods described at
HighCharts.Chart.
Methods of this class are mostly self-explanatory
or equivalent to the Highcharts methods described at
HighCharts.Chart.
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 Rebate Record Group is available via the
The Rebate Record Group is available via the
rebateRecordGroup binding variable (see the set() example below).The RebateRecordManager API is exposed to Groovy logic elements in the following contexts:
Represents a scored item recommendation calculated by logic.
This class represents either a line item or a folder of a document (e.g. quote/contract/rebate)
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.The
NotificationApi interface is used for configuring Notifications.This action starts calculation of selected rebate record set records.
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
Methods of this class are mostly self-explanatory
or equivalent to the Highcharts methods described at
HighCharts.Chart.
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 class that assists in manipulating the quote object.
This is a helper object that is used to build up the code-generated content of a quote.
Created by petercipov on 22/03/16.
IMPORTANT: Please read super class notes on sequence of execution!
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.
The Gauge widget class implements a graphical speedometer-style gauge for displaying a measurement by means of a needle
on a dial.
This class is used to transport a calculated matrix-style result
It is basically a list of maps with the addition that the column names are clearly named and can have a format
This means:
- the UI knows exactly which columns to display (even if some maps do not have those as keys)
- the entry maps can have more "columns" (or keys) than those that are displayed; maybe useful for calculation
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: [... : ...]]
Methods of this class are mostly self-explanatory
or equivalent to the Highcharts methods described at
HighCharts.Chart.
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.Builder class for basic input types.
This action starts calculation of selected simulation.
Builder class for input type Slider
InputType.SLIDER.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.
Represents a table and its metadata description.
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
Methods of this class are mostly self-explanatory
or equivalent to the Highcharts methods described at
HighCharts.Chart.
Methods of this class are mostly self-explanatory
or equivalent to the Highcharts methods described at
HighCharts.Chart.
Builder class for input type Lookup
InputType.LOOKUP.Methods of this class are mostly self-explanatory
or equivalent to the Highcharts methods described at
HighCharts.Chart.
Methods of this class are mostly self-explanatory
or equivalent to the Highcharts methods described at
HighCharts.Chart.
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.