Skip navigation links
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 

A

abortCalculation() - Method in interface PublicGroovyAPI
Aborts the current item calculation.
AbstractChartBuilder<C extends AbstractChartBuilder<C>> - Class in net.pricefx.common.apibuilder.chart
 
AbstractChartBuilder(String, IdGenerator, Invocations<MethodInvocation>) - Constructor for class AbstractChartBuilder
 
AbstractChartEvent<C extends AbstractChartBuilder<?>,E extends AbstractChartEvent<C,E>> - Class in net.pricefx.common.apibuilder.chart
 
AbstractChartEvent(C) - Constructor for class AbstractChartEvent
 
AbstractChartEvent.TriggerEvent<T extends AbstractChartEvent.TriggerEvent<?>> - Class in net.pricefx.common.apibuilder.chart
 
AbstractChartMeasures<S extends AbstractChartSeries<?,S>,M extends AbstractChartMeasures<S,M>> - Class in net.pricefx.common.apibuilder.chart
 
AbstractChartMeasures(S, String) - Constructor for class AbstractChartMeasures
 
AbstractChartOptions<C extends AbstractChartBuilder<C>,O extends AbstractChartOptions<C,O>> - Class in net.pricefx.common.apibuilder.chart
 
AbstractChartOptions(C, String) - Constructor for class AbstractChartOptions
 
AbstractChartSeries<C extends AbstractChartBuilder<C>,S extends AbstractChartSeries<C,S>> - Class in net.pricefx.common.apibuilder.chart
 
AbstractChartSeries(C, String) - Constructor for class AbstractChartSeries
 
AbstractResultMatrixCell() - Constructor for class ResultMatrix.AbstractResultMatrixCell
 
activeStep - Variable in class WorkflowInfo
The currently active workflow step
AdaptiveHistogram - Class in com.flaptor.hist4j
This class implements a histogram that adapts to an unknown data distribution.
AdaptiveHistogram() - Constructor for class AdaptiveHistogram
Class constructor.
AdaptiveHistogram.ValueConversion - Interface in com.flaptor.hist4j
Auxiliary interface for inline functor object.
add(Filter) - Method in class Filter
Used with OP_OR and OP_AND filters.
add(String, int, String) - Method in interface DatamartContext.Calendar
Parses the a period string and offsets the start date of the resulting TimePeriod with a number of TimeUnits.
add(Map<?, ?>...) - Method in interface IRebateRecordManager
Add a RR to the current RA.lineitem with the default name and optional initial generic attribute values
add(String, Map<?, ?>...) - Method in interface IRebateRecordManager
Add a RR to the current RA.lineitem with the given name and optional initial generic attribute values
add(String, String, Map<?, ?>...) - Method in interface IRebateRecordManager
Add a RR in the given RR-set to the current RA.lineitem with the given name and optional initial generic attribute values If the RR-set with the given label does not yet exist, it will be created as a side-effect.
add(String, String, Map<?, ?>...) - Method in interface PayoutRecordManager
Add a previously non-existing PayoutRecord, identified by type & name
add(String, Map<String, Object>) - Method in interface PublicGroovyAPI
Adds a new object to the collection of objects of the given type.
addAdditionalMeasure() - Method in class BarLineChart.BarLineSeries
 
addAdditionalMeasure() - Method in class BoxplotChart.BoxplotSeries
 
addAdditionalMeasure() - Method in class BubbleChart.BubbleSeries
 
addAdditionalMeasure() - Method in class DataTableChart.DataTableSeries
 
addAdditionalMeasure() - Method in class DetailedTimeSeriesChart.DetailedTimeSeriesSeries
 
addAdditionalMeasure() - Method in class HeatmapChart.HeatmapSeries
 
addAdditionalMeasure() - Method in class HistogramChart.HistogramSeries
 
addAdditionalMeasure() - Method in class PieChart.PieSeries
 
addAdditionalMeasure() - Method in class ScatterChart.ScatterSeries
 
addAdditionalMeasure() - Method in class TimeSeriesChart.TimeSeriesSeries
 
addAdditionalMeasure() - Method in class TimeSeriesScatterChart.TimeSeriesScatterSeries
 
addApprovalStep(String) - Method in class WorkflowDTO
Adds an approval step at the end of the workflow
addAuxLine() - Method in class AbstractChartBuilder
 
addAuxLine() - Method in class BarLineChart
 
addAuxLine() - Method in class BoxplotChart
 
addAuxLine() - Method in class BubbleChart
 
addAuxLine() - Method in class DetailedTimeSeriesChart
 
addAuxLine() - Method in class HistogramChart
 
addAuxLine() - Method in class PieChart
 
addAuxLine() - Method in class ScatterChart
 
addAuxLine() - Method in class TimeSeriesChart
 
addAuxLine() - Method in class TimeSeriesScatterChart
 
addBackendCall(String, String) - Method in class DashboardController
Performs a backend call in the user's context (i.e.
addBackendCall(String, String, String) - Method in class DashboardController
Performs a backend call in the user's context (i.e.
addBackendCall(String, String, String, String, String) - Method in class DashboardController
Performs a backend call in the user's context (i.e.
addButton(String, String) - Method in class DashboardController
Adds a button to the controller
addButton(String, String, Object) - Method in class DashboardController
Adds a button to the controller
addButton(String, String, Object, Object) - Method in class DashboardController
Adds a button to the controller
addCalculatedFieldSetAction(String) - Method in class CalculationFlowActionBuilder
Adds CFS action to the list of actions that should be executed.
addColumn(String, Object[]) - Method in interface Matrix2D
Add a column to this Matrix2D, with the value on each row retreived from the given values array.
addColumn(String) - Method in interface Matrix2D
Add a column to this Matrix2D, without any values
addColumn(String) - Method in class ResultMatrix
Adds a column to the existing set of columns
addColumn(String, String) - Method in class ResultMatrix
Adds a column to the existing set of columns including a tooltip
addColumns(Collection<String>) - Method in class ResultMatrix
Adds columns to the existing set of columns
addColumnTranslation(String, Map<String, String>) - Method in class ResultMatrix
Adds translated labels for the given column.
addCustomersFilter() - Method in class AbstractChartSeries
 
addDataLoadAction(String, String, String) - Method in class CalculationFlowActionBuilder
Adds data load action to the list of actions that should be executed.
addDimFilter(String, String) - Method in class AbstractChartSeries
 
addDownloadButton(String, String) - Method in class DashboardController
Performs a backend call in the user's context in new window.
addDownloadButton(String, String, String) - Method in class DashboardController
Performs a backend call in the user's context in new window.
addExportAction(String) - Method in class CalculationFlowActionBuilder
Adds export/archive action to the list of actions that should be executed.

Snippet:
Export flavour: actionBuilder.addExportAction('jobName').doExport('templateName') Archive flovour: actionBuilder.addExportAction('jobName').doArchive('templateName')
addFilter(String, FilterOperator) - Method in class Filters
 
addFilter(String, FilterOperator, Object) - Method in class Filters
 
addFilter(Object) - Method in class Filters
Adds a (possibly complex) filter.
addFilter(Filter) - Method in interface DatamartContext.DataSlice
 
addFilters() - Method in class AbstractChartSeries
 
addFilters(FilterOperator) - Method in class AbstractChartSeries
 
addFilters(FilterOperator) - Method in class Filters
 
addFolder(String) - Method in class QuoteBuilder
Creates and adds a new root folder This is only a shortcut as when doing it via QuoteStructure If you intend to add many folders and items, please use the QuoteStructure approach instead!
addFolder(String) - Method in class QuoteStructure
Creates and adds a new folder
addFolder(String, List<Map<String, Object>>) - Method in class QuoteStructure
Creates and adds a new folder
addGroupBy(String) - Method in class DataTableChart.DataTableSeries
 
addHTML(String) - Method in class DashboardController
Adds a HTML snippet into the controller
addInputParameter(String, BigDecimal) - Method in class Formula
 
addInputParameter(String, String) - Method in class Formula
 
addInvocation(String, Object...) - Method in class AbstractChartBuilder
 
addItemReason(String, String) - Method in class WorkflowDTO
 
addLineItem(String) - Method in class CalculableLineItemCollectionBuilder
This method adds a new line item in the root folder
addLineItem(String, String) - Method in class CalculableLineItemCollectionBuilder
This method adds a new line item in the specified parent (folder id)
addLineItem(String, String, List<Map<String, Object>>) - Method in class CalculableLineItemCollectionBuilder
This method adds a new line item in the specified parent (folder id) and sets some context parameters.
addLineItemWithId(String, String) - Method in class RATBuilder.RABuilder
 
addLineItemWithId(String, String, String) - Method in class RATBuilder.RABuilder
 
addLivePriceGridAction(String) - Method in class CalculationFlowActionBuilder
Adds live price grid action to the list of actions that should be executed.
addManualPricelistAction(String) - Method in class CalculationFlowActionBuilder
Adds manual pricelist action to the list of actions that should be executed.
addMap(String...) - Method in class ResultHighmap
The map renderer will try to download the appropriate map by peeking at chart.map value of the provided definition.
addMappedColumn(String, String, Map<String, Object>) - Method in interface Matrix2D
Add a column to this Matrix2D, with the value on each row looked up from the given map, using the mapped column's value as the lookup key.
addMappedColumn(String, List<String>, Map<MultiKey<String>, Object>) - Method in interface Matrix2D
Add a column to this Matrix2D, with the value on each row looked up from the given map, using a set of existing columns' values as a composite lookup key.
addModule(String...) - Method in class ResultHighchart
By default, only the modules required for the various Price Analyzer chart types are available.
addObjectTypedId(String) - Method in class ItemSummaryQuery
 
addObjRefAction() - Method in class CalculationFlowActionBuilder
Adds object references action to the list of actions that should be executed.
addOrUpdate(String, String, Map<?, ?>...) - Method in interface PayoutRecordManager
Convenience method, adding a PayoutRecord if one with the given type & name does not yest exist, and updating it otherwise.
addOrUpdate(String, Map<String, Object>) - Method in interface PublicGroovyAPI
Adds or updates an object in the collection of objects of the given type.
addOrUpdateInput(Map<String, Object>) - Method in class CalculableLineItemCollectionBuilder
This method adds or updates an input value on the root level
addOrUpdateInput(String, Map<String, Object>) - Method in class CalculableLineItemCollectionBuilder
This method adds or updates an input value on a line item
addOrUpdateOutput(Map<String, Object>) - Method in class CalculableLineItemCollectionBuilder
This method adds or updates a result value (an output value) on the root level
addOrUpdateOutput(String, Map<String, Object>) - Method in class CalculableLineItemCollectionBuilder
This method adds or updates a result value (an output value) on a line item
addParameterConfigEntry(String, Object) - Method in class ContextParameter
 
addPart(String) - Method in class QuoteBuilder
Creates and adds a new part This is only a shortcut as when doing it via QuoteStructure If you intend to add many folders and items, please use the QuoteStructure approach instead!
addPart(String) - Method in class QuoteStructure
Creates and adds a new part
addPart(String, List<Map<String, Object>>) - Method in class QuoteStructure
Creates and adds a new part
addPriceAPIAction(String) - Method in class CalculationFlowActionBuilder
Adds PriceAPI action to the list of actions that should be executed.
addPricelistAction(String) - Method in class CalculationFlowActionBuilder
Adds pricelist action to the list of actions that should be executed.
addProductsFilter() - Method in class AbstractChartSeries
 
addProjection(String, String) - Method in class ItemSummaryQuery
 
addProjection(String, String, String) - Method in class ItemSummaryQuery
 
addProjection(String, String, String, String) - Method in class ItemSummaryQuery
 
addProperty(String, Object) - Method in class WorkflowDTO.ApprovalStepDTO
 
addProperty(String, Object) - Method in class WorkflowDTO.WatcherStepDTO
 
addQuoteStructure(QuoteStructure) - Method in class QuoteBuilder
Apply a quote structure.
addRange(String, BigDecimal, BigDecimal) - Method in class HeatmapChart.HeatmapRangedColorAxis
 
addRebateRecordAction(String) - Method in class CalculationFlowActionBuilder
Adds rebate record action to the list of actions that should be executed.
addResultMatrixTab(ResultMatrix) - Method in class ResultHighchart
The automatically filled data tab can be replaced by customized ResultMatrix data.
addRow(Map<String, Object>) - Method in interface DatamartContext.DataLoader
Adds a row to the data buffer that will ultimately be loaded in the feed table.
addRow(List<Object>) - Method in interface DatamartContext.DataLoader
Adds a row to the data buffer that will ultimately be loaded in the feed table.
addRow(Object...) - Method in interface DatamartContext.DataLoader
Adds a row to the data buffer that will ultimately be loaded in the feed table.
addRow(Map<String, Object>) - Method in class ResultMatrix
Adds a data row.
addRow(List<Object>) - Method in class ResultMatrix
Adds a data row.
addRow(Object...) - Method in class ResultMatrix
Adds a data row.
addSector(BigDecimal, String) - Method in class ResultGauge
Add a GaugeSector contained in this Gauge.
addSeries() - Method in class BarLineChart
 
addSeries() - Method in class BoxplotChart
 
addSeries() - Method in class BubbleChart
 
addSeries() - Method in class DataTableChart
 
addSeries() - Method in class DetailedTimeSeriesChart
 
addSeries() - Method in class PieChart
 
addSeries() - Method in class ScatterChart
 
addSeries() - Method in class TimeSeriesChart
 
addSeries() - Method in class TimeSeriesScatterChart
 
addSeries() - Method in class WaterfallComparisonChart
 
addSimulationAction(String) - Method in class CalculationFlowActionBuilder
Adds simulation action to the list of actions that should be executed.
addStep(String, String) - Method in class AuxLine.SteppedLine
 
addStop(String, Integer) - Method in class HeatmapChart.HeatmapInterpolatedColorAxis
 
addTotal(Map<String, Object[]>) - Method in class ItemSummaryQuery
 
addValue(double) - Method in class AdaptiveHistogram
Adds a data point to the histogram.
addWarning(String) - Method in interface PublicGroovyAPI
Adds a warning to the formula execution warning log.
addWatcherStep(String) - Method in class WorkflowDTO
Adds a watcher step to the end of the workflow.
addWaterfallColumn(WaterfallColumnType, String, String) - Method in class WaterfallChart.WaterfallSeries
 
addWaterfallColumn(WaterfallColumnType, String, String) - Method in class WaterfallComparisonChart.WaterfallComparisonSeries
 
aggregate(Map<String, Object[]>, List) - Method in class ItemSummaryQuery
 
Aggregation(C, String) - Constructor for class ChartSeries.Aggregation
 
Aggregation(WaterfallChart.WaterfallSeries, String) - Constructor for class WaterfallChart.Aggregation
 
Aggregation(WaterfallComparisonChart.WaterfallComparisonSeries, String) - Constructor for class WaterfallComparisonChart.Aggregation
 
AggregationFormula - Enum in net.pricefx.common.api.chart
 
alignment - Variable in class ResultMatrix.ResultMatrixStyledCell
 
all(String, Filter) - Static method in class Filter
Create a new Filter using the ALL operator.
alreadySatisfiedComment - Variable in class WorkflowDTO.StepDTO
 
and(Filter...) - Static method in class Filter
Create a new Filter using the AND operator.
andRecalculateOn(String) - Method in interface DashboardApi
 
anyUser(String) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user select a user from the list of all users.
applyPlaceholder(String, Object) - Method in class RATBuilder.RABuilder
 
applyType(InputType) - Method in class ContextParameter
 
approvalDate - Variable in class WorkflowInfo.WorkflowStepInfo
Date of approval, GMT timezone
approvalRequiredEmailAttachments - Variable in class WorkflowInfo.WorkflowStepInfo
The attachments
ApprovalStepDTO(WorkflowDTO, String) - Constructor for class WorkflowDTO.ApprovalStepDTO
 
asLink() - Method in interface IRebateRecordManager
Return a clickable link to the RR with the default name, as the result of a formula element
asLink(String) - Method in interface IRebateRecordManager
Return a clickable link to the RR with the given name, as the result of a formula element
asLink(String, String) - Method in interface IRebateRecordManager
Return a clickable link to the RR for the given name and RR-set, as the result of a formula element
asListOfMaps(Map<String, Object[]>) - Method in class ItemSummaryQuery
 
asParam(String) - Method in interface DashboardApi
 
asResultMatrix(String...) - Method in interface IRebateRecordManager
Return a ResultMatrix listing all RRs in the agreement, optionally the fields/attributes to be shown as matrix columns.
attributedResult(Object) - Method in interface PublicGroovyAPI
Creates an AttributedResult object to be returned as a result of an output element.
AttributedResult - Class in net.pricefx.server.dto.calculation
Provides means for output elements' formatting.
AttributedResult(Object) - Constructor for class AttributedResult
 
AttributedResult(Object, Map<String, Object>) - Constructor for class AttributedResult
 
AuxLine<C extends AbstractChartBuilder<C>> - Class in net.pricefx.common.apibuilder.chart
 
AuxLine(C, String, String) - Constructor for class AuxLine
 
AuxLine.Line<C extends ObjectIdentity> - Class in net.pricefx.common.apibuilder.chart
 
AuxLine.SteppedLine<C extends ObjectIdentity> - Class in net.pricefx.common.apibuilder.chart
 
AuxLine.VerticalLine<C extends ObjectIdentity> - Class in net.pricefx.common.apibuilder.chart
 
AuxLineColor - Enum in net.pricefx.common.api.chart
 
AuxLineType - Enum in net.pricefx.common.api.chart
 

B

back() - Method in class CFSAction
 
back() - Method in class DataLoadAction
 
back() - Method in class ExportAction
 
back() - Method in class LivePriceGridAction
 
back() - Method in class ManualPricelistAction
 
back() - Method in class ObjRefAction
 
back() - Method in class PriceAPIAction
 
back() - Method in class PricelistAction
 
back() - Method in class RebateRecordAction
 
back() - Method in class ScheduleSettings
 
back() - Method in class SimulationAction
 
back() - Method in class AbstractChartEvent.TriggerEvent
 
background - Variable in class ResultMatrix.ResultMatrixStyledCell
 
BarLineAdditionalMeasure(BarLineChart.BarLineSeries, String) - Constructor for class BarLineChart.BarLineAdditionalMeasure
 
BarLineChart - Class in net.pricefx.common.apibuilder.chart
Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at https://api.highcharts.com/class-reference/Highcharts.Chart.
BarLineChart(IdGenerator, Invocations<MethodInvocation>) - Constructor for class BarLineChart
 
BarLineChart.BarLineAdditionalMeasure - Class in net.pricefx.common.apibuilder.chart
 
BarLineChart.BarLineOnChartClick - Class in net.pricefx.common.apibuilder.chart
 
BarLineChart.BarLineOnChartClick.BarLineTriggerEvent - Class in net.pricefx.common.apibuilder.chart
 
BarLineChart.BarLineOptions - Class in net.pricefx.common.apibuilder.chart
 
BarLineChart.BarLineSeries - Class in net.pricefx.common.apibuilder.chart
 
BarLineOnChartClick() - Constructor for class BarLineChart.BarLineOnChartClick
 
BarLineOptions(BarLineChart, String) - Constructor for class BarLineChart.BarLineOptions
 
BarLineSeries(BarLineChart, String) - Constructor for class BarLineChart.BarLineSeries
 
BarLineTriggerEvent(String) - Constructor for class BarLineChart.BarLineOnChartClick.BarLineTriggerEvent
 
base64Decode(String) - Method in interface PublicGroovyAPI
Decodes a base64 encoded string.
base64Encode(String) - Method in interface PublicGroovyAPI
Provides a standard Base64 encoding of a string.
Basic(S, String) - Constructor for class ChartMeasures.Basic
 
Basic(C, String) - Constructor for class ChartOptions.Basic
 
Basic(C, String) - Constructor for class ChartSeries.Basic
 
BasicRebateAgreementBuilder<T extends BasicRebateAgreementBuilder> - Class in net.pricefx.common.apibuilder.rebateagreement
Created by petercipov on 22/03/16.
BasicRebateAgreementBuilder(String, String, IdGenerator, Invocations<MethodInvocation>, HeaderPhase) - Constructor for class BasicRebateAgreementBuilder
 
bom() - Method in interface PublicGroovyAPI
Accesses and retrieves values from a rolled-up bill of materials for the SKU being calculated.
bom(String) - Method in interface PublicGroovyAPI
Accesses and retrieves values from a rolled-up bill of materials for the SKU being calculated.
bom(String, String) - Method in interface PublicGroovyAPI
Accesses and retrieves values from a rolled-up bill of materials for the SKU being calculated.
bom(String, String, String) - Method in interface PublicGroovyAPI
Accesses and retrieves the values from a rolled-up bill of materials for the SKU being calculated Only BoM records with the specified category and the material are considered.
bomList() - Method in interface PublicGroovyAPI
Rolls up the current SKU's BoM and returns the rolled up BoM records (not just the quantities).
booleanUserEntry(String) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user enter a boolean (yes or no) value.
boundCall(String, String, String, Boolean...) - Method in interface PublicGroovyAPI
Triggers a HTTPS request towards the Price fx server, either local one or an external one.
BoxplotAdditionalMeasure(BoxplotChart.BoxplotSeries, String) - Constructor for class BoxplotChart.BoxplotAdditionalMeasure
 
BoxplotChart - Class in net.pricefx.common.apibuilder.chart
Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods, described at https://api.highcharts.com/class-reference/Highcharts.Chart.
BoxplotChart(IdGenerator, Invocations<MethodInvocation>) - Constructor for class BoxplotChart
 
BoxplotChart.BoxplotAdditionalMeasure - Class in net.pricefx.common.apibuilder.chart
 
BoxplotChart.BoxplotOptions - Class in net.pricefx.common.apibuilder.chart
 
BoxplotChart.BoxplotSeries - Class in net.pricefx.common.apibuilder.chart
 
BoxplotOptions(BoxplotChart, String) - Constructor for class BoxplotChart.BoxplotOptions
 
BoxplotSeries(BoxplotChart, String) - Constructor for class BoxplotChart.BoxplotSeries
 
BubbleAdditionalMeasure(BubbleChart.BubbleSeries, String) - Constructor for class BubbleChart.BubbleAdditionalMeasure
 
BubbleChart - Class in net.pricefx.common.apibuilder.chart
Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at https://api.highcharts.com/class-reference/Highcharts.Chart.
BubbleChart(IdGenerator, Invocations<MethodInvocation>) - Constructor for class BubbleChart
 
BubbleChart.BubbleAdditionalMeasure - Class in net.pricefx.common.apibuilder.chart
 
BubbleChart.BubbleOptions - Class in net.pricefx.common.apibuilder.chart
 
BubbleChart.BubbleSeries - Class in net.pricefx.common.apibuilder.chart
 
BubbleChart.BubbleSize - Class in net.pricefx.common.apibuilder.chart
 
BubbleOptions(BubbleChart, String) - Constructor for class BubbleChart.BubbleOptions
 
BubbleSeries(BubbleChart, String) - Constructor for class BubbleChart.BubbleSeries
 
BubbleSize(BubbleChart.BubbleSeries, String, String) - Constructor for class BubbleChart.BubbleSize
 
build(ChartType) - Method in class AbstractChartBuilder
 
build() - Method in class BarLineChart
 
build() - Method in class BoxplotChart
 
build() - Method in class BubbleChart
 
build() - Method in class DataTableChart
 
build() - Method in class DetailedTimeSeriesChart
 
build() - Method in class HeatmapChart
 
build() - Method in class HistogramChart
 
build() - Method in class PieChart
 
build() - Method in class ScatterChart
 
build() - Method in class TimeSeriesChart
 
build() - Method in class TimeSeriesScatterChart
 
build() - Method in class WaterfallChart
 
build() - Method in class WaterfallComparisonChart
 
build() - Method in class ContractBuilder
 
build() - Method in class QuoteBuilder
 
build() - Method in class BasicRebateAgreementBuilder
 
build() - Method in class RATBuilder
 
buildDataTableChart(String, String) - Method in interface IRebateRecordManager
Deprecated.
buildFlexChart(Object) - Method in interface PublicGroovyAPI
buildFlexChart(String, Object) - Method in interface PublicGroovyAPI
Creates a FlexChart from the passed definition by merging it with options defined within the baseTemplateToUse template.
buildFromOpaqueString(String) - Method in class Dictionary
 
buildHighchart(Map<String, ?>) - Method in interface PublicGroovyAPI
Creates a ResultHighchart from the passed definition.
buildHighmap(Map<String, ?>) - Method in interface PublicGroovyAPI
Creates a ResultHighmap from the passed definition.
buildQuery(DatamartContext.Query) - Method in interface DatamartContext
EXPERIMENTAL: not all aspects, properties of a query or supported! For ex: currently not supported are dim filters, row limit, join queries....

C

CalculableLineItemCollectionBuilder<T extends CalculableLineItemCollectionBuilder> - Class in net.pricefx.common.apibuilder.clicoll
This is the shared builder class for Quotes, RebateAgreements and Contracts.
Some important notes on the sequence that changes to the document structure a re processed:

Any modifying action (adding lines, inputs etc or a structure object etc) IS NOT executed as per sequence of the groovy logic! The groovy logic should be more considered as a routine that collects all necessary changes.
CalculableLineItemCollectionBuilder(String, String, IdGenerator, Invocations<MethodInvocation>, HeaderPhase) - Constructor for class CalculableLineItemCollectionBuilder
 
calculateSummaryStatistics() - Method in interface DatamartQueryResult
Calculates basic summary statistics on the query result data, and add it to the Summary map: Sum, Avg, Mean, Min, Max, Std and quantiles Q.05, Q.1, Q.2, Q.25, Q.4, Q.5, Q.6, Q.7, Q.75, Q.8, Q.8, Q.95.
CalculationFlowActionBuilder - Class in net.pricefx.common.apibuilder.calculationflowaction
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:
def builder = actionBuilder
Note that you will find full code snippets in the "Command Templates/Calculation Flow Examples" inside calculation flow formulas UI.
CalculationFlowActionBuilder(Invocations<MethodInvocationRecord>, CalculationFlowTimeUnit, BigDecimal, String, Boolean, CFTraitType) - Constructor for class CalculationFlowActionBuilder
 
CalculationFlowActionBuilder(Invocations<MethodInvocationRecord>) - Constructor for class CalculationFlowActionBuilder
 
calendar() - Method in interface DatamartContext
Instantiate a PA Calendar utility object.
calendar() - Method in interface PublicGroovyAPI
Gets a java.util.Calendar object initialized with the current targetDate (or new Date() if no target date is given).
calendar(Date) - Method in interface PublicGroovyAPI
Gets a calendar object initialized with date.
castNumeric(String) - Method in interface ItemSummaryQuery.QueryGeneratorCallback
 
CellClickTriggerEvent(String) - Constructor for class ChartEvents.OnCellClick.CellClickTriggerEvent
 
CFSAction<ATTACHEDTO extends Help> - Class in net.pricefx.common.apibuilder.calculationflowaction
This action starts calculation of selected CFS.
CFSAction(ATTACHEDTO, Invocations<MethodInvocationRecord>, String) - Constructor for class CFSAction
 
ChartBuilder - Class in net.pricefx.common.apibuilder.chart
 
ChartBuilder() - Constructor for class ChartBuilder
 
ChartBuilder(IdGenerator, InvocationBuilder<MethodInvocation>) - Constructor for class ChartBuilder
 
ChartEvents - Class in net.pricefx.common.apibuilder.chart
 
ChartEvents.OnCellClick<C extends AbstractChartBuilder<?>> - Class in net.pricefx.common.apibuilder.chart
 
ChartEvents.OnCellClick.CellClickTriggerEvent - Class in net.pricefx.common.apibuilder.chart
 
ChartEvents.OnChartClick<C extends AbstractChartBuilder<?>,E extends ChartEvents.OnChartClick<C,E>> - Class in net.pricefx.common.apibuilder.chart
 
ChartEvents.OnChartClick.ClickTriggerEvent<T extends ChartEvents.OnChartClick.ClickTriggerEvent<?>> - Class in net.pricefx.common.apibuilder.chart
 
ChartEvents.OnRowClick<C extends AbstractChartBuilder<?>> - Class in net.pricefx.common.apibuilder.chart
 
ChartEvents.OnRowClick.RowClickTriggerEvent - Class in net.pricefx.common.apibuilder.chart
 
ChartMeasures - Class in net.pricefx.common.apibuilder.chart
 
ChartMeasures.Basic<S extends AbstractChartSeries<?,S>,M extends ChartMeasures.Basic<S,M>> - Class in net.pricefx.common.apibuilder.chart
 
ChartMeasures.EmbeddedBoxplot<S extends AbstractChartSeries<?,S>,M extends ChartMeasures.EmbeddedBoxplot<S,M>> - Class in net.pricefx.common.apibuilder.chart
 
ChartMeasures.Type<S extends AbstractChartSeries<?,S>,M extends ChartMeasures.Type<S,M>> - Class in net.pricefx.common.apibuilder.chart
 
ChartOptions - Class in net.pricefx.common.apibuilder.chart
 
ChartOptions.Basic<C extends AbstractChartBuilder<C>,O extends ChartOptions.Basic<C,O>> - Class in net.pricefx.common.apibuilder.chart
 
ChartOptions.EmbeddedBoxplot<C extends AbstractChartBuilder<C>,O extends ChartOptions.EmbeddedBoxplot<C,O>> - Class in net.pricefx.common.apibuilder.chart
 
ChartOptions.XYLabels<C extends AbstractChartBuilder<C>,O extends ChartOptions.XYLabels<C,O>> - Class in net.pricefx.common.apibuilder.chart
 
ChartOptions.XYMinMax<C extends AbstractChartBuilder<C>,O extends ChartOptions.XYMinMax<C,O>> - Class in net.pricefx.common.apibuilder.chart
 
ChartOptions.ZAxis<C extends AbstractChartBuilder<C>,O extends ChartOptions.ZAxis<C,O>> - Class in net.pricefx.common.apibuilder.chart
 
ChartSeries - Class in net.pricefx.common.apibuilder.chart
 
ChartSeries.Aggregation<C extends AbstractChartBuilder<C>,S extends ChartSeries.Basic<C,S>> - Class in net.pricefx.common.apibuilder.chart
 
ChartSeries.Basic<C extends AbstractChartBuilder<C>,S extends ChartSeries.Basic<C,S>> - Class in net.pricefx.common.apibuilder.chart
 
ChartSeries.EmbeddedBoxplot<C extends AbstractChartBuilder<C>,S extends ChartSeries.Basic<C,S>> - Class in net.pricefx.common.apibuilder.chart
 
ChartType - Enum in net.pricefx.common.api.chart
 
ClaimContext - Interface in net.pricefx.formulaengine.scripting
 
clear() - Method in interface DatamartContext.DataSlice
 
clearAttribute(String) - Method in class AttributedResult
 
clearConfigParameter(String) - Method in class ContextParameter
 
clearNewSchedule() - Method in class ScheduleSettings
 
clearRenderInfo(String) - Method in class CalculableLineItemCollectionBuilder
Clears existing render info for a field or for all fields
ClickTriggerEvent(String) - Constructor for class ChartEvents.OnChartClick.ClickTriggerEvent
 
close() - Method in class TableContext
 
close() - Method in interface StreamResults
Releases the often significant resources required to provide access to the query result set.
color() - Method in enum AuxLineColor
 
color - Variable in class ResultMatrix.ResultMatrixStyledCell
 
ColorAxisType - Enum in net.pricefx.common.api.chart
 
com.flaptor.hist4j - package com.flaptor.hist4j
 
com.googlecode.genericdao.search - package com.googlecode.genericdao.search
 
comment - Variable in class WorkflowInfo.WorkflowStepInfo
A user comment entered during approval/denial
ComparisonType - Enum in net.pricefx.common.api.chart
 
configurator(String, String) - Method in interface PublicGroovyAPI
 
configurator(String, String, Object) - Method in interface PublicGroovyAPI
 
configurator(String, String, Object, Object) - Method in interface PublicGroovyAPI
 
ConfiguratorEntry - Class in net.pricefx.server.dto.calculation
This class is used to transport a configurator entry
ConfiguratorEntry() - Constructor for class ConfiguratorEntry
 
conn - Variable in class TableContext
 
constantSelectTextExpression(String) - Method in interface ItemSummaryQuery.QueryGeneratorCallback
 
containsAttribute(String) - Method in class AttributedResult
 
contextByLabel(String) - Method in interface PublicGroovyAPI
Retrieves the previous calculation result by the logic element label (not the element result name).
contextName() - Method in interface PublicGroovyAPI
The name of the current context, e.g.
ContextParameter - Class in net.pricefx.server.dto.calculation
 
ContextParameter() - Constructor for class ContextParameter
 
ContextParameter(InputType, String, Date, PersistedObjectService) - Constructor for class ContextParameter
 
ContextParameter(LookupTable, Date) - Constructor for class ContextParameter
 
ContextParameter(LookupTable, Date, String) - Constructor for class ContextParameter
 
ContextParameter(String, DMFieldCollection, String, String) - Constructor for class ContextParameter
 
contextSkuSet(int) - Method in interface PublicGroovyAPI
Returns a set of SKUs which comprise so-called 'SKU context' of the current formula execution.
contextType() - Method in interface PublicGroovyAPI
The type (type code string) of the current context.
contextTypedId() - Method in interface PublicGroovyAPI
The typedId of the current context.
ContractBuilder - Class in net.pricefx.common.apibuilder.contract
IMPORTANT: Please read super class notes on sequence of execution!
ContractHelper - Class in net.pricefx.common.apibuilder.contract
 
ContractHelper(Map<String, Object>) - Constructor for class ContractHelper
 
ControllerItem() - Constructor for class DashboardController.ControllerItem
 
convertValue(double) - Method in interface AdaptiveHistogram.ValueConversion
This method should implement the conversion function.
copyWithoutValue() - Method in class ContextParameter
 
count(String, Filter...) - Method in interface PublicGroovyAPI
Returns the number of records that a corresponding PublicGroovyAPI.find(String, int, int, String, List, Filter...) would return.
count(String) - Method in class TableContext
Get the row count of a in-memory table
createConfiguratorEntry(InputType, String) - Method in interface PublicGroovyAPI
Creates a configurator entry object and adds the specified input parameter as the first parameter to the configurator entry.
createConfiguratorEntry(InputType, String, Date) - Method in interface PublicGroovyAPI
Creates a configurator entry object and adds the specified input parameter as the first parameter to the configurator entry.
createConfiguratorEntry() - Method in interface PublicGroovyAPI
Creates an empty configurator entry object.
createConfiguratorEntryArray(Object...) - Method in interface PublicGroovyAPI
Creates a configurator entry array object which is to be returned from a logic element.
createDWTable(String, Table) - Method in interface DatamartContext
 
createDWTableFromCustomerExtension(String, String) - Method in interface DatamartContext
 
createDWTableFromCustomerMaster(String) - Method in interface DatamartContext
 
createDWTableFromLookupTable(String, Long) - Method in interface DatamartContext
 
createDWTableFromProductExtension(String, String) - Method in interface DatamartContext
 
createDWTableFromProductMaster(String) - Method in interface DatamartContext
 
createDWTableFromQuery(String, DatamartContext.Query) - Method in interface DatamartContext
 
createElementNameFilter(String, Object, String...) - Method in interface PublicGroovyAPI
Creates a cross-list filter expression based on meta data.
createFolder(String) - Method in class QuoteStructure
Creates a new folder item, but does not add it to the list
createNewRevision(String) - Method in interface PublicGroovyAPI
Creates a revision of CalculableLineItemCollection (Quote, Rebate Agreement, Contract).
createParameter(InputType, String) - Method in class ConfiguratorEntry
 
createParameter(InputType, String, Date) - Method in class ConfiguratorEntry
 
createPart(String) - Method in class QuoteStructure
Creates a new "part" item but does not add it
createTable(String, Object) - Method in class TableContext
Creates a new in-memory table - eventually dropping an already existing table with same name
createTable(String, Map<String, DataType>, List<String>) - Method in class TableContext
Creates a new in-memory table - eventually dropping an already existing table with same name - based on the passed field list No data is loaded yet.
createTableFromCustomerExtension(String, String, Collection<String>) - Method in class TableContext
Creates a new in-memory table - eventually dropping an already existing table with same name - based on the customer master extension meta data.
createTableFromCustomerMaster(String, Collection<String>) - Method in class TableContext
Creates a new in-memory table - eventually dropping an already existing table with same name - based on the customer master meta data.
createTableFromLookupTable(String, Long, Collection<String>) - Method in class TableContext
Creates a new in-memory table - eventually dropping an already existing table with same name - based on a lookup table/ pricing parameter table
createTableFromProductExtension(String, String, Collection<String>) - Method in class TableContext
Creates a new in-memory table - eventually dropping an already existing table with same name - based on the product master extension meta data.
createTableFromProductMaster(String, Collection<String>) - Method in class TableContext
Creates a new in-memory table - eventually dropping an already existing table with same name - based on the product master meta data.
createTableFromQuery(String, DatamartContext.Query) - Method in class TableContext
Creates a new in-memory table - eventually dropping an already existing table with same name - based on the query definition fields.
createTableFromQueryResult(String, DatamartQueryResultImpl) - Method in class TableContext
Creates a new in-memory table - eventually dropping an already existing table with same name - based on the query result fields.
createTableFromSearch(String, Search, String) - Method in class TableContext
 
criticalAlert(String) - Method in interface PublicGroovyAPI
Marks the current logic element as a critical alert and provides the given message.
currentContext(String) - Method in interface PublicGroovyAPI
In case of list processing (such as a price list or price grid), this method allows an easy access to values from the same list.
currentContext(String, String) - Method in interface PublicGroovyAPI
In case of list processing (such as a price list or price grid), this method allows an easy access to values from the same list.
currentItem() - Method in interface PublicGroovyAPI
In case of a list processing operation, this method gets the currently worked on record (e.g., price list item or price grid item or quote item).
currentItem(String) - Method in interface PublicGroovyAPI
Same as PublicGroovyAPI.currentItem() but returns only the specified attribute.
currentItemByElementName(String) - Method in interface PublicGroovyAPI
In case of a list processing operation, this method gets the currently worked on record's property by elementName.
currentPartitionName() - Method in interface PublicGroovyAPI
Returns the current partition name.
custom(String) - Static method in class Filter
Create a new Filter using a custom JPQL/HQL expression.
custom(String, Object...) - Static method in class Filter
Create a new Filter using a custom JPQL/HQL expression.
custom(String, Collection<?>) - Static method in class Filter
Create a new Filter using a custom JPQL/HQL expression.
customer(String) - Method in interface PublicGroovyAPI
Retrieves the customer object for the SKU currently being calculated.
customer(String, boolean) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax "Customer" function.
customer(String, String) - Method in interface PublicGroovyAPI
Retrieves the given attribute value from the customer table for the SKU being calculated.
customer(String, String, boolean) - Method in interface PublicGroovyAPI
Retrieves the given attribute value of the given customer.
customer(String, String, boolean, String, Object) - Method in interface PublicGroovyAPI
Retrieves a named attribute value of the named customer (if the value is null and defaultFromParent is true, retrieves (and returns) the value from the customer's parent regardless if that value is null as well or not.
customerExtension(String, Filter...) - Method in interface PublicGroovyAPI
Retrieves a list of all customer extentions records (CX) from a CX table named extensionName
customerGroupEntry(String...) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user select a group of customers and returns the selection as a Map.
customerGroupEntry(String, String, Object) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user select a group of customers and returns the selection as a Map.
customersFilter - Variable in class AbstractChartSeries
 
customerToRelatedObjectsFilter(String, String) - Method in interface PublicGroovyAPI
Creates a filter to be applied to a search on a related object type, limiting the result to objects of the related type that have a link to the given customer.
customEvent(Object) - Method in interface PublicGroovyAPI
Sends an event of the type "CUSTOM".
customEvent(Object, String) - Method in interface PublicGroovyAPI
Sends an event of the type "CUSTOM".
customEvent(Object, String, String) - Method in interface PublicGroovyAPI
Sends an event of the type "CUSTOM".
customEvent(Object, String, String, boolean) - Method in interface PublicGroovyAPI
Sends an event of the type "CUSTOM".

D

DashboardApi - Interface in net.pricefx.server.dto.calculation.dashboard
 
DashboardController - Class in net.pricefx.server.dto.calculation
This class is used to generate the definition of a so called controller dashboard portlet (or wizard).
DashboardController() - Constructor for class DashboardController
 
DashboardController.ControllerItem - Class in net.pricefx.server.dto.calculation
 
DashboardController.ControllerItemType - Enum in net.pricefx.server.dto.calculation
 
DataLoadAction<ATTACHEDTO extends Help> - Class in net.pricefx.common.apibuilder.calculationflowaction
This action starts calculation of selected data load.
DataLoadAction(ATTACHEDTO, Invocations<MethodInvocationRecord>, String, String, String) - Constructor for class DataLoadAction
 
dataMap - Variable in class WorkflowInfo
Extra data that is generated and filled by the workflow formula (optionally) to be used e.g.
datamartCalendar() - Method in interface PublicGroovyAPI
Deprecated.
DatamartContext - Interface in net.pricefx.formulaengine
Provides an API to query and load PA data from a formula context.
DatamartContext.Calendar - Interface in net.pricefx.formulaengine
Helper class mainly, but not solely, for working with dates and time periods as used in the PA module.
DatamartContext.DataLoader - Interface in net.pricefx.formulaengine
API for DataFeed loading from a formula context.
DatamartContext.DataProfilerResult - Interface in net.pricefx.formulaengine
 
DatamartContext.DataSlice - Interface in net.pricefx.formulaengine
A DataSlice defines a set of filters to be applied to a PA DataSet (Datamart, DataSource...).
DatamartContext.Query - Interface in net.pricefx.formulaengine
API for building a PA query in a formula context.
datamartFilter(Object) - Method in interface PublicGroovyAPI
Translates a CustomerGroup/ProductGroup/DMDataSlice to its equivalent filter representation, mapping the domain level field names to the corresponding Datamart field names in the process.
datamartFilterBuilderUserEntry(String, String, Object...) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user build a filter for a given Datamart.
datamartLookup(Object...) - Method in interface PublicGroovyAPI
Deprecated.
Use DatamartContext.executeQuery(DatamartContext.Query), net.pricefx.formulaengine.DatamartContext#executeSqlQuery(String, DatamartContext.Query...) or DatamartContext.streamQuery(DatamartContext.Query)
datamartQuery(Object...) - Method in interface PublicGroovyAPI
DatamartQueryResult - Interface in net.pricefx.formulaengine
Provides access to a QueryResult in a formula context.
DataTableAdditionalMeasure(DataTableChart.DataTableSeries, String) - Constructor for class DataTableChart.DataTableAdditionalMeasure
 
DataTableChart - Class in net.pricefx.common.apibuilder.chart
Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at https://api.highcharts.com/class-reference/Highcharts.Chart.
DataTableChart(IdGenerator, Invocations<MethodInvocation>) - Constructor for class DataTableChart
 
DataTableChart.DataTableAdditionalMeasure - Class in net.pricefx.common.apibuilder.chart
 
DataTableChart.DataTableOptions - Class in net.pricefx.common.apibuilder.chart
 
DataTableChart.DataTableSeries - Class in net.pricefx.common.apibuilder.chart
 
DataTableOptions(DataTableChart, String) - Constructor for class DataTableChart.DataTableOptions
 
DataTableSeries(DataTableChart, String) - Constructor for class DataTableChart.DataTableSeries
 
dateRangeUserEntry(String) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user enter a date range (start and end date).
dateTimeUserEntry(String) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user to enter a date time value in format "dd/MM/yyyy HH:mm" (e.g.
dateUserEntry(String) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user enter a date value.
decimalUserEntry(String) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user enter a decimal value.
delete(Filter...) - Method in interface PayoutRecordManager
Delete PayoutRecords linked to the current RebateRecord, adhering to one or more optional Filter criteria
delete(String, Map<String, Object>) - Method in interface PublicGroovyAPI
Deletes an object in the collection of objects of the given type.
deleteItem(String) - Method in class CalculableLineItemCollectionBuilder
Deletes an item or folder.
DetailedTimeSeriesAdditionalMeasure(DetailedTimeSeriesChart.DetailedTimeSeriesSeries, String) - Constructor for class DetailedTimeSeriesChart.DetailedTimeSeriesAdditionalMeasure
 
DetailedTimeSeriesChart - Class in net.pricefx.common.apibuilder.chart
Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at https://api.highcharts.com/class-reference/Highcharts.Chart.
DetailedTimeSeriesChart(IdGenerator, Invocations<MethodInvocation>) - Constructor for class DetailedTimeSeriesChart
 
DetailedTimeSeriesChart.DetailedTimeSeriesAdditionalMeasure - Class in net.pricefx.common.apibuilder.chart
 
DetailedTimeSeriesChart.DetailedTimeSeriesOptions - Class in net.pricefx.common.apibuilder.chart
 
DetailedTimeSeriesChart.DetailedTimeSeriesSeries - Class in net.pricefx.common.apibuilder.chart
 
DetailedTimeSeriesOptions(DetailedTimeSeriesChart, String) - Constructor for class DetailedTimeSeriesChart.DetailedTimeSeriesOptions
 
DetailedTimeSeriesSeries(DetailedTimeSeriesChart, String) - Constructor for class DetailedTimeSeriesChart.DetailedTimeSeriesSeries
 
determineDistinctValues(Collection<String>) - Method in interface DatamartQueryResult
Adds the set of distinct values for the specified projections to the Summary map, in summary.distinctValuesFor_.
Dictionary<C extends AbstractChartBuilder<C>> - Class in net.pricefx.common.apibuilder.chart
 
Dictionary(C, String, String) - Constructor for class Dictionary
 
dimFilterEntry(String, Column) - Method in interface DatamartContext
DimFilter input parameter: renders a selection of all possible values for the given dimension field, in the FC which the column's table represents.
dimFilterEntry(String, Column, String) - Method in interface DatamartContext
DimFilter input parameter: renders a selection of all possible values for the given dimension field, in the FC which the column's table represents.
doArchive(String) - Method in class ExportAction
Notifies system that archiving for selected template should be started.
doExport(String) - Method in class ExportAction
Notifies system that export for selected template should be started.
dropTable(String) - Method in class TableContext
Drops an existing in-memory table.

E

editabilityStatus - Variable in class QuoteStructure.Item
 
emailAttachment - Variable in class WorkflowDTO.StepDTO
Signals that approvable should be exported and attached to email in the given step
emailAttachment - Variable in class WorkflowInfo.WorkflowStepInfo
Has this step attachments to be sent along the notification email?
emailAttachmentTemplateName - Variable in class WorkflowDTO.StepDTO
 
emailAttachmentTemplateName - Variable in class WorkflowInfo.WorkflowStepInfo
If emailAttachment is true, then this settings allow to use any other than default excel template
EmbeddedBoxplot(S, String) - Constructor for class ChartMeasures.EmbeddedBoxplot
 
EmbeddedBoxplot(C, String) - Constructor for class ChartOptions.EmbeddedBoxplot
 
EmbeddedBoxplot(C, String) - Constructor for class ChartSeries.EmbeddedBoxplot
 
emit(Object) - Method in interface PublicGroovyAPI
Emits an object to be consumed by an external thread.
emitPersistedObject(String) - Method in interface PublicGroovyAPI
Finds the PersistedObject with the given typedId and emits it if it exists.
emitPersistedObject(String, Long) - Method in interface PublicGroovyAPI
Finds the PersistedObject for the given type and ID and emits it if it exists.
emitRebateRecords(String, String, Filter...) - Method in interface PublicGroovyAPI
Emits the rebate records matching the given search criteria - to be consumed by a PA allocation task (a PA calculation task with a feeder formula calling this method, and a regular formula accepting each emitted RebateRecord as its currentItem context, and distributing one or more RebateRecord accruals over the set of PA rows which have contributed to those accruals in some way (by revenue, bvolume...).
entityRef(PartitionedObject) - Method in interface PublicGroovyAPI
Creates an entityRef value (usually db ID) for the given entity.
equal(String, Object) - Static method in class Filter
Create a new Filter using the == operator.
equals(Object) - Method in class Filter
 
equals(Object) - Method in class WorkflowDTO.StepDTO
 
equals(Object) - Method in class ContextParameter
 
evalExpression(String) - Method in interface PublicGroovyAPI
Evaluates an arithmetic expression that is passed as a String.
eventName - Variable in class AbstractChartEvent.TriggerEvent
 
exclude(CustomerGroup) - Method in interface DatamartContext.DataSlice
 
exclude(ProductGroup) - Method in interface DatamartContext.DataSlice
 
exclude(CalendarUtil.TimePeriod) - Method in interface DatamartContext.DataSlice
 
executedByNames - Variable in class WorkflowInfo.WorkflowStepInfo
Approved by user(s) : user names for easier display
executedByUsers - Variable in class WorkflowInfo.WorkflowStepInfo
Approved by user(s)
executeQuery(DatamartContext.Query) - Method in interface DatamartContext
Executes the given DatamartContext.Query.
executeQuery(String) - Method in class TableContext
 
executeQuery(Query) - Method in class TableContext
 
executeSqlQuery(String, Object...) - Method in interface DatamartContext
Executes an ANSI compliant SQL SELECT statement in the PA DB.
Important note: a non-compliant statement that does not fail at the present time, may well fail in future releases.
The DB schema that can be queried is constructed on the fly by means of view definitions.
executeUpdate(String) - Method in class TableContext
Execute non-select queries like UPDATE,INSERT, etc
executionStatus - Variable in class WorkflowInfo.WorkflowStepInfo
The status of the step Can be: INITIALIZED, PREEXECUTED, EXECUTED_DENIED, EXECUTED_APPROVED, EXECUTED_WITHDRAWN, ALREADY_SATISFIED
ExportAction<ATTACHEDTO extends Help> - Class in net.pricefx.common.apibuilder.calculationflowaction
This action starts exporting or archiving.
ExportAction(ATTACHEDTO, Invocations<MethodInvocationRecord>, String) - Constructor for class ExportAction
 
Expression<O extends ObjectIdentity> - Class in net.pricefx.common.apibuilder.chart
 
Expression(O, String, String) - Constructor for class Expression
 
extraCSS - Variable in class ResultMatrix.ResultMatrixStyledCell
 

F

FieldFormatType - Enum in net.pricefx.common.api
 
fieldSelectionEntry(String, Table, String) - Method in interface DatamartContext
FC field selector, optionally limited to fields of a given type.
fieldSelectionEntry(String, Table, String, Boolean) - Method in interface DatamartContext
FC field selector, optionally limited to fields of a given type.
fieldSelectionEntry(String, String) - Method in interface DatamartContext
 
fieldSelectionEntry(String, String, Collection<String>, Boolean) - Method in interface DatamartContext
 
Filter - Class in com.googlecode.genericdao.search
A Filter is used by the Search class to specify a restriction on what results should be returned in the search.
Filter() - Constructor for class Filter
 
Filter(String, Object, int) - Constructor for class Filter
 
Filter(String, Object) - Constructor for class Filter
 
Filter(Map<String, ?>) - Constructor for class Filter
 
filter(String, Object) - Method in interface PublicGroovyAPI
Deprecated.
filter(String, Object, Object) - Method in interface PublicGroovyAPI
Deprecated.
Use the Filter functions instead
filterBuilderUserEntry(String, String) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user build a filter for a table of objects of the type defined by typeCode parameter.
filterFromMap(Map<String, Object>) - Method in interface PublicGroovyAPI
Constructs a Filter object from the map representation of that filter (from the "wire format").
FilterOperator - Enum in net.pricefx.common.api.chart
 
filters - Variable in class AbstractChartSeries
 
Filters<O extends ObjectIdentity> - Class in net.pricefx.common.apibuilder.chart
 
Filters(O, String, String) - Constructor for class Filters
 
find(Filter...) - Method in interface PayoutRecordManager
Retreive PayoutRecords linked to the current RebateRecord, adhering to one or more optional Filter criteria
find(String, Filter...) - Method in interface PublicGroovyAPI
Deprecated.
use PublicGroovyAPI.find(String, int, int, String, List, Filter...) in order to always specify the fields to be returned because of performance.
find(String, int, Filter...) - Method in interface PublicGroovyAPI
Deprecated.
use PublicGroovyAPI.find(String, int, int, String, List, Filter...) because of performance you should always specify the fields to be returned.
find(String, int, String, Filter...) - Method in interface PublicGroovyAPI
Deprecated.
use PublicGroovyAPI.find(String, int, int, String, List, Filter...) because of performance you should always specify the fields to be returned.
find(String, int, int, String, Filter...) - Method in interface PublicGroovyAPI
The Swiss army knife method of the API.
find(String, int, int, String, List<String>, Filter...) - Method in interface PublicGroovyAPI
The Swiss army knife method of the API.
find(String, int, int, String, List<String>, boolean, Filter...) - Method in interface PublicGroovyAPI
The Swiss army knife method of the API.
find(String, int, int, String, Map<String, String>, boolean, Filter...) - Method in interface PublicGroovyAPI
The Swiss army knife method of the API.
findAllWithContractTermTypeUN(String) - Method in class ContractHelper
 
findAllWithSKU(String) - Method in class QuoteHelper
Retrieves a list of all line items that are for a particular sku
findApprovedPricelistItems(String) - Method in interface PublicGroovyAPI
Returns a list of summary items.
findCalculatedFieldSets(Date, String) - Method in interface PublicGroovyAPI
Returns a list of calculated field sets that match the targetDate.
findCustomerAssignments(String) - Method in interface PublicGroovyAPI
Finds all assignment records for the given customerId.
findCustomersInGroup(CustomerGroup) - Method in interface PublicGroovyAPI
Retrieves a list of customers that match the given CustomerGroup (returns first 200 entries).
findCustomersInGroup(CustomerGroup, int, String) - Method in interface PublicGroovyAPI
Retrieves a list of customers that match the given CustomerGroup with custom paging and sorting.
findDataLoad(String, String, String) - Method in interface PublicGroovyAPI
 
findLookupTable(String) - Method in interface PublicGroovyAPI
Finds a price parameter table object (LT) of the given name.
findLookupTableValues(String, Filter...) - Method in interface PublicGroovyAPI
Returns all values of a named price parameter table (optionally filtered).
findManualPricelists(Date, String) - Method in interface PublicGroovyAPI
Returns a list of manual price lists that match the targetDate (i.e.
findNextRevUNs(String, String...) - Method in interface PublicGroovyAPI
Finds the next revision uniqueNames for the given Quotes/Contracts/RebateAgreements.
findPreviousApprovableState(String, String...) - Method in interface PublicGroovyAPI
Finds the previous approvable entity state if some DENIED or WITHDRAWN workflow for the approvable exists.
findPreviousWorkflowInfo(String, String...) - Method in interface PublicGroovyAPI
Finds the approvable entity previous workflow history if some DENIED or WITHDRAWN workflow for the approvable exists.
findPriceGrids(Date, String) - Method in interface PublicGroovyAPI
Returns a list of price grids that match the targetDate (i.e.
findPricelists(Date, String) - Method in interface PublicGroovyAPI
Returns a list of price lists that match the targetDate (i.e.
findRebateRecordLoad(String) - Method in interface PublicGroovyAPI
 
findRow(String, Object) - Method in class ResultMatrix
Retrieves a particular row based on a value check
findSimulations(Date, String) - Method in interface PublicGroovyAPI
Returns a list of simulations that match the targetDate (i.e.
findWorkflowInfo(String, Object) - Method in interface PublicGroovyAPI
Finds active workflows for the given approvable.
flush() - Method in interface DatamartContext.DataLoader
Flushes the data to the DB.
fontweight - Variable in class ResultMatrix.ResultMatrixStyledCell
 
formatNumber(String, Object) - Method in interface PublicGroovyAPI
Formats a number as a String.
formatNumber(String, String, Object) - Method in interface PublicGroovyAPI
Formats a number as a String.
formatString(String, String, Object...) - Method in interface PublicGroovyAPI
Formula<S extends AbstractChartSeries<?,S>> - Class in net.pricefx.common.apibuilder.chart
 
Formula(S, String, String) - Constructor for class Formula
 
fromExisting(String) - Method in class RATBuilder
 
fromListOfMaps(Collection<Map<String, Object>>) - Static method in interface Matrix2D
 
fromMap(Map<String, Object>) - Method in class WorkflowDTO.ApprovalStepDTO
 
fromMap(Map<String, Object>) - Method in class WorkflowDTO.StepDTO
 
fromMap(Map<String, Object>) - Method in class WorkflowDTO.WatcherStepDTO
 
fromParams(Map) - Method in class RATBuilder
 
fromResultMatrix(ResultMatrix) - Static method in interface Matrix2D
 

G

generateQuerySQL(PersistedObjectService, String, String, T) - Method in class ItemSummaryQuery
 
get(String) - Static method in enum FieldFormatType
 
get() - Method in interface IRebateRecordManager
Get the RR with the default name linked to the current RA.lineitem
get(String) - Method in interface IRebateRecordManager
Get the RR with the given name linked to the current RA.lineitem
get(String, String) - Method in interface IRebateRecordManager
In the given RR-set, get the RR with the given name linked to the current RA.lineitem
get(String, String) - Method in interface PayoutRecordManager
Retreives the payout record, if any, with the given type and name, linked to the current RebateRecord.
get() - Method in interface StreamResults
Retrieves the current row, which depending on the query executed could be anything from a PersistedObject to a map of (field,value) pairs to a single primitive value.
getAccumCount(double) - Method in class AdaptiveHistogram
Returns the cumulative density function for a given data point.
getActions() - Method in class CalculationFlowActionBuilder
 
getAddUnknownValues() - Method in class ContextParameter
 
getAggregation() - Method in class WaterfallChart.WaterfallSeries
 
getAggregation() - Method in class WaterfallComparisonChart.WaterfallComparisonSeries
 
getAggregationMode() - Method in class ItemSummaryQuery.Projection
 
getAll() - Method in interface IRebateRecordManager
Get all RRs linked to the the current agreement (via RR --> RLI --> RBA).
getAll(String) - Method in interface IRebateRecordManager
Get all RRs linked to the line item with the given lineID in the current agreement (via RR --> RLI).
getAllItemsFilter(T) - Method in class ItemSummaryQuery
 
getAlreadySatisfiedComment() - Method in class WorkflowDTO.StepDTO
 
getAlwaysEditable() - Method in class ContextParameter
 
getApprovalDatePartitionDefaultTZ() - Method in class WorkflowInfo.WorkflowStepInfo
Date of approval, partition default timezone
getApprovalRequiredEmailAttachments() - Method in class WorkflowDTO.ApprovalStepDTO
 
getApprover() - Method in class WorkflowDTO.ApprovalStepDTO
Deprecated.
Return the current approver in case of single approver set (or null if none set or if group approval)
getApprovers() - Method in class WorkflowDTO.ApprovalStepDTO
Return the current approvers (or null if none set or if group approval)
getAttribute(String) - Method in class AttributedResult
 
getAttributeName(String) - Method in interface ClaimContext
Get name of the attribute based on Claim Type configuration to which the column gets persisted
getAttributes() - Method in class AttributedResult
 
getBaseTemplateToUse() - Method in class ResultFlexChart
 
getBaseURL() - Method in interface PublicGroovyAPI
Returns the base URL component of the current instance.
getBatchInfo() - Method in interface PublicGroovyAPI
Gets the info about the current batch of items being calculated by a calcuation thread.
getBinding(String) - Method in interface PublicGroovyAPI
Gets a named binding variable from a library function.
getBoundPartitionNames() - Method in interface PublicGroovyAPI
Returns a bound partition list.
getCalculableLineItem(Object, String) - Method in interface PublicGroovyAPI
Returns a line item of the given calculable line item collection (CLIC).
getCalculableLineItemCollection(String) - Method in interface PublicGroovyAPI
Returns the full object (header and line items) of e.g.
getCalculableLineItemResult(Object, String...) - Method in interface PublicGroovyAPI
Returns results of the given names (or labels) from a line item object (its map representation).
getCalculate() - Method in class CFSAction
 
getCalculate() - Method in class DataLoadAction
 
getCalculate() - Method in class LivePriceGridAction
 
getCalculate() - Method in class ManualPricelistAction
 
getCalculate() - Method in class PricelistAction
 
getCalculate() - Method in class RebateRecordAction
 
getCalculate() - Method in class SimulationAction
 
getCalculationContext() - Method in interface PublicGroovyAPI
Retrieves the CalculationContext of the logic evaluation (logic element group).
    For a PA Calculation or Flush logic this can be (from PriceFxInterface): FORMULAELEMENTGROUP_DM_INIT = "init" - executed before rows FORMULAELEMENTGROUP_DM_ROW = "row" - executed for every line of the Target/Source FORMULAELEMENTGROUP_DM_SUMMARY = "summary" - executed after rows In RebateAgreement calculation there is: FORMULAELEMENTGROUP_RM_AGREEMENT = "agreement" FORMULAELEMENTGROUP_RM_AGREEMENT_READONLY = "agreementReadOnly" FORMULAELEMENTGROUP_RM_REBATERECORD = "rebateRecord" In the Optimizer module, when evaluating Model formulas, there is: FORMULAELEMENTGROUP_MODEL_DEFINITION = "definition" FORMULAELEMENTGROUP_MODEL_CALCULATION = "calculation" FORMULAELEMENTGROUP_MODEL_ANALYSIS = "analysis" FORMULAELEMENTGROUP_MODEL_FINALIZATION = "finalization" FORMULAELEMENTGROUP_MODEL_RECORD = "record"
getCfsLabel() - Method in class CFSAction
 
getChartDefinition() - Method in class ResultHighchart
Not intended for public use, required for JSON serialization.
getClaimContext() - Method in interface PublicGroovyAPI
Gives current item context in claim validation
getClientSideDistinctName() - Method in class ItemSummaryQuery.Projection
Client side distinct name.
getColumn(String) - Method in interface Matrix2D
 
getColumnCount() - Method in interface Matrix2D
 
getColumnDataType(String) - Method in interface Matrix2D
 
getColumnFormats() - Method in class ResultMatrix
Gets individual column formats (if specified)
getColumnLabel(long) - Method in interface Matrix2D
 
getColumnLabels() - Method in interface Matrix2D
 
getColumns(Collection<String>) - Method in interface Matrix2D
 
getColumns() - Method in class ResultMatrix
Gets a list of defined columns
getColumnTooltips() - Method in class ResultMatrix
Gets the currently assigned column tooltips
getColumnTranslations() - Method in class ResultMatrix
Gets current column translations in raw format
getColumnValues(long) - Method in interface Matrix2D
 
getContractView() - Method in class ContractBuilder
 
getCount(double) - Method in class AdaptiveHistogram
Returns the number of data points stored in the same bucket as a given value.
getCountPerNodeLimit() - Method in class AdaptiveHistogram
This method is used by the internal data structure of the histogram to get the limit of data points that should be counted at one bucket.
getCumulativeDistributionValue(long, BigDecimal) - Method in interface Matrix2D
Determines the total number of values (samples) smaller or equal to the given value, in the given numeric column.
getData() - Method in interface DatamartQueryResult
Retreives the query result data.
getDataContext() - Method in class TableContext
 
getDataFeed(String) - Method in interface DatamartContext
Get a table object representing the DataFeed with the given name.
getDataHeaders() - Method in class ResultHighchart
Not intended for public use, required for JSON serialization.
getDataLoadLabel() - Method in class DataLoadAction
 
getDataLoadType() - Method in class DataLoadAction
 
getDataMap() - Method in class WorkflowDTO
 
getDatamart(String) - Method in interface DatamartContext
Get a table object representing the Datamart with the given name.
getDatamartContext() - Method in interface PublicGroovyAPI
Provides an API for querying and loading PA data.
getDatamartRowSet() - Method in interface PublicGroovyAPI
Available in a PA DataLoad context only, a DatamartRowSet provides access to the rows being loaded or calculated.
getDatamartRowSet(String) - Method in interface PublicGroovyAPI
Available in a PA DataLoad context only, a DatamartRowSet provides access to the rows currently being loaded or calculated.
getDataSource(String) - Method in interface DatamartContext
Get a table object representing the DataSource with the given name.
getDateTimeFormat() - Method in class ScheduleSettings
 
getDaysDiff(String, String) - Method in interface DatamartContext.Calendar
Calculates the number of days between the start date of period1 and end date of period2 (both inclusive).
getDefaultFormat() - Method in class ResultMatrix
Gets the default format
getDefaultPostApprovalStepLogicName() - Method in class WorkflowDTO
 
getDefaultSchema() - Method in class TableContext
 
getDenialReasons() - Method in class WorkflowDTO.ApprovalStepDTO
 
getDenialReasons() - Method in class WorkflowDTO
 
getDictionary() - Method in class AbstractChartBuilder
 
getDimensions() - Method in interface DatamartContext.DataProfilerResult
 
getDistinctName() - Method in class ItemSummaryQuery.Projection
Used in SQL queries, overcomes ORACLE 32byte length identifier limit
getDistinctValues(String) - Method in interface DatamartQueryResult
Get the distinct values for a given projeciton.
getDistributedCalculationThreshold() - Method in class CFSAction
 
getDistributedCalculationThreshold() - Method in class LivePriceGridAction
 
getDistributedCalculationThreshold() - Method in class PricelistAction
 
getDistributedCalculationThreshold() - Method in class SimulationAction
 
getDWTable(String) - Method in interface DatamartContext
Get a table object representing the DWTable with the given name.
getElement(String) - Method in interface PublicGroovyAPI
Gets the result of the previous logic element.
getEmailAttachment() - Method in class WorkflowDTO.StepDTO
Retrieves the attachment sending setting
getEmailAttachmentTemplateName() - Method in class WorkflowDTO.StepDTO
 
getEmailListWatcher() - Method in class WorkflowDTO.WatcherStepDTO
Gets the list of email addresses if specified as recipient for this node
getEndDate(String) - Method in interface DatamartContext.Calendar
Returns the end date of given TimePeriod.
getEntries() - Method in class ResultMatrix
Returns the current list entries as a list (=the rows) of maps (= the row content)
getExcelPercentileValues(long) - Method in interface Matrix2D
Computes percentiles compatible with Excel
getExcelPercentRank(long, double) - Method in interface Matrix2D
Computes the rank of a value, as a percentage, in the distribution of values in the given column.
getExcludeSubmitter() - Method in class WorkflowDTO.ApprovalStepDTO
Returns status if the submitter is excluded in case of group approval
getExecute() - Method in class PriceAPIAction
 
getExecutionStatusI18n() - Method in class WorkflowInfo.WorkflowStepInfo
 
getFieldCollection(String) - Method in interface DatamartContext
Get a table object representing the FC with the given source name.
getFieldName() - Method in class ItemSummaryQuery.Projection
 
getFieldNamePrefix() - Method in class ItemSummaryQuery.Projection
 
getFilter() - Method in class ObjRefAction
 
getFilter() - Method in class ContextParameter
 
getFilters() - Method in class AbstractChartSeries
 
getFirstInput() - Method in class ConfiguratorEntry
 
getFlexChart() - Method in class ResultFlexChart
 
getGlobal() - Method in interface PublicGroovyAPI
A publicly available cache (as a hashmap) for storing and sharing values across logic elements.
getHelper() - Method in class ContractBuilder
 
getHelper() - Method in class QuoteBuilder
Gets a helper class that assists in manipulating the quote object
getHelper() - Method in class RebateAgreementBuilder
 
getId(Object) - Method in interface PublicGroovyAPI
Returns the ID part of an object.
getInputs() - Method in class ConfiguratorEntry
 
getInputType() - Method in class ContextParameter
 
getIstanceId() - Method in class RATBuilder.RABuilder
 
getItemActiveCalculationResults(String) - Method in interface PublicGroovyAPI
Gets the current complete active (i.e.
getItemCompleteCalculationResults(String) - Method in interface PublicGroovyAPI
Gets the current complete calculation results of the given item (e.g., price list item).
getItemFilter() - Method in class ItemSummaryQuery
 
getItemGroupBy() - Method in class ItemSummaryQuery
 
getItemReasons() - Method in class WorkflowDTO
 
getItems() - Method in class DashboardController
 
getItemSqlAlias() - Method in class ItemSummaryQuery
 
getItemToObjectFkName() - Method in class ItemSummaryQuery
 
getItemTypedId() - Method in class ProductReferenceRecord
 
getIterationNumber() - Method in interface PublicGroovyAPI
Returns the number of iterations this list has been calculated during this cycle.
getJobName() - Method in class ExportAction
 
getJobName() - Method in class PriceAPIAction
 
getLabel() - Method in class ContextParameter
 
getLabel() - Method in class ProductReferenceRecord
 
getLabelTranslations() - Method in class ContextParameter
 
getListId() - Method in class ProductReferenceRecord
 
getListLabel() - Method in class ProductReferenceRecord
 
getLivePriceGridLabel() - Method in class LivePriceGridAction
 
getLocale() - Method in interface PublicGroovyAPI
Returns the language part of the current request's locale (e.g.
getLookupTableId() - Method in class ContextParameter
 
getMandatoryComments() - Method in class WorkflowDTO.ApprovalStepDTO
 
getManualOverride(String) - Method in interface PublicGroovyAPI
Returns a user entered value that overrides the calculated result of a logic element.
getManualPricelistName() - Method in class ManualPricelistAction
 
getMap() - Method in interface DatamartContext.DataProfilerResult
All the results in map format, for fluent access in Groovy
getMap(String, String) - Method in interface Matrix2D
Extracts a map from the values in the nominated key and value columns.
getMap(List<String>, String) - Method in interface Matrix2D
Extracts a map from the values in the nominated key columns (resulting in keys of type MultiKey) and value columns.
getMapsList() - Method in class ResultHighmap
Not intended for public use, required for JSON serialization.
getMax() - Method in class ResultGauge
The maximum dial value.
getMaxFindResultsLimit() - Method in interface PublicGroovyAPI
Returns the maximum number of records that PublicGroovyAPI.find(String, int, int, String, Filter...) and its variations can return in one call.
getMeasures() - Method in interface DatamartContext.DataProfilerResult
 
getMessage() - Method in class ConfiguratorEntry
 
getMin() - Method in class ResultGauge
The minimum dial value.
getMinApprovalsForGroups() - Method in class WorkflowDTO.ApprovalStepDTO
 
getMinApprovalsNeeded() - Method in class WorkflowDTO.ApprovalStepDTO
 
getModel(String) - Method in interface DatamartContext
Get a table object representing the Model with the given name.
getModulesList() - Method in class ResultHighchart
Not intended for public use, required for JSON serialization.
getName() - Method in enum FilterOperator
 
getName() - Method in class ContextParameter
 
getNewNumberOfTimeUnits() - Method in class ScheduleSettings
Gets newly set number of time units.
getNewStartingDate() - Method in class ScheduleSettings
Gets newly set starting date.
getNewTimeUnit() - Method in class ScheduleSettings
Gets newly set time unit.
getNext() - Method in class ItemSummaryQuery.IDGenerator
 
getNotificationOnlyToUsers() - Method in class WorkflowDTO.ApprovalStepDTO
Returns the subset of approvers that should recieve email notification.
getNumberOfProjections() - Method in class ItemSummaryQuery
 
getNumberOfTimeUnits() - Method in class ScheduleSettings
Number of time units to next triggering of schedule.
getObjectName() - Method in class CalculationFlowActionBuilder
 
getObjectName() - Method in class CFSAction
 
getObjectName() - Method in class DataLoadAction
 
getObjectName() - Method in class ExportAction
 
getObjectName() - Method in class LivePriceGridAction
 
getObjectName() - Method in class ManualPricelistAction
 
getObjectName() - Method in class ObjRefAction
 
getObjectName() - Method in class PriceAPIAction
 
getObjectName() - Method in class PricelistAction
 
getObjectName() - Method in class RebateRecordAction
 
getObjectName() - Method in class ScheduleSettings
 
getObjectName() - Method in class SimulationAction
 
getObjectService() - Method in class ConfiguratorEntry
 
getObjectService() - Method in class ContextParameter
 
getObjectTypedIds() - Method in class ItemSummaryQuery
 
getOnRowSelectEvents() - Method in class ResultMatrix
 
getOperator() - Method in class Filter
 
getOptions() - Method in class BarLineChart
 
getOptions() - Method in class BoxplotChart
 
getOptions() - Method in class BubbleChart
 
getOptions() - Method in class DataTableChart
 
getOptions() - Method in class DetailedTimeSeriesChart
 
getOptions() - Method in class HeatmapChart
 
getOptions() - Method in class HistogramChart
 
getOptions() - Method in class PieChart
 
getOptions() - Method in class ScatterChart
 
getOptions() - Method in class TimeSeriesChart
 
getOptions() - Method in class TimeSeriesScatterChart
 
getOptions() - Method in class WaterfallChart
 
getOptions() - Method in class WaterfallComparisonChart
 
getParameter(String) - Method in interface PublicGroovyAPI
Retrieves an already generated (in the previous logic step) input parameter in the form of a ContextParameter object.
getParameterConfig() - Method in class ContextParameter
 
getParameterGroup() - Method in class ContextParameter
 
getPartition() - Method in class ObjRefAction
 
getPercentileValue(long, int) - Method in interface Matrix2D
Calculates the value at the given percentile in the given numeric column.
getPostStepLogicName() - Method in class WorkflowDTO.ApprovalStepDTO
 
getPreferenceName() - Method in class ResultMatrix
Gets the preference name
getPrefix() - Method in class ResultGauge
The label prefix.
getPriceGridSummaryQuery() - Method in interface PublicGroovyAPI
Creates a summary query object that can be parameterized and is then subsequently used in PublicGroovyAPI.runSummaryQuery(ItemSummaryQuery).
getPricelistItem(String) - Method in interface PublicGroovyAPI
Similar to the PublicGroovyAPI.pricelistItem(String) function.
getPricelistName() - Method in class PricelistAction
 
getPricelistSummaryQuery() - Method in interface PublicGroovyAPI
Creates a summary query object that can be parameterized and is then subsequently used in PublicGroovyAPI.runSummaryQuery(ItemSummaryQuery).
getPriority() - Method in class CFSAction
 
getPriority() - Method in class LivePriceGridAction
 
getPriority() - Method in class ManualPricelistAction
 
getPriority() - Method in class PricelistAction
 
getPriority() - Method in class SimulationAction
 
getProductFilter() - Method in class ItemSummaryQuery
 
getProductGroupBy() - Method in class ItemSummaryQuery
 
getProductReferences(String, Set<String>) - Method in interface PublicGroovyAPI
Returns a list of product reference records that tell which other objects, of the given type, reference these SKUs.
getProjectionName(ItemSummaryQuery.Projection) - Method in class ItemSummaryQuery
 
getProjections() - Method in class ItemSummaryQuery
 
getProjectionSQL(PersistedObjectService, T) - Method in class ItemSummaryQuery
 
getProperties() - Method in class WorkflowDTO.StepDTO
 
getProperty() - Method in class Filter
 
getProperty(Object, String) - Method in interface PublicGroovyAPI
Serves as an optimized way to get to certain object attributes.
getPropertyByElementName(Object, String) - Method in interface PublicGroovyAPI
Gets object attributes by elementName.
getQuoteView() - Method in class QuoteBuilder
Gets the full quote object as a nested map
getReadOnly() - Method in class ContextParameter
 
getReason() - Method in class WorkflowDTO.ApprovalStepDTO
Deprecated.
getReason() - Method in class WorkflowDTO.WatcherStepDTO
Deprecated.
getReason() - Method in class WorkflowInfo.WorkflowStepInfo
Deprecated.
getReasons() - Method in class WorkflowDTO.ApprovalStepDTO
Returns the reasons text
getReasons() - Method in class WorkflowDTO.WatcherStepDTO
Returns the reason text
getRebateAgreementView() - Method in class RebateAgreementBuilder
 
getRebateRecordSetCalculationLabel() - Method in class RebateRecordAction
 
getRebateRecordSummaryQuery() - Method in interface PublicGroovyAPI
Creates a summary query object that can be parameterized and is then subsequently used in PublicGroovyAPI.runSummaryQuery(ItemSummaryQuery).
getRestrictToSkus() - Method in class LivePriceGridAction
 
getResult(String) - Method in interface IRebateRecordManager
Get the formula element result for the RR with the default name linked to the current RA.lineitem
getResult(String, String) - Method in interface IRebateRecordManager
Get the formula element result for the RR with the given name linked to the current RA.lineitem
getResult(String, String, String) - Method in interface IRebateRecordManager
In the given RR-set, get the formula element result for the RR with the given name linked to the current RA.lineitem
getResult() - Method in class AttributedResult
 
getResult() - Method in class WrappedResult
 
getResultMatrixList() - Method in class ResultHighchart
Not intended for public use, required for JSON serialization.
getResultType() - Method in class ConfiguratorEntry
 
getResultType() - Method in class DashboardController
 
getResultType() - Method in class ResultFlexChart
 
getResultType() - Method in class ResultGauge
 
getResultType() - Method in class ResultHighchart
 
getResultType() - Method in class ResultHighmap
 
getResultType() - Method in class ResultMatrix
 
getRollup(String) - Method in interface DatamartContext
Get a table object representing the FC representing the rollup with the given label.
getRow() - Method in interface ClaimContext
Get parsed row from excel claim input.
getRowCount() - Method in interface Matrix2D
 
getRowValues(long) - Method in interface Matrix2D
 
getRunDefaultPostApprovalStepLogicOnEmptyWorkflow() - Method in class WorkflowDTO
 
getScheduleSettings() - Method in class CalculationFlowActionBuilder
It's getting you an object that is used to obtain the schedule as seen in the UI + if needed alter it.
getSecondaryKey() - Method in interface PublicGroovyAPI
Same as api.currentItem("key2").
getSectors() - Method in class ResultGauge
 
getSeries() - Method in class HeatmapChart
 
getSeries() - Method in class HistogramChart
 
getSeries() - Method in class WaterfallChart
 
getSharedCache(String) - Method in interface PublicGroovyAPI
Retrieves a value from the shared cache (and resets the TTL of the key).
getShowDataTab() - Method in class ResultHighchart
Not intended for public use, required for JSON serialization.
getSimulationLabel() - Method in class SimulationAction
 
getSimulationSet() - Method in class ManualPricelistAction
 
getSimulationSummaryQuery() - Method in interface PublicGroovyAPI
Creates a summary query object that can be parameterized and is then subsequently used in PublicGroovyAPI.runSummaryQuery(ItemSummaryQuery).
getSku() - Method in class ProductReferenceRecord
 
getStartDate(String) - Method in interface DatamartContext.Calendar
Returns the start date of given TimePeriod.
getStartingDate() - Method in class ScheduleSettings
Starting date and time of the associated formula
getStep(String) - Method in class WorkflowDTO
Retrieves a named step (if existing)
getSteps() - Method in class InsertWorkflowStepsDTO
 
getSteps() - Method in class WorkflowDTO
 
getSubmitReason() - Method in class WorkflowDTO
Gets reason entered by submitter
getSuffix() - Method in class ResultGauge
 
getSummary() - Method in interface DatamartQueryResult
Additional query summary information,
getTable() - Method in interface DatamartContext.Query
 
getTable(String) - Method in class TableContext
 
getTableContext() - Method in interface PublicGroovyAPI
Provides an SQL query (SELECT only) interface to PA query results.
getTables() - Method in class TableContext
 
getTarget() - Method in class DataLoadAction
 
getTargetObjectTypeCode() - Method in class ProductReferenceRecord
 
getTemplateName() - Method in class ExportAction
 
getThis() - Method in class AbstractChartBuilder
 
getThis() - Method in class AbstractChartEvent
 
getThis() - Method in class AbstractChartEvent.TriggerEvent
 
getThis() - Method in class AbstractChartMeasures
 
getThis() - Method in class AbstractChartOptions
 
getThis() - Method in class AbstractChartSeries
 
getTimePeriod(String) - Method in interface DatamartContext.Calendar
Returns the TimePeriod object matching its string representation.
getTimePeriodByDate(String, String) - Method in interface DatamartContext.Calendar
Parses a date, as well as a named TimeUnit, resulting in a TimePeriod with that unit that encompasses the given date.
getTimePeriodNames(String, String, String) - Method in interface DatamartContext.Calendar
Useful for constructing Options lists (user entry/input parameters).
getTimePeriods(String, String, String) - Method in interface DatamartContext.Calendar
Same as above but now returning a list of TimePeriod objects, rather than the corresponding period names.
getTimePeriods(Date, Date, CalendarUtil.TimeUnit) - Method in interface DatamartContext.Calendar
 
getTimeUnit() - Method in class ScheduleSettings
Gets you time unit as seen in the UI.
getTimeZone(String) - Method in interface PublicGroovyAPI
Provides a wrapper for org.joda.time.DateTimeZone.forId(String tzString) method.
getTitle() - Method in class ResultMatrix
Gets the current title
getTotalRows() - Method in class TableContext
Returns the total row count over all used in-memory tables.
getTraitType() - Method in class ScheduleSettings
 
getType() - Method in class WorkflowDTO
Returns the type of the workflow.
getType() - Method in class ContextParameter
 
getTypeCode() - Method in class ObjRefAction
 
getTypedId() - Method in class WorkflowDTO
 
getTypedId() - Method in class ContextParameter
 
getUniqueName() - Method in class WorkflowDTO.StepDTO
Gets the name of the step
getURL() - Method in class ContextParameter
 
getUserApprover() - Method in class WorkflowInfo.WorkflowStepInfo
Deprecated.
getUserGroupApprover() - Method in class WorkflowDTO.ApprovalStepDTO
Deprecated.
Gets user group name in case of single group approval (or null otherwise)
getUserGroupApprover() - Method in class WorkflowInfo.WorkflowStepInfo
Deprecated.
getUserGroupApprovers() - Method in class WorkflowDTO.ApprovalStepDTO
Gets user group names in case of group approval (or null otherwise)
getUserGroupWatcher() - Method in class WorkflowDTO.WatcherStepDTO
Deprecated.
Gets user group name in case of group watcher (or null otherwise)
getUserGroupWatchers() - Method in class WorkflowDTO.WatcherStepDTO
Gets user group names in case of group watchers (or null otherwise)
getUserWatcher() - Method in class WorkflowDTO.WatcherStepDTO
Deprecated.
Return the current watcher (or null if none set or if group watcher)
getUserWatchers() - Method in class WorkflowDTO.WatcherStepDTO
Return the current watchers (or null if none set or if group watchers)
getValidAfter() - Method in class ManualPricelistAction
 
getValue() - Method in class Filter
 
getValue() - Method in enum WaterfallColumnType
 
getValue() - Method in interface Matrix2D
Convenience getter of values in the matrix.
getValue(long, long) - Method in interface Matrix2D
 
getValue() - Method in class ContextParameter
 
getValue() - Method in class ResultGauge
The current value on the dial.
getValueForPercentile(int) - Method in class AdaptiveHistogram
Returns the data point that splits the data set at a given percentile.
getValueHint() - Method in class ContextParameter
 
getValueOptions() - Method in class ContextParameter
 
getValuesAsCollection() - Method in class Filter
Returns the value as a Collection, converting if necessary.
getValuesAsList() - Method in class Filter
Returns the value as a List, converting if necessary.
getViaName(String) - Static method in enum FilterOperator
 
getViaValue(String) - Static method in enum WaterfallColumnType
 
getWeight() - Method in class ItemSummaryQuery.Projection
 
greaterOrEqual(String, Object) - Static method in class Filter
Create a new Filter using the >= operator.
greaterThan(String, Object) - Static method in class Filter
Create a new Filter using the > operator.

H

hashCode() - Method in class Filter
 
hashCode() - Method in class WorkflowDTO.StepDTO
 
hashCode() - Method in class ContextParameter
 
having(String...) - Method in interface DatamartContext.Query
Parses and ANDs one or more SQL-like conditions to the query's HAVING clause.
having(Filter...) - Method in interface DatamartContext.Query
Adds generic Filters to the query's HAVING clause.
HeatmapAdditionalMeasure(HeatmapChart.HeatmapSeries, String) - Constructor for class HeatmapChart.HeatmapAdditionalMeasure
 
HeatmapChart - Class in net.pricefx.common.apibuilder.chart
Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at https://api.highcharts.com/class-reference/Highcharts.Chart.
HeatmapChart(IdGenerator, Invocations<MethodInvocation>) - Constructor for class HeatmapChart
 
HeatmapChart.HeatmapAdditionalMeasure - Class in net.pricefx.common.apibuilder.chart
 
HeatmapChart.HeatmapInterpolatedColorAxis - Class in net.pricefx.common.apibuilder.chart
 
HeatmapChart.HeatmapOptions - Class in net.pricefx.common.apibuilder.chart
 
HeatmapChart.HeatmapRangedColorAxis - Class in net.pricefx.common.apibuilder.chart
 
HeatmapChart.HeatmapSeries - Class in net.pricefx.common.apibuilder.chart
 
HeatmapInterpolatedColorAxis(HeatmapChart.HeatmapOptions, String, String) - Constructor for class HeatmapChart.HeatmapInterpolatedColorAxis
 
HeatmapOptions(HeatmapChart, String) - Constructor for class HeatmapChart.HeatmapOptions
 
HeatmapRangedColorAxis(HeatmapChart.HeatmapOptions, String, String) - Constructor for class HeatmapChart.HeatmapRangedColorAxis
 
HeatmapSeries(HeatmapChart, String) - Constructor for class HeatmapChart.HeatmapSeries
 
HistogramAdditionalMeasure(HistogramChart.HistogramSeries, String) - Constructor for class HistogramChart.HistogramAdditionalMeasure
 
HistogramChart - Class in net.pricefx.common.apibuilder.chart
Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at https://api.highcharts.com/class-reference/Highcharts.Chart.
HistogramChart(IdGenerator, Invocations<MethodInvocation>) - Constructor for class HistogramChart
 
HistogramChart.HistogramAdditionalMeasure - Class in net.pricefx.common.apibuilder.chart
 
HistogramChart.HistogramOptions - Class in net.pricefx.common.apibuilder.chart
 
HistogramChart.HistogramSeries - Class in net.pricefx.common.apibuilder.chart
 
HistogramOptions(HistogramChart, String) - Constructor for class HistogramChart.HistogramOptions
 
HistogramSeries(HistogramChart, String) - Constructor for class HistogramChart.HistogramSeries
 
httpCall(String, String) - Method in interface PublicGroovyAPI
Issues an HTTP call to an external entity.
httpCall(String, String, String, String, Map...) - Method in interface PublicGroovyAPI
Issues an HTTP call to an external entity.

I

IDGenerator(String) - Constructor for class ItemSummaryQuery.IDGenerator
 
ilike(String, String) - Static method in class Filter
Create a new Filter using the ILIKE operator.
imageCell(Object) - Method in class ResultMatrix
Creates an image cell that can then be added as row value.
in(String, Collection<?>) - Static method in class Filter
Create a new Filter using the IN operator.
in(String, Object...) - Static method in class Filter
Create a new Filter using the IN operator.
include(CustomerGroup) - Method in interface DatamartContext.DataSlice
 
include(ProductGroup) - Method in interface DatamartContext.DataSlice
 
include(CalendarUtil.TimePeriod) - Method in interface DatamartContext.DataSlice
 
indexOfMax() - Method in interface Matrix2D
 
indexOfMin() - Method in interface Matrix2D
 
inlineConfigurator(String, String) - Method in interface PublicGroovyAPI
 
input(String) - Method in interface PublicGroovyAPI
Retrieves the value of the input parameter of the given name.
inputMatrix(String, String...) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user select a matrix of values.
inputMatrix(String, Map<String, Object>, String...) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user select a matrix of values.
inputs - Variable in class QuoteStructure.Item
 
insertApprovalStep(String) - Method in class InsertWorkflowStepsDTO
Inserts an approval step right after workflow post logic step that is executing this code.
insertWatcherStep(String) - Method in class InsertWorkflowStepsDTO
Inserts a watcher step right after workflow post logic step that is executing this code.
InsertWorkflowStepsDTO - Class in net.pricefx.common.dto
 
InsertWorkflowStepsDTO() - Constructor for class InsertWorkflowStepsDTO
 
integerUserEntry(String) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user enter an integer value.
invokeAddAdditionalMeasure() - Method in class AbstractChartSeries
 
invokeAddSeries() - Method in class AbstractChartBuilder
 
invokeGetOptions() - Method in class AbstractChartBuilder
 
invokeGetSeries() - Method in class AbstractChartBuilder
 
IRebateRecordManager - Interface in net.pricefx.formulaengine
The RebateRecordManager API is exposed to formula groovy elements in two separate contexts: 1) in a RebateAgreement calculation (typeCode='RBA' aka RA), when the formula context's 'currentItem' would be an individual line item (typeCode='RBLI' aka RLI) 2) in a RebateAgreement 'read-only' evaluation (when opening an uneditable RA); currentItem is again a RLI 3) in a RebateRecordSet calculation, the formula context's 'currentItem' would be an individual RebateRecord (typeCode='RR') The API can be accessed via the 'rebateRecords' Groovy binding.
isActiveStep - Variable in class WorkflowInfo.WorkflowStepInfo
Is the this step active?
isAddStepRestrictedToWFAdmin() - Method in class WorkflowDTO
 
isAlreadySatisfied() - Method in class WorkflowInfo.WorkflowStepInfo
 
isApprovalStep() - Method in class WorkflowInfo.WorkflowStepInfo
 
isApproved() - Method in class WorkflowInfo.WorkflowStepInfo
 
isArchive() - Method in class ExportAction
 
isAutoConvertToDeal() - Method in class WorkflowDTO
 
isChartType(String) - Static method in enum ChartType
 
isCustomerParam() - Method in class ContextParameter
 
isDebugMode() - Method in interface PublicGroovyAPI
Returns true if the logic is called via the UI debug/test execution mode.
isDenialReasonOptional() - Method in class WorkflowDTO.ApprovalStepDTO
 
isDenialReasonOptional() - Method in class WorkflowDTO
 
isDenied() - Method in class WorkflowInfo.WorkflowStepInfo
 
isDistributedMode() - Method in interface PublicGroovyAPI
Returns true if the calculation is executed in the distributed mode.
isDoCount() - Method in class ItemSummaryQuery
 
isDualGroupBy() - Method in class ItemSummaryQuery
 
isEmailWatcher - Variable in class WorkflowInfo.WorkflowStepInfo
 
isEmpty(String) - Static method in class Filter
Create a new Filter using the IS EMPTY operator.
isEmpty() - Method in interface Matrix2D
A matrix is empty if it has no rows.
isEnableClientFilter() - Method in class ResultMatrix
 
isEscapeHTML() - Method in class ResultMatrix
Is HTML escaping enabled?
isExport() - Method in class ExportAction
 
isFilter(Map<String, ?>) - Static method in class Filter
 
isFolder - Variable in class QuoteStructure.Item
 
isFullListCalculation() - Method in interface PublicGroovyAPI
Indicates whether the current calculation is recalculating the entire list or only parts of it.
isGroupApprover - Variable in class WorkflowInfo.WorkflowStepInfo
Is this step an approval node by a user group?
isHiddenParam() - Method in class ContextParameter
 
isInitialized() - Method in class WorkflowInfo.WorkflowStepInfo
 
isLookupType() - Method in class ContextParameter
 
isMassUpdate() - Method in class WorkflowDTO
 
isMatrixParam() - Method in class ContextParameter
 
isMultiApprovalAllowed() - Method in class WorkflowDTO.ApprovalStepDTO
 
isNewPeriodic() - Method in class ScheduleSettings
Gets newly set periodicity.
isNoGroupBy() - Method in class ItemSummaryQuery
 
isNotEmpty(String) - Static method in class Filter
Create a new Filter using the IS NOT EMPTY operator.
isNotNull(String) - Static method in class Filter
Create a new Filter using the IS NOT NULL operator.
isNull(String) - Static method in class Filter
Create a new Filter using the IS NULL operator.
isOptionParam() - Method in class ContextParameter
 
isOptionsParam() - Method in class ContextParameter
 
isPeriodic() - Method in class ScheduleSettings
If this CF item is period or not.
isPostPhase() - Method in class CalculableLineItemCollectionBuilder
Determines current calculation phase of logic execution
isPostStepLogicFailed() - Method in class InsertWorkflowStepsDTO
 
isPreExecuted() - Method in class WorkflowInfo.WorkflowStepInfo
 
isPrePhase() - Method in class CalculableLineItemCollectionBuilder
Determines current calculation phase of logic execution
isProductGroupParam() - Method in class ContextParameter
 
isProductParam() - Method in class ContextParameter
 
isRequired() - Method in class ContextParameter
 
isScheduleChangeRequested() - Method in class ScheduleSettings
 
isSecondPass() - Method in interface PublicGroovyAPI
Deprecated.
isSelectStepOnDeny() - Method in class WorkflowDTO
 
isSortingDisabled() - Method in class ResultMatrix
UI sorting of matrix grid
isStartImmediatelyTraitActive() - Method in class ScheduleSettings
 
isSyntaxCheck() - Method in interface PublicGroovyAPI
Returns true if the formula is executed in the syntax check mode.
isTakesListOfSubFilters() - Method in class Filter
 
isTakesListOfValues() - Method in class Filter
 
isTakesNoProperty() - Method in class Filter
Gets the value of the property takesNoProperty.
isTakesNoValue() - Method in class Filter
 
isTakesSingleSubFilter() - Method in class Filter
 
isTakesSingleValue() - Method in class Filter
 
isUserApprover - Variable in class WorkflowInfo.WorkflowStepInfo
Is the step a an approval node by individual user(s)?
isUserInGroup(String, String) - Method in interface PublicGroovyAPI
Checks if the current user is a member of the given user group.
isWatcherStep() - Method in class WorkflowInfo.WorkflowStepInfo
 
isWithdrawn() - Method in class WorkflowInfo.WorkflowStepInfo
 
Item() - Constructor for class QuoteStructure.Item
 
items - Variable in class QuoteStructure.Item
 
items - Variable in class QuoteStructure
The list of items to add in this level of the quote
ItemSummaryQuery<T extends HasCalculableObjectItems> - Class in net.pricefx.service
 
ItemSummaryQuery() - Constructor for class ItemSummaryQuery
 
ItemSummaryQuery(String) - Constructor for class ItemSummaryQuery
 
ItemSummaryQuery.IDGenerator - Class in net.pricefx.service
 
ItemSummaryQuery.Projection - Class in net.pricefx.service
 
ItemSummaryQuery.QueryGeneratorCallback - Interface in net.pricefx.service
 
itemTypedId - Variable in class ProductReferenceRecord
The typedId of the target (=containing) object.

J

jsonDecode(String) - Method in interface PublicGroovyAPI
A utility method to decode a JSON string into a Map representation.
jsonDecodeList(String) - Method in interface PublicGroovyAPI
A utility method to decode a JSON string into a List representation.
jsonEncode(Object) - Method in interface PublicGroovyAPI
A utility method to encode an object to a JSON string.
jsonEncode(Object, boolean) - Method in interface PublicGroovyAPI
A utility method to encode an object to a JSON string.

K

kurtosis(String) - Method in interface Matrix2D
 

L

label - Variable in class DashboardController.ControllerItem
 
label - Variable in class ProductReferenceRecord
The label of the target (=containing) object (e.g.
labelOrSku - Variable in class QuoteStructure.Item
 
lessOrEqual(String, Object) - Static method in class Filter
Create a new Filter using the <= operator.
lessThan(String, Object) - Static method in class Filter
Create a new Filter using the < operator.
libraryImage(String, String) - Method in class ResultMatrix
 
like(String, String) - Static method in class Filter
Create a new Filter using the LIKE operator.
LimitPosition - Enum in net.pricefx.common.api.chart
 
LimitToMeasure<S extends AbstractChartSeries<?,S>> - Class in net.pricefx.common.apibuilder.chart
 
LimitToMeasure(S, String, String) - Constructor for class LimitToMeasure
 
LimitType - Enum in net.pricefx.common.api.chart
 
Line(C, String, String) - Constructor for class AuxLine.Line
 
linkCell(Object, String, String) - Method in class ResultMatrix
 
linkToPriceGrid(Object, long, Filter) - Method in class ResultMatrix
 
linkToPriceList(Object, long, Filter) - Method in class ResultMatrix
 
listId - Variable in class ProductReferenceRecord
The ID of the target parent object.
listLabel - Variable in class ProductReferenceRecord
Label of target parent object
LivePriceGridAction<ATTACHEDTO extends Help> - Class in net.pricefx.common.apibuilder.calculationflowaction
This action starts calculation of selected LPG for all skus or restricted set of skus.
LivePriceGridAction(ATTACHEDTO, Invocations<MethodInvocationRecord>, String) - Constructor for class LivePriceGridAction
 
loadRows(String, AbstractProducer.ResultIterator) - Method in class TableContext
Load data into an existing in-memory table.
loadRows(String, StreamResults) - Method in class TableContext
 
loadRows(String, List<Map<String, Object>>) - Method in class TableContext
Load data into an existing in-memory table.
log(String, Object) - Method in interface PublicGroovyAPI
This function is meant to be used by the Pricefx internally only.
log(Object) - Method in interface PublicGroovyAPI
This function can be used by the support team only.
logInfo(String, Object) - Method in interface PublicGroovyAPI
Logs an INFO warning message to the system error log which can be displayed in menu Tools / Logs / View Log.
logInfo(Object) - Method in interface PublicGroovyAPI
Logs a INFO message to the system error log which can be displayed in menu Tools / Logs / View Log.
logWarn(String, Object) - Method in interface PublicGroovyAPI
Logs a WARN message to the system error log which can be displayed in menu Tools / Logs / View Log.
logWarn(Object) - Method in interface PublicGroovyAPI
Logs a WARN message to the system error log which can be displayed in menu Tools / Logs / View Log.

M

ManualPricelistAction<ATTACHEDTO extends Help> - Class in net.pricefx.common.apibuilder.calculationflowaction
This action starts calculation of selected manual pricelist.
ManualPricelistAction(ATTACHEDTO, Invocations<MethodInvocationRecord>, String) - Constructor for class ManualPricelistAction
 
markItemClean() - Method in interface PublicGroovyAPI
Removes the dirty flag from the current item set previously by PublicGroovyAPI.markItemDirty().
markItemClean(String, String) - Method in interface PublicGroovyAPI
Removes the dirty flag from the specified matrix item set previously by PublicGroovyAPI.markItemDirty(String, String).
markItemClean(String) - Method in interface PublicGroovyAPI
Removes the dirty flag from the specified item set previously by PublicGroovyAPI.markItemDirty(String).
markItemDirty(String) - Method in interface PublicGroovyAPI
Sets the dirty flag on the specified item, i.e.
markItemDirty(String, String) - Method in interface PublicGroovyAPI
Sets the dirty flag on the specified item, i.e.
markItemDirty() - Method in interface PublicGroovyAPI
Sets the dirty flag on the specified item, i.e.
matches(MatcherContext) - Method in class Filter
 
Matrix2D - Interface in net.pricefx.formulaengine.scripting
Provides access to a QueryResult in a formula context, in the form of a two-dimension matrix.
Matrix2D.BucketNaming - Enum in net.pricefx.formulaengine.scripting
 
max() - Method in interface Matrix2D
 
mean() - Method in interface Matrix2D
 
METHOD_ADD_LINE_ITEM - Static variable in class CalculableLineItemCollectionBuilder
 
METHOD_ADD_LINE_ITEM_WITH_ID - Static variable in class RATBuilder.RABuilder
 
METHOD_ADD_OR_UPDATE_INPUT - Static variable in class CalculableLineItemCollectionBuilder
 
METHOD_ADD_OR_UPDATE_OUTPUT - Static variable in class CalculableLineItemCollectionBuilder
 
METHOD_APPLY_PLACEHOLDER - Static variable in class RATBuilder.RABuilder
 
METHOD_BUILD - Static variable in class RATBuilder
 
METHOD_FROM_EXISTING - Static variable in class RATBuilder
 
METHOD_FROM_PARAMS - Static variable in class RATBuilder
 
METHOD_SUBMIT_AFTER_BUILD - Static variable in class RATBuilder.RABuilder
 
METHOD_UPDATE_FIELD - Static variable in class CalculableLineItemCollectionBuilder
 
min() - Method in interface Matrix2D
 
moveItem(String, String) - Method in class CalculableLineItemCollectionBuilder
Moves an item or folder underneath a new parent.
multiKey(Object...) - Method in interface PublicGroovyAPI
Constructs a new composite key object which can be used as a key in a map.
multiTierEntry(String, String...) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user enter multiple discounts/surcharges/tiers by amount.

N

NAME - Static variable in class RATBuilder
 
NAME - Static variable in class RATBuilder.RABuilder
 
net.pricefx.common.api - package net.pricefx.common.api
 
net.pricefx.common.api.chart - package net.pricefx.common.api.chart
 
net.pricefx.common.apibuilder.calculationflowaction - package net.pricefx.common.apibuilder.calculationflowaction
 
net.pricefx.common.apibuilder.chart - package net.pricefx.common.apibuilder.chart
 
net.pricefx.common.apibuilder.clicoll - package net.pricefx.common.apibuilder.clicoll
 
net.pricefx.common.apibuilder.contract - package net.pricefx.common.apibuilder.contract
 
net.pricefx.common.apibuilder.quote - package net.pricefx.common.apibuilder.quote
 
net.pricefx.common.apibuilder.rebateagreement - package net.pricefx.common.apibuilder.rebateagreement
 
net.pricefx.common.dto - package net.pricefx.common.dto
 
net.pricefx.formulaengine - package net.pricefx.formulaengine
 
net.pricefx.formulaengine.scripting - package net.pricefx.formulaengine.scripting
 
net.pricefx.server.dto - package net.pricefx.server.dto
 
net.pricefx.server.dto.calculation - package net.pricefx.server.dto.calculation
 
net.pricefx.server.dto.calculation.dashboard - package net.pricefx.server.dto.calculation.dashboard
 
net.pricefx.server.protocol - package net.pricefx.server.protocol
 
net.pricefx.service - package net.pricefx.service
 
net.pricefx.workflowengine - package net.pricefx.workflowengine
 
newAdaptiveHistogram() - Method in interface PublicGroovyAPI
Creates a histogram that adapts to an unknown data distribution.
newBarLine() - Method in class ChartBuilder
 
newBoxplot() - Method in class ChartBuilder
 
newBubble() - Method in class ChartBuilder
 
newController() - Method in interface PublicGroovyAPI
Creates a new dashboard controller object that can be further customized.
newCreationWorkflow() - Method in interface PublicGroovyAPI
 
newCreationWorkflowStep() - Method in interface PublicGroovyAPI
 
newDataLoader(Table) - Method in interface DatamartContext
Instantiate a new DatamartContext.DataLoader to load rows with data for all the feed's attributes.
newDataLoader(Table, List<String>) - Method in interface DatamartContext
Instantiate a new DatamartContext.DataLoader to load rows with data for the named fields.
newDatamartSlice() - Method in interface DatamartContext
Creates a new DatamartSlice, which allows for setting filter criteria along the Time, CustomerGroup, ProductGroup any any other dimensions in a Datamart.
newDatamartSlice(String, Object...) - Method in interface DatamartContext
Creates a new DatamartSlice, which allows for setting filter criteria along the Time, CustomerGroup, ProductGroup any any other dimensions in a Datamart, intiialized with the name of the time dimension field, and an optional set filter criteria.
newDatamartSlice() - Method in interface PublicGroovyAPI
Deprecated.
newDatamartSlice(String, Object...) - Method in interface PublicGroovyAPI
newDataTable() - Method in class ChartBuilder
 
newDetailedTimeSeries() - Method in class ChartBuilder
 
newGauge() - Method in interface PublicGroovyAPI
Creates a new gauge object that can be further customized.
newHeatmap() - Method in class ChartBuilder
 
newHistogram() - Method in class ChartBuilder
 
newMatrix() - Method in interface PublicGroovyAPI
Creates a new result matrix DTO object that can be further customized and populated with calculated data.
newMatrix(String...) - Method in interface PublicGroovyAPI
Creates a new result matrix DTO object that can be further customized and populated with calculated data.
newMatrix(Collection<String>) - Method in interface PublicGroovyAPI
Creates a new result matrix DTO object that can be further customized and populated with calculated data.
newPie() - Method in class ChartBuilder
 
newQuery(Table) - Method in interface DatamartContext
 
newQuery(Table, boolean) - Method in interface DatamartContext
Build a new query on the given table.
newQuery(DatamartContext.Query) - Method in interface DatamartContext
Create a new query from an existing one.
newQuery(DatamartContext.Query, DatamartContext.Query, LinkedHashMap<String, String>) - Method in interface DatamartContext
Deprecated.
newQuery(DatamartContext.Query, DatamartContext.Query, LinkedHashMap<String, String>, boolean) - Method in interface DatamartContext
Deprecated.
newQuery(DatamartContext.Query, DatamartContext.Query, LinkedHashMap<String, String>, String, boolean) - Method in interface DatamartContext
Deprecated.
newQuery(Table) - Method in class TableContext
 
newQuery(String) - Method in class TableContext
 
newScatter() - Method in class ChartBuilder
 
newTimeSeries() - Method in class ChartBuilder
 
newTimeSeriesScatter() - Method in class ChartBuilder
 
newWaterfall() - Method in class ChartBuilder
 
newWaterfallComparison() - Method in class ChartBuilder
 
next() - Method in interface StreamResults
Moves the cursor forward one row from its current position.
NonAggrFieldAxis<S extends AbstractChartSeries<?,S>> - Class in net.pricefx.common.apibuilder.chart
 
NonAggrFieldAxis(S, String, String) - Constructor for class NonAggrFieldAxis
 
none(String, Filter) - Static method in class Filter
Create a new Filter using the NONE operator.
normalize(double, double) - Method in class AdaptiveHistogram
Normalizes all the values to the desired range.
normalize(long...) - Method in interface Matrix2D
Normalizes numeric column values, by dividing each value in the column by the total for the column.
normalizeAcrossColumns() - Method in class HeatmapChart.HeatmapSeries
 
normalizeAcrossRows() - Method in class HeatmapChart.HeatmapSeries
 
normalizeRowValues(Collection<String>, int) - Method in interface Matrix2D
Normalizes the values on a row-by-row basis.
not(Filter) - Static method in class Filter
Create a new Filter using the NOT operator.
notEqual(String, Object) - Static method in class Filter
Create a new Filter using the != operator.
notIn(String, Collection<?>) - Static method in class Filter
Create a new Filter using the NOT IN operator.
notIn(String, Object...) - Static method in class Filter
Create a new Filter using the NOT IN operator.

O

ObjRefAction<ATTACHEDTO extends Help> - Class in net.pricefx.common.apibuilder.calculationflowaction
This action starts calculation of selected rebate record set records.
ObjRefAction(ATTACHEDTO, Invocations<MethodInvocationRecord>) - Constructor for class ObjRefAction
 
objService - Variable in class TableContext
 
onCellClick() - Method in class AbstractChartBuilder
 
OnCellClick(C) - Constructor for class ChartEvents.OnCellClick
 
OnChartClick(C) - Constructor for class ChartEvents.OnChartClick
 
onClick() - Method in class BarLineChart
 
onClick() - Method in class ScatterChart
 
onRowClick() - Method in class AbstractChartBuilder
 
OnRowClick(C) - Constructor for class ChartEvents.OnRowClick
 
onRowSelection() - Method in class ResultMatrix
Configures a client-side UI event.
OP_ALL - Static variable in class Filter
 
OP_AND - Static variable in class Filter
 
OP_CUSTOM - Static variable in class Filter
 
OP_EMPTY - Static variable in class Filter
 
OP_EQUAL - Static variable in class Filter
 
OP_GREATER_OR_EQUAL - Static variable in class Filter
 
OP_GREATER_THAN - Static variable in class Filter
 
OP_ILIKE - Static variable in class Filter
 
OP_IN - Static variable in class Filter
 
OP_LESS_OR_EQUAL - Static variable in class Filter
 
OP_LESS_THAN - Static variable in class Filter
 
OP_LIKE - Static variable in class Filter
 
OP_NONE - Static variable in class Filter
 
OP_NOT - Static variable in class Filter
 
OP_NOT_EMPTY - Static variable in class Filter
 
OP_NOT_EQUAL - Static variable in class Filter
 
OP_NOT_IN - Static variable in class Filter
 
OP_NOT_NULL - Static variable in class Filter
 
OP_NULL - Static variable in class Filter
 
OP_OR - Static variable in class Filter
 
OP_SOME - Static variable in class Filter
 
openInTabOrRecalculateOn(String) - Method in interface DashboardApi
 
openInWindowOrRecalculateOn(String) - Method in interface DashboardApi
 
operator - Variable in class Filter
The type of comparison to do between the property and the value.
option(String, Object...) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user select a single value from the predefined options.
option(String, List<Object>, Map<String, Object>) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user select a single value from the predefined options.
options - Variable in class ScatterChart
 
options - Variable in class TimeSeriesScatterChart
 
options(String, Object...) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user select multiple values from the predefined options.
options(String, List<Object>, Map<String, Object>) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user select multiple values from the predefined options.
or(Filter...) - Static method in class Filter
Create a new Filter using the OR operator.
orderBy(String...) - Method in interface DatamartContext.Query
Parses and adds one or more SQL-like conditions to the query's ORDER BY clause.
otherCustomer(String) - Method in interface PublicGroovyAPI
Triggers a custom-named customer picker input parameter.
otherCustomer(String, String) - Method in interface PublicGroovyAPI
Triggers a custom-named customer picker input parameter.
otherCustomer(String, String, boolean) - Method in interface PublicGroovyAPI
Triggers a custom-named customer picker input parameter.
otherProduct(String, String) - Method in interface PublicGroovyAPI
Triggers a custom-named product picker input parameter.
otherProduct(String) - Method in interface PublicGroovyAPI
Triggers a custom-named product picker input parameter.

P

parentId - Variable in class QuoteStructure
The level of the quote.
parsableInputFile(String) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user pick a file.
parsableInputFileData(String) - Method in interface PublicGroovyAPI
If a parsableInputFile has a value, this function opens the file and parses it to basic Groovy data structures.
parsableInputFileDataFromHandle(String) - Method in interface PublicGroovyAPI
If a parsableInputFile has a value, this function opens the file and parses it to basic groovy datastructures.
parseDate(String) - Method in interface DatamartContext.Calendar
Not so much a PA specific helper method: best attempt at converting a string representation (not necessarily in the 'yyyy-MM-dd' format) to a Date.
parseDate(String, String) - Method in interface PublicGroovyAPI
Parses a date (entered as a String) according to the given pattern.
parseDateTime(String) - Method in interface DatamartContext.Calendar
Not so much a PA specific helper method: best attempt at converting a string representation (not necessarily in the 'yyyy-MM-dd'T'HHmmss' format) to a DateTime.
parseDateTime(String, String) - Method in interface PublicGroovyAPI
Parses a datetime (entered as a String) according to the given pattern.
parseDateTime(String, String, int, int) - Method in interface PublicGroovyAPI
Parses a datetime (entered as a String) according to a given pattern and time zone.
parseQuery(String) - Method in class TableContext
 
PayoutRecordManager - Interface in net.pricefx.formulaengine
API that can be accessed via the 'payoutRecords' binding, only available in a RebateRecord calculation context (i.e.
phase - Variable in class CalculableLineItemCollectionBuilder
 
PieAdditionalMeasure(PieChart.PieSeries, String) - Constructor for class PieChart.PieAdditionalMeasure
 
PieChart - Class in net.pricefx.common.apibuilder.chart
Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at https://api.highcharts.com/class-reference/Highcharts.Chart.
PieChart(IdGenerator, Invocations<MethodInvocation>) - Constructor for class PieChart
 
PieChart.PieAdditionalMeasure - Class in net.pricefx.common.apibuilder.chart
 
PieChart.PieOptions - Class in net.pricefx.common.apibuilder.chart
 
PieChart.PieSeries - Class in net.pricefx.common.apibuilder.chart
 
PieChart.Size - Class in net.pricefx.common.apibuilder.chart
 
PieOptions(PieChart, String) - Constructor for class PieChart.PieOptions
 
PieSeries(PieChart, String) - Constructor for class PieChart.PieSeries
 
placeholders() - Method in class RATBuilder
 
postProcessRow(Map<String, Object>) - Method in class ItemSummaryQuery
 
previousContext(String) - Method in interface PublicGroovyAPI
In case of (chained) price lists, this method allows for an easy retrieval of records from the previous list.
previousContext(String, String) - Method in interface PublicGroovyAPI
In case of (chained) price lists, this method allows for an easy retrieval of records from the previous list.
PriceAPIAction<ATTACHEDTO extends Help> - Class in net.pricefx.common.apibuilder.calculationflowaction
This action starts selected Price API job.
PriceAPIAction(ATTACHEDTO, Invocations<MethodInvocationRecord>, String) - Constructor for class PriceAPIAction
 
pricelist(String) - Method in interface PublicGroovyAPI
Looks up the result price (considering a manual override) of an SKU being calculated in a price list of the given name.
pricelist(String, String) - Method in interface PublicGroovyAPI
Looks up the attribute defined by attributeName (considering a manual override) of an SKU being calculated in a price list of the given name.
pricelist(String, String, String) - Method in interface PublicGroovyAPI
Looks up the result price (considering a manual override) of a given SKU in a price list of the given name.
pricelist(String, String, String, String) - Method in interface PublicGroovyAPI
Looks up the attribute defined by attributeName (considering a manual override) of the given SKU in a matrix price list of the given name.
PricelistAction<ATTACHEDTO extends Help> - Class in net.pricefx.common.apibuilder.calculationflowaction
This action starts calculation of selected pricelist.
PricelistAction(ATTACHEDTO, Invocations<MethodInvocationRecord>, String) - Constructor for class PricelistAction
 
pricelistItem(String) - Method in interface PublicGroovyAPI
Looks up the price list item record (PLI or XPLI) of an SKU being calculated in a price list of the given name.
pricelistItem(String, String) - Method in interface PublicGroovyAPI
Looks up the price list item record (PLI) of the given SKU in a price list of a given name.
pricelistItem(String, String, String) - Method in interface PublicGroovyAPI
Looks up the matrix price list item record (XPLI) of the given SKU in a matrix price list of the given name.
printTablesDefinitions(String) - Method in class TableContext
Returns a debug string that contains the complete schema definition for the temporary in-memory database.
product() - Method in interface PublicGroovyAPI
Retrieves the product object for the SKU currently being calculated.
product(String) - Method in interface PublicGroovyAPI
Retrieves the given attribute value from the product table for the SKU being calculated.
product(String, String) - Method in interface PublicGroovyAPI
Retrieves the given attribute value from the product table for a given SKU.
product(String, String, String, Object) - Method in interface PublicGroovyAPI
Retrieves the given attribute value from the product table for a given SKU.
productCompetition() - Method in interface PublicGroovyAPI
Retrieves a list of all product competition records (PCOMP) for the SKU being calculated.
productCompetition(Filter...) - Method in interface PublicGroovyAPI
Retrieves a list of product competition records (PCOMP) for the SKU being calculated filtered by filters.
productExtension(String) - Method in interface PublicGroovyAPI
Retrieves a list of all product extentions records (PX) from a PX table named extensionName for the SKU being calculated.
productExtension(String, Filter...) - Method in interface PublicGroovyAPI
Retrieves a list of product extentions records (PX) from a PX table named extensionName for the SKU being calculated filtered by filters.
productGroupEntry(String...) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user select a group of products and returns the selection as a Map.
productGroupEntry(String, String, Object) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user select a group of products and returns the selection as a Map.
ProductReferenceRecord - Class in net.pricefx.server.dto
A DTO that describes a product reference
ProductReferenceRecord() - Constructor for class ProductReferenceRecord
 
productsFilter - Variable in class AbstractChartSeries
 
productToRelatedObjectsFilter(String, String) - Method in interface PublicGroovyAPI
Creates a filter to be applied to a search on a related object type, limiting the result to objects of the related type that have a link to the given product.
productXRef() - Method in interface PublicGroovyAPI
Retrieves a list of all product reference records (PXREF) for the SKU being calculated.
productXRef(Filter...) - Method in interface PublicGroovyAPI
Retrieves a list of all product reference records (PXREF) for the SKU being calculated.
profileData(DatamartContext.Query) - Method in interface DatamartContext
Calculates "Min", "Max", "#", "#Nulls", "#Distinct", "Sample" for dimension projections, and "Min", "Max", "Mean", "Std", "#", "#Nulls" for numeric projections.
Projection() - Constructor for class ItemSummaryQuery.Projection
 
Projection(String, String, String, String) - Constructor for class ItemSummaryQuery.Projection
 
Projection(String, String, String, String, String) - Constructor for class ItemSummaryQuery.Projection
 
properties - Variable in class WorkflowDTO.StepDTO
 
property - Variable in class Filter
The name of the property to filter on.
protectedSetAggrFieldAxisX(String) - Method in class AbstractChartSeries
 
protectedSetAggrFieldAxisY(String) - Method in class AbstractChartSeries
 
protectedSetAxisX(String) - Method in class AbstractChartSeries
 
protectedSetAxisY(String) - Method in class AbstractChartSeries
 
protectedSetNonAggrFieldAxisX(String) - Method in class AbstractChartSeries
 
protectedSetNonAggrFieldAxisY(String) - Method in class AbstractChartSeries
 
PublicGroovyAPI - Interface in net.pricefx.formulaengine.scripting
This interface represents what can be reached in the Groovy element syntax as api.
putGlobal(Map<String, Object>) - Method in interface PublicGroovyAPI
Puts an entire map of variables into the global cache.

Q

quantize(int, String, String) - Method in interface Matrix2D
Convenience method to quantize all numeric columns in one go.
quantize(String, int, String, String) - Method in interface Matrix2D
Performs equal width quantization of a scalar distribution in a given column, and maps each value to its nearest lower quantile.
QuoteBuilder - Class in net.pricefx.common.apibuilder.quote
QuoteBuilder is the starting point of an interface that allows you 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.
QuoteHelper - Class in net.pricefx.common.apibuilder.quote
A helper class that assists in manipulating the quote object
QuoteHelper(Map<String, Object>) - Constructor for class QuoteHelper
 
QuoteStructure - Class in net.pricefx.common.apibuilder.quote
This is a helper object that is used to build up code generated content of a quote.
QuoteStructure() - Constructor for class QuoteStructure
 
QuoteStructure.Item - Class in net.pricefx.common.apibuilder.quote
A DTO that holds information about the new item (part or folder) to be created.

R

RABuilder(RATBuilder) - Constructor for class RATBuilder.RABuilder
 
random() - Method in interface PublicGroovyAPI
Provides the access to the standard java.util.Random generator instance created for the duration of the calculation task (= not get recreated for each logic element evaluation).
RATBuilder - Class in net.pricefx.common.apibuilder.rebateagreement
Created by petercipov on 22/03/16.
RATBuilder(IdGenerator, Invocations<MethodInvocation>, String, String) - Constructor for class RATBuilder
 
RATBuilder.RABuilder - Class in net.pricefx.common.apibuilder.rebateagreement
 
readSingleValue(String) - Method in class WorkflowDTO.StepDTO
 
reasons - Variable in class WorkflowInfo.WorkflowStepInfo
 
RebateAgreementBuilder - Class in net.pricefx.common.apibuilder.rebateagreement
IMPORTANT: Please read super class notes on sequence of execution!
rebateAgreementUserEntry(String, String) - Method in interface PublicGroovyAPI
Prompts the user to input parameters for a rebate agreement (RBA).
RebateRecordAction<ATTACHEDTO extends Help> - Class in net.pricefx.common.apibuilder.calculationflowaction
This action starts calculation of selected rebate record set records.
RebateRecordAction(ATTACHEDTO, Invocations<MethodInvocationRecord>, String) - Constructor for class RebateRecordAction
 
reconstructFromMap(Map<String, ?>) - Static method in class Filter
 
redAlert(String) - Method in interface PublicGroovyAPI
Marks the current logic element with a red alert and provides the given message.
registerPlaceholder(InputType, String) - Method in class RATBuilder
 
relatedObjectToCustomersFilter(String) - Method in interface PublicGroovyAPI
Creates a filter to be applied to a customer search, limiting the result to customers that are linked to the given related object, the latter defined by its typedId.
relatedObjectToProductsFilter(String) - Method in interface PublicGroovyAPI
Creates a filter to be applied to a product search, limiting the result to products that are linked to the given related object, the latter defined by its typedId.
remove(Filter) - Method in class Filter
Used with OP_OR and OP_AND filters.
removeManualOverride(String) - Method in interface PublicGroovyAPI
Removes a user entered value that overrides the calculated result of a logic element.
removeSharedCache(String) - Method in interface PublicGroovyAPI
Deletes a key from the shared cache.
removeStep(String) - Method in class WorkflowDTO
Removes a named step (if existing)
renameColumns(Map<String, String>) - Method in interface Matrix2D
Renames the columns in this matrix so that the old column label = key, and the new column label = value in the given map.
renameFolder(String, String) - Method in class CalculableLineItemCollectionBuilder
Renames a folder (not items!)
replaceMissingValues(String, Object) - Method in interface Matrix2D
Replaces nulls in the given column with the given value.
reset() - Method in class AdaptiveHistogram
Erases all data from the histogram.
resetSKUContextSwitch() - Method in interface PublicGroovyAPI
Resets a SKU context switch to the originally specified SKU.
resolveFieldName(CalculableObjectItem, String, PersistedObjectService) - Method in class ItemSummaryQuery
 
restrictToSkus(List<String>) - Method in class LivePriceGridAction
Restricts LPG calculation to list of presented skus
ResultFlexChart - Class in net.pricefx.server.dto.calculation
 
ResultFlexChart() - Constructor for class ResultFlexChart
 
ResultFlexChart(Object) - Constructor for class ResultFlexChart
 
ResultFlexChart(String, Object) - Constructor for class ResultFlexChart
 
ResultGauge - Class in net.pricefx.server.dto.calculation
The Gauge widget class implements a graphical speedometer-style gauge for displaying a measurement by means of a needle on a dial.
ResultGauge() - Constructor for class ResultGauge
 
ResultHighchart - Class in net.pricefx.server.dto.calculation
 
ResultHighchart(Map<String, ?>) - Constructor for class ResultHighchart
Not intended for public use.
ResultHighmap - Class in net.pricefx.server.dto.calculation
 
ResultHighmap(Map<String, ?>) - Constructor for class ResultHighmap
Not intended for public use.
ResultMatrix - Class in net.pricefx.server.dto.calculation
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
ResultMatrix() - Constructor for class ResultMatrix
 
ResultMatrix(Map) - Constructor for class ResultMatrix
 
ResultMatrix(String...) - Constructor for class ResultMatrix
Creates a new matrix object with an initial set of columns
ResultMatrix(Collection<String>) - Constructor for class ResultMatrix
Creates a new matrix object with an initial set of columns
ResultMatrix.AbstractResultMatrixCell - Class in net.pricefx.server.dto.calculation
 
ResultMatrix.ResultMatrixImageCell - Class in net.pricefx.server.dto.calculation
 
ResultMatrix.ResultMatrixLinkCell - Class in net.pricefx.server.dto.calculation
 
ResultMatrix.ResultMatrixOnRowSelection - Class in net.pricefx.server.dto.calculation
 
ResultMatrix.ResultMatrixOnRowSelection.TriggerEvent - Class in net.pricefx.server.dto.calculation
 
ResultMatrix.ResultMatrixStyledCell - Class in net.pricefx.server.dto.calculation
 
ResultMatrixImageCell() - Constructor for class ResultMatrix.ResultMatrixImageCell
 
ResultMatrixLinkCell() - Constructor for class ResultMatrix.ResultMatrixLinkCell
 
ResultMatrixOnRowSelection() - Constructor for class ResultMatrix.ResultMatrixOnRowSelection
 
ResultMatrixStyledCell() - Constructor for class ResultMatrix.ResultMatrixStyledCell
 
roles() - Method in interface PublicGroovyAPI
Lists all roles available in the application.
ROOT_ENTITY - Static variable in class Filter
Property string representing the root entity of the search.
ROOT_LINE_ID - Static variable in class CalculableLineItemCollectionBuilder
 
RowClickTriggerEvent(String) - Constructor for class ChartEvents.OnRowClick.RowClickTriggerEvent
 
runSummaryQuery(ItemSummaryQuery<? extends CalculableObject>) - Method in interface PublicGroovyAPI
Runs (executes) a summary query defined by the parameterized query object which was created by one of the getXXXSummaryQuery calls.

S

ScatterAdditionalMeasure(ScatterChart.ScatterSeries, String) - Constructor for class ScatterChart.ScatterAdditionalMeasure
 
ScatterChart - Class in net.pricefx.common.apibuilder.chart
Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at https://api.highcharts.com/class-reference/Highcharts.Chart.
ScatterChart(IdGenerator, Invocations<MethodInvocation>) - Constructor for class ScatterChart
 
ScatterChart.ScatterAdditionalMeasure - Class in net.pricefx.common.apibuilder.chart
 
ScatterChart.ScatterOnChartClick - Class in net.pricefx.common.apibuilder.chart
 
ScatterChart.ScatterOnChartClick.ScatterTriggerEvent - Class in net.pricefx.common.apibuilder.chart
 
ScatterChart.ScatterOptions - Class in net.pricefx.common.apibuilder.chart
 
ScatterChart.ScatterSeries - Class in net.pricefx.common.apibuilder.chart
 
ScatterOnChartClick() - Constructor for class ScatterChart.ScatterOnChartClick
 
ScatterOptions(ScatterChart, String) - Constructor for class ScatterChart.ScatterOptions
 
ScatterSeries(ScatterChart, String) - Constructor for class ScatterChart.ScatterSeries
 
ScatterTriggerEvent(String) - Constructor for class ScatterChart.ScatterOnChartClick.ScatterTriggerEvent
 
ScheduleSettings<ATTACHEDTO extends Help> - Class in net.pricefx.common.apibuilder.calculationflowaction
This action is helping you to get an information about schedule as seen in the UI + if needed alter it.
ScheduleSettings(ATTACHEDTO, Invocations<MethodInvocationRecord>, CalculationFlowTimeUnit, BigDecimal, String, Boolean, CFTraitType) - Constructor for class ScheduleSettings
 
schemaService - Variable in class TableContext
 
search(BigDecimal, long) - Method in interface Matrix2D
Finds the index of row containing a given value in a given column, assuming this column is sorted high --> low.
search(Collection<?>, long) - Method in interface Matrix2D
Find all rows for which the value in the given column is contained in the passed in collection.
select(String, String) - Method in interface DatamartContext.Query
Adds a projection to the query.
select(String, String, String...) - Method in interface DatamartContext.Query
 
select(long, long, long, long) - Method in interface Matrix2D
Selects a subset of rows and columns in the matrix, and returns the result as new Matrix2D object, but which crucially does not duplicate any of the original rows.
select(String) - Method in class TableContext
Deprecated.
selectAll() - Method in interface DatamartContext.Query
 
selectAll(boolean) - Method in interface DatamartContext.Query
 
selectColumn(String) - Method in interface Matrix2D
Selects a column in the matrix, and returns the result as new Matrix2D object, but which crucially does not duplicate any of the original rows.
selectColumn(long) - Method in interface Matrix2D
Selects a column in the matrix, and returns the result as new Matrix2D object, but which crucially does not duplicate any of the original rows.
selectColumns(long, long) - Method in interface Matrix2D
Selects a subset of columns in the matrix, and returns the result as new Matrix2D object, but which crucially does not duplicate any of the original rows.
selectCount() - Method in interface DatamartContext.Query
Adds a COUNT(*) projection to the query.
selectDistinct() - Method in interface DatamartContext.Query
Equivalent to the DISTINCT option in an SQL select statement.
selectedStepOnDeny - Variable in class WorkflowInfo
In case that the workflow was denied, and user selected any step (happens when WorkflowDTO.withSelectStepOnDeny(true) and user selected some state.
selectRow(long) - Method in interface Matrix2D
Selects one row in the matrix, and returns the result as new Matrix2D object, but which crucially does not duplicate any of the original rows.
selectRows(long, long) - Method in interface Matrix2D
Selects a subset of rows in the matrix, and returns the result as new Matrix2D object, but which crucially does not duplicate any of the original rows.
selectRows(long[]) - Method in interface Matrix2D
Selects a subset of rows in the matrix, and returns the result as new Matrix2D object, but which crucially does not duplicate any of the original rows.
selectRows(Collection<? extends Number>) - Method in interface Matrix2D
Selects a subset of rows in the matrix, and returns the result as new Matrix2D object, but which crucially does not duplicate any of the original rows.
sendEmail(String, String, String) - Method in interface PublicGroovyAPI
Sends an email.
SeriesType - Enum in net.pricefx.common.api.chart
 
set(Map<?, ?>...) - Method in interface IRebateRecordManager
Update genetic attributes of the RR with the default name (linked to the current RA.lineitem)
set(String, Map<?, ?>...) - Method in interface IRebateRecordManager
Update genetic attributes of the RR with the given name (linked to the current RA.lineitem)
set(String, String, Map<?, ?>...) - Method in interface IRebateRecordManager
In the given RR-set, update genetic attributes of the RR with the given name (linked to the current RA.lineitem)
setAddUnknownValues(Boolean) - Method in class ContextParameter
 
setAggregationBy(String) - Method in class AbstractChartSeries
 
setAggregationBy(String) - Method in class ChartSeries.Aggregation
 
setAlertMessage(String) - Method in interface PublicGroovyAPI
Marks the current formula element with the given alert message.
setAlwaysEditable(Boolean) - Method in class ContextParameter
 
setAttribute(String, Object) - Method in class AttributedResult
 
setAxisX(String) - Method in class BarLineChart.BarLineSeries
 
setAxisX(String) - Method in class BoxplotChart.BoxplotSeries
 
setAxisX(String) - Method in class BubbleChart.BubbleSeries
 
setAxisX(String) - Method in class DetailedTimeSeriesChart.DetailedTimeSeriesSeries
 
setAxisX(String) - Method in class HeatmapChart.HeatmapSeries
 
setAxisX(String) - Method in class HistogramChart.HistogramSeries
 
setAxisX(String) - Method in class ScatterChart.ScatterSeries
 
setAxisX(String) - Method in class TimeSeriesChart.TimeSeriesSeries
 
setAxisX(String) - Method in class TimeSeriesScatterChart.TimeSeriesScatterSeries
 
setAxisY(String) - Method in class BarLineChart.BarLineSeries
 
setAxisY(String) - Method in class BoxplotChart.BoxplotSeries
 
setAxisY(String) - Method in class BubbleChart.BubbleSeries
 
setAxisY(String) - Method in class DetailedTimeSeriesChart.DetailedTimeSeriesSeries
 
setAxisY(String) - Method in class HeatmapChart.HeatmapSeries
 
setAxisY(String) - Method in class HistogramChart.HistogramSeries
 
setAxisY(String) - Method in class ScatterChart.ScatterSeries
 
setAxisY(String) - Method in class TimeSeriesChart.TimeSeriesSeries
 
setAxisY(String) - Method in class TimeSeriesScatterChart.TimeSeriesScatterSeries
 
setBandBy(String) - Method in class AbstractChartSeries
 
setBandBy(String) - Method in class ChartSeries.Aggregation
 
setBaseTemplateToUse(String) - Method in class ResultFlexChart
 
setBins(BigDecimal) - Method in class HistogramChart.HistogramSeries
 
setBoxplotAxis() - Method in class AbstractChartSeries
 
setBoxplotAxis() - Method in class ChartSeries.EmbeddedBoxplot
 
setBoxplotAxisLabel(String) - Method in class AbstractChartOptions
 
setBoxplotAxisLabel(String) - Method in class ChartOptions.EmbeddedBoxplot
 
setBoxplotAxisMax(BigDecimal) - Method in class AbstractChartOptions
 
setBoxplotAxisMax(BigDecimal) - Method in class ChartOptions.EmbeddedBoxplot
 
setBoxplotAxisMin(BigDecimal) - Method in class AbstractChartOptions
 
setBoxplotAxisMin(BigDecimal) - Method in class ChartOptions.EmbeddedBoxplot
 
setBubbleSize(String) - Method in class BubbleChart.BubbleSeries
 
setCalculate(Boolean) - Method in class CFSAction
Whether the action is valid and should be triggered or not.
setCalculate(Boolean) - Method in class DataLoadAction
Whether the action is valid and should be triggered or not.
setCalculate(Boolean) - Method in class LivePriceGridAction
Whether the action is valid and should be triggered or not.
setCalculate(Boolean) - Method in class ManualPricelistAction
Whether the action is valid and should be triggered or not.
setCalculate(Boolean) - Method in class PricelistAction
Whether the action is valid and should be triggered or not.
setCalculate(Boolean) - Method in class RebateRecordAction
Whether the action is valid and should be triggered or not.
setCalculate(Boolean) - Method in class SimulationAction
Whether the action is valid and should be triggered or not.
setCastCallback(ItemSummaryQuery.QueryGeneratorCallback) - Method in class ItemSummaryQuery
 
setCategories(String) - Method in class PieChart.PieSeries
 
setColor(AuxLineColor) - Method in class AuxLine
 
setColor(AuxLineColor) - Method in class TrendLine
 
setColorAxis(String) - Method in class HeatmapChart.HeatmapSeries
 
setColorAxisType(ColorAxisType) - Method in class HeatmapChart.HeatmapOptions
 
setColumnFormat(String, FieldFormatType) - Method in class ResultMatrix
Sets a column format for a specified column
setColumnTooltip(String, String) - Method in class ResultMatrix
Adds a tooltip to a column
setComparison(Boolean) - Method in class AbstractChartOptions
 
setComparison(Boolean) - Method in class ChartOptions.ZAxis
 
setComparisonDim(String) - Method in class AbstractChartSeries
 
setComparisonDim(String) - Method in class BarLineChart.BarLineSeries
 
setComparisonDim(String) - Method in class BoxplotChart.BoxplotSeries
 
setComparisonDim(String) - Method in class DetailedTimeSeriesChart.DetailedTimeSeriesSeries
 
setComparisonPeriod(BigDecimal) - Method in class TimeSeriesChart.TimeSeriesSeries
 
setComparisonType(ComparisonType) - Method in class AbstractChartOptions
 
setComparisonType(ComparisonType) - Method in class BarLineChart.BarLineOptions
 
setConfigParameter(String, Object) - Method in class ContextParameter
 
setContext(FormulaEngineContext) - Method in class ConfiguratorEntry
 
setCurrency(String) - Method in class AbstractChartSeries
 
setDataHeaders(String...) - Method in class ResultHighchart
To override the default column headers of the data tab table.
setDatamart(String) - Method in class AbstractChartSeries
 
setDebugRow(Map<String, Object>) - Method in interface ClaimContext
Set row for formula testdrive
setDefaultFormat(FieldFormatType) - Method in class ResultMatrix
Sets a default column format
setDefaultValue(BigDecimal) - Method in class Expression
 
setDescription(String) - Method in class Expression
 
setDisableDrilldown(Boolean) - Method in class AbstractChartOptions
 
setDisableDrilldown(Boolean) - Method in class BarLineChart.BarLineOptions
 
setDisableDrilldown(Boolean) - Method in class BoxplotChart.BoxplotOptions
 
setDisableDrilldown(Boolean) - Method in class BubbleChart.BubbleOptions
 
setDisableDrilldown(Boolean) - Method in class DataTableChart.DataTableOptions
 
setDisableDrilldown(Boolean) - Method in class HeatmapChart.HeatmapOptions
 
setDisableDrilldown(Boolean) - Method in class PieChart.PieOptions
 
setDisableDrilldown(Boolean) - Method in class ScatterChart.ScatterOptions
 
setDisableDrilldown(Boolean) - Method in class TimeSeriesChart.TimeSeriesOptions
 
setDisableDrilldown(Boolean) - Method in class TimeSeriesScatterChart.TimeSeriesScatterOptions
 
setDisableSorting(boolean) - Method in class ResultMatrix
Set sorting capability in UI grid
setDisableZoom(Boolean) - Method in class AbstractChartOptions
 
setDisableZoom(Boolean) - Method in class BarLineChart.BarLineOptions
 
setDisableZoom(Boolean) - Method in class BoxplotChart.BoxplotOptions
 
setDisableZoom(Boolean) - Method in class BubbleChart.BubbleOptions
 
setDisableZoom(Boolean) - Method in class DetailedTimeSeriesChart.DetailedTimeSeriesOptions
 
setDisableZoom(Boolean) - Method in class HeatmapChart.HeatmapOptions
 
setDisableZoom(Boolean) - Method in class ScatterChart.ScatterOptions
 
setDisableZoom(Boolean) - Method in class TimeSeriesChart.TimeSeriesOptions
 
setDisableZoom(Boolean) - Method in class TimeSeriesScatterChart.TimeSeriesScatterOptions
 
setDistributedCalculationThreshold(int) - Method in class CFSAction
Sets a job-individual threshold to start a distributed calculation.
setDistributedCalculationThreshold(int) - Method in class LivePriceGridAction
Sets a job-individual threshold to start a distributed calculation.
setDistributedCalculationThreshold(int) - Method in class PricelistAction
Sets a job-individual threshold to start a distributed calculation.
setDistributedCalculationThreshold(int) - Method in class SimulationAction
Sets a job-individual threshold to start a distributed calculation.
setDoCount(boolean) - Method in class ItemSummaryQuery
 
setEnableClientFilter(boolean) - Method in class ResultMatrix
 
setEscapeHTML(boolean) - Method in class ResultMatrix
Set HTML escaping flag.
setExecute(Boolean) - Method in class PriceAPIAction
Whether the action is valid and should be executed or not.
setExpression(String) - Method in class Expression
 
setFilter(Object) - Method in class ObjRefAction
 
setFilter(Map<String, Object>) - Method in class ContextParameter
 
setFilters(Filter...) - Method in class ContextParameter
 
setFlexChart(Object) - Method in class ResultFlexChart
 
setFormula() - Method in class AbstractChartSeries
 
setFormulaName(String) - Method in class Formula
 
setFromDate(Date) - Method in class TimeSeriesChart.TimeSeriesSeries
 
setGeneratedQueryDto(String) - Method in class AbstractChartSeries
 
setHideDataLabels(Boolean) - Method in class AbstractChartSeries
 
setHideDataLabels(Boolean) - Method in class AuxLine
 
setHideDataLabels(Boolean) - Method in class ChartSeries.Basic
 
setHideDataLabels(Boolean) - Method in class TrendLine
 
setHideLegend(Boolean) - Method in class AbstractChartOptions
 
setHideLegend(Boolean) - Method in class ChartOptions.Basic
 
setHideTooltips(Boolean) - Method in class AbstractChartOptions
 
setHideTooltips(Boolean) - Method in class ChartOptions.Basic
 
setInitialDataGrouping(Boolean) - Method in class DataTableChart.DataTableOptions
 
setInputs(List<ContextParameter>) - Method in class ConfiguratorEntry
 
setItemFilter(Filter) - Method in class ItemSummaryQuery
 
setItemGroupBy(String) - Method in class ItemSummaryQuery
 
setItemSqlAlias(String) - Method in class ItemSummaryQuery
 
setItemToObjectFkName(String) - Method in class ItemSummaryQuery
 
setItemTypedId(String) - Method in class ProductReferenceRecord
 
setLabel(String) - Method in class AbstractChartSeries
 
setLabel(String) - Method in class AuxLine
 
setLabel(String) - Method in class TrendLine
 
setLabel(String) - Method in class ContextParameter
 
setLabel(String) - Method in class ProductReferenceRecord
 
setLabelTranslations(String) - Method in class ContextParameter
 
setLegacyComparisonMode(Boolean) - Method in class TimeSeriesChart.TimeSeriesOptions
 
setLimitTo(LimitPosition, BigDecimal, LimitType) - Method in class AbstractChartSeries
 
setLimitTo(LimitPosition, BigDecimal, LimitType) - Method in class BarLineChart.BarLineSeries
 
setLimitTo(LimitPosition, BigDecimal, LimitType) - Method in class BoxplotChart.BoxplotSeries
 
setLimitTo(LimitPosition, BigDecimal, LimitType) - Method in class BubbleChart.BubbleSeries
 
setLimitTo(LimitPosition, BigDecimal, LimitType) - Method in class DetailedTimeSeriesChart.DetailedTimeSeriesSeries
 
setLimitTo(LimitPosition, BigDecimal, LimitType) - Method in class HeatmapChart.HeatmapSeries
 
setLimitTo(LimitPosition, BigDecimal, LimitType) - Method in class PieChart.PieSeries
 
setLimitTo(LimitPosition, BigDecimal, LimitType) - Method in class TimeSeriesChart.TimeSeriesSeries
 
setListId(Object) - Method in class ProductReferenceRecord
 
setListLabel(String) - Method in class ProductReferenceRecord
 
setMarker(BigDecimal, BigDecimal) - Method in class AbstractChartOptions
 
setMarker(BigDecimal, BigDecimal) - Method in class BubbleChart.BubbleOptions
 
setMarker(BigDecimal, BigDecimal) - Method in class ScatterChart.ScatterOptions
 
setMarker(BigDecimal, BigDecimal) - Method in class TimeSeriesScatterChart.TimeSeriesScatterOptions
 
setMax(BigDecimal) - Method in class ResultGauge
The maximum dial value.
setMaxDataPoints(BigDecimal) - Method in class AbstractChartOptions
 
setMaxDataPoints(BigDecimal) - Method in class BarLineChart.BarLineOptions
 
setMaxDataPoints(BigDecimal) - Method in class BoxplotChart.BoxplotOptions
 
setMaxDataPoints(BigDecimal) - Method in class PieChart.PieOptions
 
setMaxRows(Integer) - Method in interface DatamartContext.Query
Limits the number of rows returned in the query result.
setMeasure(String) - Method in class AbstractChartMeasures
 
setMeasure(String) - Method in class LimitToMeasure
 
setMessage(String) - Method in class ConfiguratorEntry
 
setMin(BigDecimal) - Method in class ResultGauge
The minimum dial value.
setNewClaimData(Map<String, Object>, Collection<String>, List<Map<String, Object>>) - Method in interface ClaimContext
Set data from which a claim can be created
setNewNumberOfTimeUnits(BigDecimal) - Method in class ScheduleSettings
Method that alters the schedule for next run.
setNewPeriodic(Boolean) - Method in class ScheduleSettings
Method that alters the schedule for next run.
setNewStartingDate(String) - Method in class ScheduleSettings
Method that alters the schedule for next run.
setNewTimeUnit(CalculationFlowTimeUnit) - Method in class ScheduleSettings
Method that alters the schedule for next run.
setObjectTypedIds(List<String>) - Method in class ItemSummaryQuery
 
setOnZAxis(Boolean) - Method in class AbstractChartMeasures
 
setOnZAxis(Boolean) - Method in class BoxplotChart.BoxplotAdditionalMeasure
 
setOnZAxis(Boolean) - Method in class ChartMeasures.Type
 
setOperator(int) - Method in class Filter
 
setOptions(Map<String, Object>) - Method in interface DatamartContext.Query
Allows for a number of query tweaking options, such as setting the target currency to convert to (if applicable), and requesting additional statistics to be calculated.
setParam(String, Object) - Method in interface DashboardApi
 
setParameterConfig(Map<String, Object>) - Method in class ContextParameter
 
setParameterGroup(String) - Method in class ContextParameter
 
setPartition(String) - Method in class ObjRefAction
 
setPostStepLogicFailed(boolean) - Method in class InsertWorkflowStepsDTO
 
setPreferenceName(String) - Method in class ResultMatrix
Sets the so-called preference name.
setPrefix(String) - Method in class ResultGauge
Set the label prefix.
setPriority(int) - Method in class CFSAction
Sets the prority of this job.
setPriority(int) - Method in class LivePriceGridAction
Sets the prority of this job.
setPriority(int) - Method in class ManualPricelistAction
Sets the prority of this job.
setPriority(int) - Method in class PricelistAction
Sets the prority of this job.
setPriority(int) - Method in class SimulationAction
Sets the prority of this job.
setProductFilter(Filter) - Method in class ItemSummaryQuery
 
setProductGroupBy(String) - Method in class ItemSummaryQuery
 
setProjections(List<ItemSummaryQuery.Projection>) - Method in class ItemSummaryQuery
 
setProperty(String) - Method in class Filter
 
setRank(int) - Method in interface IRebateRecordManager
Sets the rank on the default RR.
setRank(String, int) - Method in interface IRebateRecordManager
Sets the rank on the named RR.
setReadOnly(Boolean) - Method in class ContextParameter
 
setReason(String) - Method in class WorkflowDTO.ApprovalStepDTO
Deprecated.
setReason(String) - Method in class WorkflowDTO.WatcherStepDTO
 
setReason(List<String>) - Method in class WorkflowDTO.WatcherStepDTO
 
setRegressionType(String) - Method in class TrendLine
Assume a linear (y=a+bx) or exponential (y=a*e^bx) relationship between dependent variable y and independent variables x.
setRenderInfo(String, String, Object) - Method in class CalculableLineItemCollectionBuilder
Sets (adds or updates) rendering information for particular header fields (or buttons).
setRequired(Boolean) - Method in class ContextParameter
 
setResultMatrixTabs(ResultMatrix...) - Method in class ResultHighchart
The automatically filled data tab can be replaced by customized ResultMatrix data.
setRowValues(Map<String, Object>, long) - Method in interface Matrix2D
Modifies the value at the row coordinate, setting those values that match column names in the matrix.
setSharedCache(String, String) - Method in interface PublicGroovyAPI
Stores a string value in the shared cache with the given key.
setShowBandByLegend(Boolean) - Method in class AbstractChartSeries
 
setShowBandByLegend(Boolean) - Method in class ChartSeries.Aggregation
 
setShowBoxplot(Boolean) - Method in class AbstractChartSeries
 
setShowBoxplot(Boolean) - Method in class ChartSeries.EmbeddedBoxplot
 
setShowDataTab(boolean) - Method in class ResultHighchart
Show a tab set, with the chart in the first tab, and data grids in the other tabs.
setShowInLegend(Boolean) - Method in class AuxLine
 
setShowInLegend(Boolean) - Method in class TrendLine
 
setShowZAxis(Boolean) - Method in class AbstractChartOptions
 
setShowZAxis(Boolean) - Method in class ChartOptions.ZAxis
 
setSimulationSet(String) - Method in class ManualPricelistAction
Sets simulation set.
setSize(String) - Method in class PieChart.PieSeries
 
setSku(String) - Method in class ProductReferenceRecord
 
setSteepness(String) - Method in class AuxLine.Line
 
setSubmitReason(String) - Method in class WorkflowDTO
Overrides reason entered by submitter
setSubtitle(String) - Method in class AbstractChartOptions
 
setSubtitle(String) - Method in class ChartOptions.Basic
 
setSuffix(String) - Method in class ResultGauge
The label suffix.
setTargetDate(Date) - Method in class Formula
 
setTargetObjectTypeCode(Object) - Method in class ProductReferenceRecord
 
setTitle(String) - Method in class AbstractChartOptions
 
setTitle(String) - Method in class ChartOptions.Basic
 
setTitle(String) - Method in class ResultMatrix
Sets the title that will be shown as window title of the result matrix in the client
setToDate(Date) - Method in class TimeSeriesChart.TimeSeriesSeries
 
setType(SeriesType) - Method in class AbstractChartMeasures
 
setType(SeriesType) - Method in class AbstractChartSeries
 
setType(SeriesType) - Method in class ChartMeasures.Type
 
setType(SeriesType) - Method in class ChartSeries.EmbeddedBoxplot
 
setType(SeriesType) - Method in class DetailedTimeSeriesChart.DetailedTimeSeriesSeries
 
setTypeCode(String) - Method in class ObjRefAction
 
setTypedId(String) - Method in class ContextParameter
 
setURL(String) - Method in class ContextParameter
 
setValidAfter(Date) - Method in class ManualPricelistAction
Informs the runtime to work with MPL that is valid after the specified date.
setValue(Object) - Method in class Filter
 
setValue(Object, long, long) - Method in interface Matrix2D
Modifies the value at the given coordinates (row,col)
setValue(Object) - Method in class ContextParameter
 
setValue(BigDecimal) - Method in class ResultGauge
The current value on the dial.
setValueHint(String) - Method in class ContextParameter
 
setValueOptions(String[]) - Method in class ContextParameter
 
setValueOptions(List<String>) - Method in class ContextParameter
 
setVerticalLayout(Boolean) - Method in class PieChart.PieOptions
 
setWhisker(WhiskerType) - Method in class AbstractChartSeries
 
setWhisker(WhiskerType) - Method in class ChartSeries.EmbeddedBoxplot
 
setXLabel(String) - Method in class AbstractChartOptions
 
setXLabel(String) - Method in class ChartOptions.XYLabels
 
setXMax(BigDecimal) - Method in class AbstractChartOptions
 
setXMax(Date) - Method in class AbstractChartOptions
 
setXMax(BigDecimal) - Method in class ChartOptions.XYMinMax
 
setXMax(Date) - Method in class DetailedTimeSeriesChart.DetailedTimeSeriesOptions
 
setXMax(Date) - Method in class TimeSeriesScatterChart.TimeSeriesScatterOptions
 
setXMin(BigDecimal) - Method in class AbstractChartOptions
 
setXMin(Date) - Method in class AbstractChartOptions
 
setXMin(BigDecimal) - Method in class ChartOptions.XYMinMax
 
setXMin(Date) - Method in class DetailedTimeSeriesChart.DetailedTimeSeriesOptions
 
setXMin(Date) - Method in class TimeSeriesScatterChart.TimeSeriesScatterOptions
 
setXValue(String) - Method in class AuxLine.VerticalLine
 
setYIntercept(String) - Method in class AuxLine.Line
 
setYLabel(String) - Method in class AbstractChartOptions
 
setYLabel(String) - Method in class ChartOptions.XYLabels
 
setYMax(BigDecimal) - Method in class AbstractChartOptions
 
setYMax(BigDecimal) - Method in class ChartOptions.XYMinMax
 
setYMax(BigDecimal) - Method in class ChartOptions.ZAxis
 
setYMax(BigDecimal) - Method in class TimeSeriesScatterChart.TimeSeriesScatterOptions
 
setYMin(BigDecimal) - Method in class AbstractChartOptions
 
setYMin(BigDecimal) - Method in class ChartOptions.XYMinMax
 
setYMin(BigDecimal) - Method in class ChartOptions.ZAxis
 
setYMin(BigDecimal) - Method in class TimeSeriesScatterChart.TimeSeriesScatterOptions
 
setZLabel(String) - Method in class AbstractChartOptions
 
setZLabel(String) - Method in class ChartOptions.ZAxis
 
setZMax(BigDecimal) - Method in class AbstractChartOptions
 
setZMax(BigDecimal) - Method in class ChartOptions.ZAxis
 
setZMax(BigDecimal) - Method in class HeatmapChart.HeatmapOptions
 
setZMin(BigDecimal) - Method in class AbstractChartOptions
 
setZMin(BigDecimal) - Method in class ChartOptions.ZAxis
 
setZMin(BigDecimal) - Method in class HeatmapChart.HeatmapOptions
 
show() - Method in class AdaptiveHistogram
Shows the histograms' underlying data structure.
showDataTab() - Method in class ResultHighchart
Short for setShowDataTab(true)
showEmbedded() - Method in interface DashboardApi
 
SimulationAction<ATTACHEDTO extends Help> - Class in net.pricefx.common.apibuilder.calculationflowaction
This action starts calculation of selected simulation.
SimulationAction(ATTACHEDTO, Invocations<MethodInvocationRecord>, String) - Constructor for class SimulationAction
 
Size(PieChart.PieSeries, String) - Constructor for class PieChart.Size
 
sku - Variable in class ProductReferenceRecord
The sku that reference is for
some(String, Filter) - Static method in class Filter
Create a new Filter using the SOME operator.
sortRows(long) - Method in interface Matrix2D
 
sortRowsReverse(long) - Method in interface Matrix2D
 
SortType - Enum in net.pricefx.common.api.chart
 
sourceSelectionEntry(String, String...) - Method in interface DatamartContext
 
std() - Method in interface Matrix2D
 
StepDTO(WorkflowDTO, String) - Constructor for class WorkflowDTO.StepDTO
 
stepHistory - Variable in class WorkflowInfo.WorkflowStepInfo
 
SteppedLine(C, String, String) - Constructor for class AuxLine.SteppedLine
 
steps - Variable in class WorkflowInfo
The ordered steps of this workflow
stepType - Variable in class WorkflowInfo.WorkflowStepInfo
Either APPROVAL or WATCHER Watchers are just notified and do not need to act.
stream(String, String, Filter...) - Method in interface PublicGroovyAPI
Searches for all types of objects with a freestyle query and iterates over the result set.
stream(String, String, List<String>, Filter...) - Method in interface PublicGroovyAPI
Searches for all types of objects with a freestyle query and iterates over the result set.
stream(String, String, List<String>, boolean, Filter...) - Method in interface PublicGroovyAPI
Searches for all types of objects with a freestyle query and iterates over the result set.
stream(String, String, Map<String, String>, boolean, Filter...) - Method in interface PublicGroovyAPI
Searches for all types of objects with a freestyle query and iterates over the result set.
streamQuery(DatamartContext.Query) - Method in interface DatamartContext
Executes the given DatamartContext.Query and return so that it can be examined one row at the time.
StreamResults - Interface in net.pricefx.server.protocol
Unifying (and very limited) JDBC ResultSet like API to a forward-only cursor on a query result, either from a Hibernate or PA query.
stringUserEntry(String) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user enter a short text value.
stringUserEntry(String, String) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user enter a short text value.
stringUserEntry(String, String, String) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user enter a short text value.
styledCell(Object) - Method in class ResultMatrix
Creates a styled cell that can then be added as row value
styledCell(Object, String, String) - Method in class ResultMatrix
Creates a styled cell that can then be added as row value
styledCell(Object, String, String, String) - Method in class ResultMatrix
Creates a styled cell that can then be added as row value
styledCell(Object, String, String, String, String) - Method in class ResultMatrix
Creates a styled cell that can then be added as row value
submitAfterBuild() - Method in class RATBuilder.RABuilder
 
sum() - Method in interface Matrix2D
 
switchSKUContext(String) - Method in interface PublicGroovyAPI
Temporarily switches the current SKU context to another SKU.

T

TableContext - Class in net.pricefx.formulaengine
This class is the central starting point for in-memory data table operations.
TableContext(FormulaEngineContext) - Constructor for class TableContext
 
TableContext(PersistedObjectService, String) - Constructor for class TableContext
 
targetDate() - Method in interface PublicGroovyAPI
Retrieves the mandatory parameter targetDate from the current execution context.
targetObjectTypeCode - Variable in class ProductReferenceRecord
Type Code of target parent object.
targetPage - Variable in class ResultMatrix.ResultMatrixLinkCell
 
targetPageState - Variable in class ResultMatrix.ResultMatrixLinkCell
 
targetRAUniqueName() - Method in class RATBuilder
 
templateTypeId() - Method in class RATBuilder
 
textUserEntry(String) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user enter a longer text value.
textUserEntry(String, String) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user enter a longer text value.
throwException(String) - Method in interface PublicGroovyAPI
Throws a calculation exception with the specified message and aborts the calculation.
timePeriodAsFilter(CalendarUtil.TimePeriod, String) - Method in interface DatamartContext.Calendar
Helper method to build a filter representing dateDimFieldName in [timePeriod.startPeriod, timePeriod.endPeriod] Note the inclusion on both ends; this is to accommodate the most frequent use case where the TimePeriod is a single period, for example InvoiceDate in [2015,2015].
TimeSeriesAdditionalMeasure(TimeSeriesChart.TimeSeriesSeries, String) - Constructor for class TimeSeriesChart.TimeSeriesAdditionalMeasure
 
TimeSeriesChart - Class in net.pricefx.common.apibuilder.chart
Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at https://api.highcharts.com/class-reference/Highcharts.Chart.
TimeSeriesChart(IdGenerator, Invocations<MethodInvocation>) - Constructor for class TimeSeriesChart
 
TimeSeriesChart.TimeSeriesAdditionalMeasure - Class in net.pricefx.common.apibuilder.chart
 
TimeSeriesChart.TimeSeriesOptions - Class in net.pricefx.common.apibuilder.chart
 
TimeSeriesChart.TimeSeriesSeries - Class in net.pricefx.common.apibuilder.chart
 
TimeSeriesOptions(TimeSeriesChart, String) - Constructor for class TimeSeriesChart.TimeSeriesOptions
 
TimeSeriesScatterAdditionalMeasure(TimeSeriesScatterChart.TimeSeriesScatterSeries, String) - Constructor for class TimeSeriesScatterChart.TimeSeriesScatterAdditionalMeasure
 
TimeSeriesScatterChart - Class in net.pricefx.common.apibuilder.chart
Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at https://api.highcharts.com/class-reference/Highcharts.Chart.
TimeSeriesScatterChart(IdGenerator, Invocations<MethodInvocation>) - Constructor for class TimeSeriesScatterChart
 
TimeSeriesScatterChart.TimeSeriesScatterAdditionalMeasure - Class in net.pricefx.common.apibuilder.chart
 
TimeSeriesScatterChart.TimeSeriesScatterOptions - Class in net.pricefx.common.apibuilder.chart
 
TimeSeriesScatterChart.TimeSeriesScatterSeries - Class in net.pricefx.common.apibuilder.chart
 
TimeSeriesScatterOptions(TimeSeriesScatterChart, String) - Constructor for class TimeSeriesScatterChart.TimeSeriesScatterOptions
 
TimeSeriesScatterSeries(TimeSeriesScatterChart, String) - Constructor for class TimeSeriesScatterChart.TimeSeriesScatterSeries
 
TimeSeriesSeries(TimeSeriesChart, String) - Constructor for class TimeSeriesChart.TimeSeriesSeries
 
timeUserEntry(String) - Method in interface PublicGroovyAPI
Creates an input parameter that lets the user to enter a time value in format "HH:mm" (e.g.
toDBDataType(DataType) - Method in class TableContext
Converts a Price f(x) datatype into a in-memory database datatype.
toMap() - Method in class WorkflowDTO.ApprovalStepDTO
 
toMap() - Method in class WorkflowDTO.StepDTO
 
toMap() - Method in class WorkflowDTO.WatcherStepDTO
 
toMatrix2D() - Method in class ResultMatrix
 
tooltip - Variable in class ResultMatrix.ResultMatrixStyledCell
 
toQueryString() - Method in class Filter
 
toResultMatrix() - Method in interface Matrix2D
 
toResultMatrix(Map<String, String>) - Method in interface Matrix2D
Create a ResultMatrix from a Matrix2D, selecting only the columns included in the mapping if such a mapping is provided.
toString() - Method in class Filter
 
toString() - Method in class CFSAction
 
toString() - Method in class DataLoadAction
 
toString() - Method in class ExportAction
 
toString() - Method in class LivePriceGridAction
 
toString() - Method in class ManualPricelistAction
 
toString() - Method in class ObjRefAction
 
toString() - Method in class PriceAPIAction
 
toString() - Method in class PricelistAction
 
toString() - Method in class RebateRecordAction
 
toString() - Method in class ScheduleSettings
 
toString() - Method in class SimulationAction
 
toString() - Method in class RATBuilder.RABuilder
 
toString() - Method in class ContextParameter
 
toString() - Method in class ResultMatrix
 
toTable() - Method in class AdaptiveHistogram
Return a table representing the data in this histogram.
TOTAL_KEY - Static variable in class ItemSummaryQuery
 
trace(String, String, Object) - Method in interface PublicGroovyAPI
Generates a trace message that can be used in the logic test drive.
trace(String, Object) - Method in interface PublicGroovyAPI
Generates a trace message that can be used in the logic test drive.
trace(Object) - Method in interface PublicGroovyAPI
Generates a trace message that can be used in the logic test drive.
transpose(String) - Method in class ResultMatrix
Transpose the matrix.
transpose(String, String) - Method in class ResultMatrix
Transpose the matrix.
TrendLine<S extends AbstractChartSeries<?,?>> - Class in net.pricefx.common.apibuilder.chart
 
TrendLine(S, String, String) - Constructor for class TrendLine
 
triggerCFSCalculation(Long) - Method in interface PublicGroovyAPI
Creates a new background calculation job for the specified CFS.
triggerEvent(String) - Method in class AbstractChartEvent
 
TriggerEvent(String) - Constructor for class AbstractChartEvent.TriggerEvent
 
triggerEvent(String) - Method in class BarLineChart.BarLineOnChartClick
 
triggerEvent(String) - Method in class ChartEvents.OnCellClick
 
triggerEvent(String) - Method in class ChartEvents.OnRowClick
 
triggerEvent(String) - Method in class ScatterChart.ScatterOnChartClick
 
triggerEvent(String) - Method in class ResultMatrix.ResultMatrixOnRowSelection
 
TriggerEvent(HashMap<String, String>) - Constructor for class ResultMatrix.ResultMatrixOnRowSelection.TriggerEvent
 
triggerPriceGridCalculation(Long, Map<String, Object>) - Method in interface PublicGroovyAPI
Creates a new background calculation job for the specified price grid.
Type(S, String) - Constructor for class ChartMeasures.Type
 
type - Variable in class DashboardController.ControllerItem
 
type - Variable in class ResultMatrix.AbstractResultMatrixCell
 

U

uniqueName - Variable in class WorkflowDTO.StepDTO
 
uniqueName - Variable in class WorkflowInfo.WorkflowStepInfo
The unique workflow step identifier
update(String, String, Map<?, ?>...) - Method in interface PayoutRecordManager
Updates the existing PayoutRecord, if any, identified by the given type & name
update(String, Map<String, Object>) - Method in interface PublicGroovyAPI
Updates an object in the collection of objects of the given type.
update(ContextParameter) - Method in class ContextParameter
 
updateCalculableObjectHeader(String, String) - Method in interface PublicGroovyAPI
Updates the header information of a CalculableObject (e.g., a price grid, a price list, etc.).
updateField(String, String, Object) - Method in class CalculableLineItemCollectionBuilder
Updates a field on the line.
updateField(String, Object) - Method in class CalculableLineItemCollectionBuilder
Updates a header field value For quotes supported fields are: additionalInfo1 additionalInfo2 additionalInfo3 additionalInfo4 externalRef expiryDate editabilityStatus targetDate label userGroupEdit userGroupViewDetails
updateFromFormulaInputDescriptor(FormulaInputDescriptor) - Method in class ContextParameter
 
updateWithLookupTable(LookupTable) - Method in class ContextParameter
This is a convenience method to update a ContextParameter with a new version of the same lookup table This can happen e.g.
user(String) - Method in interface PublicGroovyAPI
Returns a value from the current user's master data.
user() - Method in interface PublicGroovyAPI
Returns the entire master data object of the current user.
userApprovers - Variable in class WorkflowInfo.WorkflowStepInfo
A list of users that can approve
userEntry(String) - Method in interface PublicGroovyAPI
Triggers a numeric input element.
userGroupApprovers - Variable in class WorkflowInfo.WorkflowStepInfo
A list of groups that can approve
userGroupLabel - Variable in class WorkflowInfo.WorkflowStepInfo
Deprecated.
uuid(int) - Method in interface PublicGroovyAPI
Generates a random uuid of the specified length.
uuid(int, int) - Method in interface PublicGroovyAPI
Generates a random uuid of the specified length and radix.
uuid() - Method in interface PublicGroovyAPI
Generates a RFC4122, version 4 ID.

V

value - Variable in class Filter
The value to compare the property with.
value - Variable in class ResultMatrix.AbstractResultMatrixCell
 
valueOf(String) - Static method in enum AggregationFormula
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum AuxLineColor
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum AuxLineType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ChartType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ColorAxisType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ComparisonType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum FilterOperator
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum LimitPosition
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum LimitType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum SeriesType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum SortType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum WaterfallColumnType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum WhiskerType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum FieldFormatType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum Matrix2D.BucketNaming
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum DashboardController.ControllerItemType
Returns the enum constant of this type with the specified name.
values() - Static method in enum AggregationFormula
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum AuxLineColor
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum AuxLineType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ChartType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ColorAxisType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ComparisonType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum FilterOperator
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum LimitPosition
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum LimitType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum SeriesType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum SortType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum WaterfallColumnType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum WhiskerType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum FieldFormatType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum Matrix2D.BucketNaming
Returns an array containing the constants of this enum type, in the order they are declared.
values - Variable in class DashboardController.ControllerItem
 
values() - Static method in enum DashboardController.ControllerItemType
Returns an array containing the constants of this enum type, in the order they are declared.
VerticalLine(C, String, String) - Constructor for class AuxLine.VerticalLine
 
vLookup(String) - Method in interface PublicGroovyAPI
Searches for a record in the price parameter table named parameterName where the column 'name' matches the value entered by the user and returns the value from the column 'value'.
vLookup(String, Object) - Method in interface PublicGroovyAPI
Searches for a record in the price parameter table named parameterName where the column 'name' (for LTV or MLTV) or 'key1' (for MLTV2-6) matches the attributeNameOrKeyOrRangeValue value and returns the value from the column 'value' (LTV) or 'attribute1' (MLTV).
vLookup(String, String, String) - Method in interface PublicGroovyAPI
This syntax is only relevant for MATRIX 1-key price parameter tables (MLTV).
vLookup(String, String, String, String) - Method in interface PublicGroovyAPI
This syntax is only relevant for MATRIX 2-key price parameter tables (MLTV2).
vLookup(String, String, String, String, String) - Method in interface PublicGroovyAPI
This syntax is only relevant for MATRIX 3-key price parameter tables (MLTV3).
vLookup(String, String, String, String, String, String) - Method in interface PublicGroovyAPI
This syntax is only relevant for MATRIX 4-key price parameter tables (MLTV4).
vLookup(String, String, String, String, String, String, String) - Method in interface PublicGroovyAPI
This syntax is only relevant for MATRIX 5-key price parameter tables (MLTV5).
vLookup(String, String, String, String, String, String, String, String) - Method in interface PublicGroovyAPI
This syntax is only relevant for MATRIX 6-key price parameter tables (MLTV6).

W

walkFilter(Filter, Closure<?>, Closure<?>, boolean) - Method in interface PublicGroovyAPI
Walks a filter and all its sub filters, visiting each filter in the tree.
watcherEmails - Variable in class WorkflowInfo.WorkflowStepInfo
 
WatcherStepDTO(WorkflowDTO, String) - Constructor for class WorkflowDTO.WatcherStepDTO
 
WaterfallChart - Class in net.pricefx.common.apibuilder.chart
Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at https://api.highcharts.com/class-reference/Highcharts.Chart.
WaterfallChart(IdGenerator, Invocations<MethodInvocation>) - Constructor for class WaterfallChart
 
WaterfallChart.Aggregation - Class in net.pricefx.common.apibuilder.chart
 
WaterfallChart.WaterfallOptions - Class in net.pricefx.common.apibuilder.chart
 
WaterfallChart.WaterfallSeries - Class in net.pricefx.common.apibuilder.chart
 
WaterfallColumnType - Enum in net.pricefx.common.api.chart
 
WaterfallComparisonChart - Class in net.pricefx.common.apibuilder.chart
Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at https://api.highcharts.com/class-reference/Highcharts.Chart.
WaterfallComparisonChart(IdGenerator, Invocations<MethodInvocation>) - Constructor for class WaterfallComparisonChart
 
WaterfallComparisonChart.Aggregation - Class in net.pricefx.common.apibuilder.chart
 
WaterfallComparisonChart.WaterfallComparisonOptions - Class in net.pricefx.common.apibuilder.chart
 
WaterfallComparisonChart.WaterfallComparisonSeries - Class in net.pricefx.common.apibuilder.chart
 
WaterfallComparisonOptions(WaterfallComparisonChart, String) - Constructor for class WaterfallComparisonChart.WaterfallComparisonOptions
 
WaterfallComparisonSeries(WaterfallComparisonChart, String) - Constructor for class WaterfallComparisonChart.WaterfallComparisonSeries
 
WaterfallOptions(WaterfallChart, String) - Constructor for class WaterfallChart.WaterfallOptions
 
WaterfallSeries(WaterfallChart, String) - Constructor for class WaterfallChart.WaterfallSeries
 
where(DatamartContext.DataSlice) - Method in interface DatamartContext.Query
 
where(ProductGroup) - Method in interface DatamartContext.Query
Adds a ProductGroup filter condition to the query's WHERE clause, for example a product group from an InputEntry("ProductGroup") parameter.
where(CustomerGroup) - Method in interface DatamartContext.Query
Adds a CustomerGroup condition to the query's WHERE clause, for example a customer group from an InputEntry("CustomerGroup") parameter.
where(String...) - Method in interface DatamartContext.Query
Parses and ANDs one or more SQL-like conditions to the query's WHERE clause.
where(Filter...) - Method in interface DatamartContext.Query
Adds generic Filters to the query's WHERE clause.
WhiskerType - Enum in net.pricefx.common.api.chart
 
withAddStepRestrictedToWFAdmin() - Method in class WorkflowDTO
 
withAddStepRestrictedToWFAdmin(boolean) - Method in class WorkflowDTO
 
withAggregation(String) - Method in class AbstractChartMeasures
 
withAggregation(AggregationFormula) - Method in class AbstractChartMeasures
 
withAggregation(String) - Method in class ChartMeasures.Basic
 
withAggregation(AggregationFormula) - Method in class ChartMeasures.Basic
 
withAggregationByAsEventDataAttr() - Method in class ChartEvents.OnChartClick.ClickTriggerEvent
 
withAggregationByAsEventDataAttr() - Method in class ScatterChart.ScatterOnChartClick.ScatterTriggerEvent
 
withAlignment(String) - Method in class ResultMatrix.ResultMatrixStyledCell
Specify the alignment of the cell
withAlreadySatisfied() - Method in class WorkflowDTO.StepDTO
Mark current step as already satisfied, workflowengine will skip its processing once marked as satisfied.
withAlreadySatisfied(String) - Method in class WorkflowDTO.StepDTO
Mark current step as already satisfied, workflowengine will skip its processing once marked as satisfied.
withAnyDimensionAsEventDataAttr() - Method in class ChartEvents.OnCellClick.CellClickTriggerEvent
 
withAnyDimensionAsEventDataAttr() - Method in class ChartEvents.OnRowClick.RowClickTriggerEvent
 
withApprovalRequiredEmailAttachment(Object) - Method in class WorkflowDTO.ApprovalStepDTO
 
withApprovalRequiredEmailAttachments(Object) - Method in class WorkflowDTO.ApprovalStepDTO
 
withApprover(String) - Method in class WorkflowDTO.ApprovalStepDTO
Deprecated.
Last invoked of #withApprover(String), #withUserGroupApprover(String) wins
withApprovers(String...) - Method in class WorkflowDTO.ApprovalStepDTO
Last invoked of #withApprovers(String...), #withUserGroupApprovers(String...) wins
withAutoConvertToDeal(boolean) - Method in class WorkflowDTO
If true then automatically converts quote to deal when quote is approved
withBackground(String) - Method in class ResultMatrix.ResultMatrixStyledCell
Set the background color of the cell
withBackgroundColor(String) - Method in class AttributedResult
Sets the background color.
withBandByAsEventDataAttr() - Method in class ChartEvents.OnChartClick.ClickTriggerEvent
 
withBandByAsEventDataAttr() - Method in class ScatterChart.ScatterOnChartClick.ScatterTriggerEvent
 
withBoxplotExpression() - Method in class AbstractChartMeasures
 
withBoxplotExpression() - Method in class ChartMeasures.EmbeddedBoxplot
 
withBoxplotField() - Method in class AbstractChartMeasures
 
withBoxplotField() - Method in class ChartMeasures.EmbeddedBoxplot
 
withColor(String) - Method in class ResultMatrix.ResultMatrixStyledCell
Set the foreground color of the value font
withColValueAsEventDataAttr(String, String) - Method in class ResultMatrix.ResultMatrixOnRowSelection.TriggerEvent
 
withCSS(String) - Method in class ResultMatrix.ResultMatrixStyledCell
Apply any other valid CSS instructions to the cell
withDataMap(Map<String, Object>) - Method in class WorkflowDTO
Sets dataMap map, which is available then in email templates
withDefaultPostApprovalStepLogic(String) - Method in class WorkflowDTO
Adds a logic that will be executed after every approval step.
withDenialReasons(List<String>, boolean) - Method in class WorkflowDTO.ApprovalStepDTO
 
withDenialReasons(List<String>, boolean) - Method in class WorkflowDTO
 
withDimensionAsEventDataAttr(String) - Method in class ChartEvents.OnCellClick.CellClickTriggerEvent
 
withDimensionAsEventDataAttr(String) - Method in class ChartEvents.OnRowClick.RowClickTriggerEvent
 
withEmailAttachment() - Method in class WorkflowDTO.StepDTO
Makes the step send the attachment along with the notification Same as withEmailAttachment(true)
withEmailAttachment(Boolean) - Method in class WorkflowDTO.StepDTO
Makes the step send the attachment along with the notification
withEmailAttachmentTemplateName(String) - Method in class WorkflowDTO.StepDTO
 
withEmailListWatcher(String...) - Method in class WorkflowDTO.WatcherStepDTO
Instead of specifying a user name or a user group, arbitrary email addresses can be used here Last invoked of #withUserWatchers(String...), #withUserGroupWatchers(String...), #withEmailListWatcher(String...) wins
withEventDataAttr(String) - Method in interface DashboardApi
 
withExcludeSubmitter(boolean) - Method in class WorkflowDTO.ApprovalStepDTO
Set exclude submitter
withExpression() - Method in class AbstractChartMeasures
 
withExpression() - Method in class NonAggrFieldAxis
 
withField() - Method in class BoxplotChart.BoxplotAdditionalMeasure
 
withField() - Method in class NonAggrFieldAxis
 
withFontWeight(String) - Method in class ResultMatrix.ResultMatrixStyledCell
Set the font weight (in standard CSS terms) of the value text
withFormula() - Method in class AbstractChartMeasures
 
withFormula() - Method in class ChartMeasures.Basic
 
withGroupByAsEventDataAttr() - Method in class ScatterChart.ScatterOnChartClick.ScatterTriggerEvent
withInterpolatedColorAxis() - Method in class HeatmapChart.HeatmapOptions
 
withLine() - Method in class AuxLine
 
withMandatoryComments(String...) - Method in class WorkflowDTO.ApprovalStepDTO
Makes comment mandatory for certain actions.
withManualOverrideAllowEmpty(Boolean) - Method in class AttributedResult
In case the result element is overridable, this method defines if the selection box shows also the "empty value" option.
withManualOverrideValueOptions(List<Object>) - Method in class AttributedResult
In case the result element is overridable, this method defines a set (list) of values tha the user can pick from (vs.
withMinApprovalsForGroups(Integer...) - Method in class WorkflowDTO.ApprovalStepDTO
A minimum number of approvals needed for each group, to consider this step as approved.
withMinApprovalsNeeded(int) - Method in class WorkflowDTO.ApprovalStepDTO
A minimum number of approvals needed to consider this step as approved.
withMultipleApprovalByGroupsAllowed(boolean) - Method in class WorkflowDTO.ApprovalStepDTO
Deprecated.
withNotificationOnlyToUsers(String...) - Method in class WorkflowDTO.ApprovalStepDTO
Subset of approvers that should receive the email notification
withPercent() - Method in class AbstractChartMeasures
 
withPercent() - Method in class ChartMeasures.Basic
 
withPerUnit() - Method in class AbstractChartMeasures
 
withPerUnit() - Method in class ChartMeasures.Basic
 
withPostStepLogic(String) - Method in class WorkflowDTO.ApprovalStepDTO
Sets post step logic name that should be run after this step is executed (i.e.
withRangedColorAxis() - Method in class HeatmapChart.HeatmapOptions
 
withRawCSS(String) - Method in class AttributedResult
Adds any valid CSS style to the cell.
withReasons(String...) - Method in class WorkflowDTO.ApprovalStepDTO
Sets explanations for the approval step.
withReasons(String...) - Method in class WorkflowDTO.WatcherStepDTO
Sets explanations for the watcher step.
withRunDefaultPostApprovalStepLogicOnEmptyWorkflow(boolean) - Method in class WorkflowDTO
Decides if default post step logic should be executed also in case the wf is empty (has no steps).
withSelectStepOnDeny(boolean) - Method in class WorkflowDTO
 
withSingleUserMultiApprovalAllowed(boolean) - Method in class WorkflowDTO.ApprovalStepDTO
 
withSortByAxisX(SortType) - Method in class AbstractChartSeries
 
withSortByAxisX(SortType) - Method in class BarLineChart.BarLineSeries
 
withSortByAxisX(SortType) - Method in class BoxplotChart.BoxplotSeries
 
withSortByAxisX(SortType) - Method in class HeatmapChart.HeatmapSeries
 
withSortByAxisX(SortType) - Method in class HistogramChart.HistogramSeries
 
withSortByAxisY(SortType) - Method in class AbstractChartSeries
 
withSortByAxisY(SortType) - Method in class BarLineChart.BarLineSeries
 
withSortByAxisY(SortType) - Method in class HeatmapChart.HeatmapSeries
 
withSortByAxisY(SortType) - Method in class HistogramChart.HistogramSeries
 
withSortByCategories(SortType) - Method in class PieChart.PieSeries
 
withSortBySize(SortType) - Method in class PieChart.PieSeries
 
withSteppedLine() - Method in class AuxLine
 
withSuffix(String) - Method in class AttributedResult
Sets a suffix to be appended to the result.
withTextColor(String) - Method in class AttributedResult
Sets the text (foreground) color.
withTextDecoration(String) - Method in class AttributedResult
Sets the decoration to be added to the resulting text.
withToolTip(String) - Method in class ResultMatrix.ResultMatrixStyledCell
Show a tooltip text in the cell
withTotal() - Method in class AbstractChartMeasures
 
withTotal() - Method in class ChartMeasures.Basic
 
withTrendLine() - Method in class AbstractChartSeries
 
withTrendLine() - Method in class BubbleChart.BubbleSeries
 
withTrendLine() - Method in class ScatterChart.ScatterSeries
 
withTrendLine() - Method in class TimeSeriesChart.TimeSeriesSeries
 
withUserGroupApprover(String) - Method in class WorkflowDTO.ApprovalStepDTO
Deprecated.
Last invoked of #withApprover(String), #withUserGroupApprover(LString) wins
withUserGroupApprover(String, boolean) - Method in class WorkflowDTO.ApprovalStepDTO
Deprecated.
Same as #withUserGroupApprover(String) but the submitter is excluded in case he is memeber of the group Last invoked of #withApprover(String), #withUserGroupApprover(String) wins
withUserGroupApprovers(String...) - Method in class WorkflowDTO.ApprovalStepDTO
Last invoked of #withApprovers(String...), #withUserGroupApprovers(String...) wins
withUserGroupWatcher(String) - Method in class WorkflowDTO.WatcherStepDTO
Deprecated.
Specify user group as recipient Last invoked of #withUserWatcher(String), #withUserGroupWatcher(String), #withEmailListWatcher(String...) wins
withUserGroupWatchers(String...) - Method in class WorkflowDTO.WatcherStepDTO
Specify user groups as recipient Last invoked of #withUserWatchers(String...), #withUserGroupWatchers(String...), #withEmailListWatchers(String...) wins
withUserWatcher(String) - Method in class WorkflowDTO.WatcherStepDTO
Deprecated.
Specify a user as recipient Last invoked of #withUserWatcher(String), #withUserGroupWatcher(String), #withEmailListWatcher(String...) wins
withUserWatchers(String...) - Method in class WorkflowDTO.WatcherStepDTO
Specify users as recipients Last invoked of #withUserWatchers(String...), #withUserGroupWatchers(String...), #withEmailListWatcher(String...) wins
withVerticalLine() - Method in class AuxLine
 
withWhisker(WhiskerType) - Method in class BoxplotChart.BoxplotSeries
 
withXAsEventDataAttr() - Method in class BarLineChart.BarLineOnChartClick.BarLineTriggerEvent
 
withXAsEventDataAttr() - Method in class ChartEvents.OnChartClick.ClickTriggerEvent
 
workflow - Variable in class WorkflowDTO.StepDTO
 
WorkflowDTO - Class in net.pricefx.common.dto
This class is basically the type that is exposed by the workflow formula binding workflow
So in your workflow formula you would call methods on that instance to add approval nodes and/or watcher nodes and supply further details while doing so.
The methods are designed to be used in a simple flow pattern.
Simple example:
WorkflowDTO(WorkflowType, String, String, boolean) - Constructor for class WorkflowDTO
 
WorkflowDTO(WorkflowType, String) - Constructor for class WorkflowDTO
 
WorkflowDTO.ApprovalStepDTO - Class in net.pricefx.common.dto
 
WorkflowDTO.StepDTO<T extends WorkflowDTO.StepDTO> - Class in net.pricefx.common.dto
 
WorkflowDTO.WatcherStepDTO - Class in net.pricefx.common.dto
 
WorkflowInfo - Class in net.pricefx.workflowengine
This structure represents an entire workflow with multiple steps.
WorkflowInfo() - Constructor for class WorkflowInfo
 
WorkflowInfo.WorkflowStepInfo - Class in net.pricefx.workflowengine
This structure describes each workflow step in detail
WorkflowStepInfo() - Constructor for class WorkflowInfo.WorkflowStepInfo
 
wrap(Object) - Method in interface PublicGroovyAPI
Wraps a result to make sure the original result object appears in the JSON response.
WrappedResult - Class in net.pricefx.server.dto.calculation
Makes sure that a result appears "as-is" in the fromula result This is e.g.
WrappedResult(Object) - Constructor for class WrappedResult
 

X

XYLabels(C, String) - Constructor for class ChartOptions.XYLabels
 
XYMinMax(C, String) - Constructor for class ChartOptions.XYMinMax
 

Y

yellowAlert(String) - Method in interface PublicGroovyAPI
Marks the current logic element with a yellow alert and provides the given message.

Z

ZAxis(C, String) - Constructor for class ChartOptions.ZAxis
 
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 
Skip navigation links

Copyright © 2019. All rights reserved.