Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- ABC - Enum constant in enum class Matrix2D.BucketNaming
- ABORT - Enum constant in enum class Pricelist.PricelistErrorModeType
- abortCalculation() - Method in interface PublicGroovyAPI
-
Aborts the current item (e.g. price list line, quote line) calculation - i.e. stops the execution of subsequent elements of the logic.
- abortCalculation(boolean) - Method in interface PublicGroovyAPI
-
Aborts the current item calculation.
- abortSyntaxCheck() - Method in interface PublicGroovyAPI
-
Aborts the current item parameter determination.
- AbstractChartBuilder<C> - Class in net.pricefx.common.apibuilder.chart
- AbstractChartBuilder(String, IdGenerator, Invocations<MethodInvocation>) - Constructor for class AbstractChartBuilder
- AbstractChartEvent<C,
E> - Class in net.pricefx.common.apibuilder.chart - AbstractChartEvent(C) - Constructor for class AbstractChartEvent
- AbstractChartEvent.TriggerEvent<T> - Class in net.pricefx.common.apibuilder.chart
- AbstractChartMeasures<S,
M> - Class in net.pricefx.common.apibuilder.chart - AbstractChartMeasures(S, String) - Constructor for class AbstractChartMeasures
- AbstractChartOptions<C,
O> - Class in net.pricefx.common.apibuilder.chart - AbstractChartOptions(C, String) - Constructor for class AbstractChartOptions
- AbstractChartSeries<C,
S> - Class in net.pricefx.common.apibuilder.chart - AbstractChartSeries(C, String) - Constructor for class AbstractChartSeries
- AbstractInputBuilder<T,
VT> - Class in net.pricefx.formulaengine.scripting.inputbuilder - AbstractInputBuilder(InputBuilderContext) - Constructor for class AbstractInputBuilder
- AbstractInputBuilder(InputBuilderContext, InputType, String) - Constructor for class AbstractInputBuilder
- AbstractInputBuilder.InputWidth - Enum Class in net.pricefx.formulaengine.scripting.inputbuilder
- AbstractProductAndCustomerInputBuilder<T,
VT> - Class in net.pricefx.formulaengine.scripting.inputbuilder - AbstractProductAndCustomerInputBuilder(InputBuilderContext, InputType, String) - Constructor for class AbstractProductAndCustomerInputBuilder
- AbstractResultMatrixCell() - Constructor for class ResultMatrix.AbstractResultMatrixCell
-
Deprecated.
- accessNumericField(Class<?>, String, String) - Method in interface ItemSummaryQuery.QueryGeneratorCallback
- action(String) - Method in class ModelCalculationAction
-
Execute one of the actions declared in the
ModelObject
'sModelClass
. - ACTION_STATUS - Enum constant in enum class EventType
- actionItemApi() - Method in interface PublicGroovyAPI
-
Returns a
ActionItemApi
instance for operations related to Action Items and Actionable Insights. - ActionItemApi - Class in net.pricefx.server.dto.calculation
-
Utility class to work with Action Items in Groovy code
- ActionItemApi(FormulaEngineContext, ActionItemManager) - Constructor for class ActionItemApi
- ActionItemApi.ActionItemBuilder - Class in net.pricefx.server.dto.calculation
- ActionItemBuilder(FormulaEngineContext, Long, ActionItemManager) - Constructor for class ActionItemApi.ActionItemBuilder
- ActionItemBuilder(FormulaEngineContext, ActionItemManager) - Constructor for class ActionItemApi.ActionItemBuilder
- 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(Integer) - Method in class CalendarUtil.TimePeriod
- add(String, int, String) - Method in class CalendarUtil
- add(String, int, String) - Method in interface DatamartContext.Calendar
-
Parses a period string and offsets the start date of the resulting TimePeriod with a number of TimeUnits.
- add(String, String, Map<?, ?>...) - Method in interface IRebateRecordManager
-
Adds a Rebate Record (RR) / Compensation Record (COR) in the specified Rebate Record Set / Compensation Record Set to the current Rebate Agreement / Compensation line item (
RBALI
orCOLI
). - add(String, String, Map<?, ?>...) - Method in interface PayoutRecordManager
-
Adds a new PayoutRecord or AccrualRecord, specified by the type and name.
- add(String, Map<?, ?>...) - Method in interface IRebateRecordManager
-
Adds a Rebate Record (RR) / Compensation Record (COR) with the specified name and attribute values to the current Rebate Agreement / Compensation line item (RBALI / COLI).
- add(String, Map<String, Object>) - Method in interface PublicGroovyAPI
-
Adds a new object to the collection of objects of the given type.
- add(Map<?, ?>...) - Method in interface IRebateRecordManager
-
Adds a Rebate Record (RR) / Compensation Record (COR) with the default name and attribute values to the current Rebate Agreement / Compensation line item (RBALI / COLI).
- ADD - Enum constant in enum class WaterfallColumnType
- ADD_ITEM_NOOVERRIDE - Enum constant in enum class Pricelist.ProcessingMode
-
Adds items from product selection criteria to list Will NOT overwrite existing results
- ADD_ITEM_OVERRIDE - Enum constant in enum class Pricelist.ProcessingMode
-
Adds items from product selection criteria to list Will overwrite existing results
- addAdditionalConfigValue(String, String) - Method in class ConfiguratorEntry
-
Sets an additional configuration pair.
- 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
- addAggregationsFilter() - Method in class AbstractChartSeries
- addApprovalStep(String) - Method in class WorkflowDTO
-
Adds a new approval step at the end of the approval workflow.
- addAttributeMetaSearchCriteria(Search) - Method in class Customer
- 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. from the browser).
- addBackendCall(String, String, String) - Method in class DashboardController
-
Performs a backend call in the user's context (i.e. from the browser)
- addBackendCall(String, String, String, String, String) - Method in class DashboardController
-
Performs a backend call in the user's context (i.e. from the browser).
- 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.
- addCalculationItem(String, Map<String, Object>) - Method in interface ModelParallelCalculationFormulaInitContext
-
Add a calculation item to be calculated after the "calculation-init" context, during the "calculation-item" context.
- addCollapsibleHTML(boolean, String, String) - Method in class DashboardController
-
Adds an HTML snippet into the controller as a collapsible section.
- addColumn(String) - Method in interface Matrix2D
-
Add a column to this Matrix2D, without any values
- addColumn(String) - Method in interface ResultMatrix
-
Adds a column to the existing set of columns
- addColumn(String) - Method in interface ResultMatrix.BackEndAction
- addColumn(String) - Method in class ResultMatrix.ResultMatrixBackEndAction
-
Deprecated.
- 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, String) - Method in interface ResultMatrix
-
Adds a column to the existing set of columns including a tooltip
- addColumns(Collection<String>) - Method in interface ResultMatrix
-
Adds columns to the existing set of columns
- addColumnTranslation(String, Map<String, String>) - Method in interface ResultMatrix
-
Adds translated labels for the given column.
- addCompensationStructure(CompensationStructure) - Method in class CompensationBuilder
-
Applies a compensation structure.
- addContractStructure(ContractStructure) - Method in class ContractBuilder
-
Builds a Contract structure.
- addCustomerIdFilter(Search) - Method in class User
- addCustomersFilter() - Method in class AbstractChartSeries
- addDataLoadAction(String, String, String) - Method in class CalculationFlowActionBuilder
-
Adds the specified data load action to the list of actions to be executed.
- addDefaultValues(Map<String, Object>) - Method in interface DatamartRowSet
-
Add default values to be used when creating new rows.
- 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.
- addEntry(ConfiguratorEntry) - Method in class ConfiguratorEntryArray
- addErrorMessage(String) - Method in class DMField
-
Add an error message on DMField level, not for a specific DMField attribute
- addErrorMessage(String, String) - Method in class DMField
-
Add an error message pertaining to a DMField attribute
- 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')
- addField(Object) - Method in interface ModelFormulaContext
-
Each model is backed by a table in the PA DB.
- addFieldKind(DMFieldInputBuilder.FieldKind) - Method in class DMFieldInputBuilder
- addFieldType(FieldType) - Method in class DMFieldInputBuilder
- addFilter(Filter) - Method in class DMDataSlice
- addFilter(Filter) - Method in interface DatamartContext.DataSlice
- addFilter(Object) - Method in class Filters
-
Adds a (possibly complex) filter.
- addFilter(String, FilterOperator) - Method in class Filters
- addFilter(String, FilterOperator, Object) - Method in class Filters
- addFilters() - Method in class AbstractChartSeries
- addFilters(FilterOperator) - Method in class AbstractChartSeries
- addFilters(FilterOperator) - Method in class Filters
- addFolder(String) - Method in class CompensationBuilder
-
Creates and adds a new folder under the ROOT folder.
- addFolder(String) - Method in class ContractBuilder
-
Creates and adds a new folder under the ROOT folder.
- addFolder(String) - Method in class ContractStructure
-
Creates and adds a new folder
- addFolder(String) - Method in class QuoteBuilder
-
Creates and adds a new folder under the ROOT folder.
- addFolder(String) - Method in class QuoteStructure
-
Creates and adds a new folder
- addFolder(String) - Method in class RebateAgreementBuilder
-
Creates and adds a new folder under the ROOT folder.
- addFolder(String, List<Map<String, Object>>) - Method in class ContractStructure
-
Creates and adds a new folder
- addFolder(String, List<Map<String, Object>>) - Method in class QuoteStructure
-
Creates and adds a new folder
- addFormatsToResultMatrix() - Method in interface ResultMatrix
- addFormatsToResultMatrix() - Method in class ResultMatrix
-
Deprecated.
- addFormulaInput(String, Object) - Method in interface ResultMatrix.BackEndAction
- addFormulaInput(String, Object) - Method in class ResultMatrix.ResultMatrixBackEndAction
-
Deprecated.
- addGroupBy(String) - Method in class DataTableChart.DataTableSeries
- addHTML(String) - Method in class DashboardController
-
Adds an HTML snippet into the controller.
- addInput(ContextParameter) - Method in class CollapseInputBuilder
-
Add parameter to the ContextParameters list Example:
- addInput(ContextParameter) - Method in class RowInputBuilder
-
Adds a new input for InputBuilder.
- addInput(ContextParameter) - Method in class ContextParameter
-
Adds a nested input.
- addInputParameter(String, String) - Method in class Formula
- addInputParameter(String, BigDecimal) - Method in class Formula
- addInvocation(String, Object...) - Method in class AbstractChartBuilder
- addItem(String) - Method in class ContractStructure
-
Creates and adds a new item
- addItem(String, List<Map<String, Object>>) - Method in class ContractStructure
-
Creates and adds a new item
- addItemReason(String, String) - Method in class WorkflowDTO
- addLineItem(String) - Method in class CalculableLineItemCollectionBuilder
-
Adds a new line item in the root folder.
- addLineItem(String, String) - Method in class CalculableLineItemCollectionBuilder
-
Adds a new line item in the specified parent (folder ID).
- addLineItem(String, String, List<Map<String, Object>>) - Method in class CalculableLineItemCollectionBuilder
-
Adds a new line item in the specified parent (folder ID) and sets some context parameters.
- addLineItemWithId(String, String) - Method in class RATBuilder.RABuilder
-
Adds a new line item to the Rebate Agreement, specified by the Rebate Type unique name.
- addLineItemWithId(String, String, String) - Method in class RATBuilder.RABuilder
-
Adds a new line item to the specified parent folder of the Rebate Agreement.
Example: - addLink(String, String) - Method in class DashboardController
-
Adds a link (simple <A> tag) to the controller.
- addLink(String, String, Object) - Method in class DashboardController
-
Adds a link (simple <A> tag) to the controller.
- addLink(String, String, Object, Object) - Method in class DashboardController
-
Adds a link (simple <A> tag) to the controller.
- addLivePriceGridAction(String) - Method in class CalculationFlowActionBuilder
-
Adds live price grid action to the list of actions that should be executed.
- addLookupTable(String, String, LookupTable.LookupTableValueType, Map<String, Map<String, Object>>) - Method in interface ModelLookupTablesContextReadWrite
-
Add a
LookupTable
owned by the model. - 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 provideddefinition
. - 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.
- addModelCalculationAction(String) - Method in class CalculationFlowActionBuilder
-
Adds a model calculation action to the list of actions that should be executed.
- addModule(String...) - Method in class ResultHighchart
-
By default, these modules are already available: boost, drilldown, exporting, export-data, heatmap, no-data-to-display, treemap.
- addObjectTypedId(String) - Method in class ItemSummaryQuery
- addObjRefAction() - Method in class CalculationFlowActionBuilder
-
Adds object references action to the list of actions that should be executed.
- addOption(String) - Method in class OptionInputBuilder
-
Adds the option to the OptionInputBuilder instance.
- addOrUpdate() - Method in interface ModelSchedulesContextReadWrite.NewScheduleBuilder
-
Adds or updates the configured model schedule.
- addOrUpdate(String, String, Map<?, ?>...) - Method in interface PayoutRecordManager
-
The convenience method, adds a PayoutRecord/AccrualRecord if no record with the given type and name exists.
- addOrUpdate(String, List<Map<String, Object>>) - Method in interface PublicGroovyAPI
-
Adds or updates a list of master data objects of the given type.
- addOrUpdate(String, Map<String, Object>) - Method in interface PublicGroovyAPI
-
Adds or updates an object in the collection of objects of the given type.
- addOrUpdate(Map<String, Object>) - Method in interface ConditionRecordHelper
-
Allows you to add or update data into the
ConditionRecordItem
(CRCI) table (CRCI1..CRCI12). - addOrUpdateCalcItem(Object, Object, Object) - Method in interface DistCalcFormulaContext
-
Creates a new or updates an existing calculation item (entry in the Model CalcItems PP) for a given
(key1,key2)
combination.) - addOrUpdateCalcItem(Object, Object, Object) - Method in interface ModelCalcFormulaContext
-
Creates a new or updates an existing calculation item (entry in the Model CalcItems PP) for a given calculation step.
- addOrUpdateInput(String, Map<String, Object>) - Method in class CalculableLineItemCollectionBuilder
-
Adds or updates an input parameter on a folder (or line) with given
lineId
. - addOrUpdateInput(Map<String, Object>) - Method in class CalculableLineItemCollectionBuilder
-
Adds or updates an input parameter on the ROOT level.
- addOrUpdateInput(CalculableLineItemCollectionBuilder, String) - Method in class AbstractInputBuilder
-
Adds (or updates) this input field (defined by this builder) to the specified header line item.
- addOrUpdateOutput(String, Map<String, Object>) - Method in class CalculableLineItemCollectionBuilder
-
Adds or updates a result value (an output value) on a folder (or line item) with given
lineId
. - addOrUpdateOutput(Map<String, Object>) - Method in class CalculableLineItemCollectionBuilder
-
Adds or updates a result value (an output value) on the ROOT level.
- addParameter(ContextParameter) - Method in class ConfiguratorEntry
-
Deprecated.
- addParameterConfigEntry(String, Object) - Method in class ContextParameter
-
Technically the same functionality as
ContextParameter.setConfigParameter(String, Object)
. - addPart(String) - Method in class QuoteBuilder
-
Creates and adds a new line item to the Quote with the given
sku
. - 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
- 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
- addQuoteMassUpdateAction(String) - Method in class CalculationFlowActionBuilder
-
Adds quote mass update action to the list of actions that should be executed.
- addQuoteStructure(QuoteStructure) - Method in class QuoteBuilder
-
Apply a quote structure.
- addRange(String, BigDecimal, BigDecimal) - Method in class HeatmapChart.HeatmapRangedColorAxis
- addRebateAgreementStructure(RebateAgreementStructure) - Method in class RebateAgreementBuilder
-
Builds a Rebate Agreement structure.
- addRebateRecordAction(String) - Method in class CalculationFlowActionBuilder
-
Adds rebate record action to the list of actions that should be executed.
- addRecord(String, CalendarUtil.TimePeriod, Map<String, ?>, Map<String, FieldFormatType>, boolean...) - Method in interface ModelCalcFormulaContext
-
Adds a new record with the given name if none exist yet with that name in the DRAFT status (
workflowStatus == WorkflowStatus.DRAFT
). - addResultMatrixTab(ResultMatrix) - Method in class ResultHighchart
-
The automatically filled data tab can be replaced by customized ResultMatrix data.
- addRow(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 ResultMatrix
-
Adds a data row.
- addRow(Object...) - Method in class ResultMatrix
-
Deprecated.
- 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(List<Object>) - Method in interface ResultMatrix
-
Adds a data row.
- 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(Map<String, Object>) - Method in interface DatamartRowSet
-
Adds a row.
- addRow(Map<String, Object>) - Method in interface ResultMatrix
-
Adds a data row.
- addRow(Map<String, Object>) - Method in class ResultMatrix
-
Deprecated.
- 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.
- addSkuFilter(Search) - Method in class User
- addSource(DatamartContext.Query) - Method in interface DatamartContext.SqlQuery
-
Adds a
DatamartContext.Query
as a source for this SQL query. - addSource(DatamartContext.Query, String) - Method in interface DatamartContext.SqlQuery
-
Adds a
DatamartContext.Query
as a source for this SQL query. - addSource(DatamartContext.Table) - Method in interface DatamartContext.SqlQuery
-
Adds a
DatamartContext.Table
as a source for this SQL query. - addSource(DatamartContext.Table, String) - Method in interface DatamartContext.SqlQuery
-
Adds a
DatamartContext.Table
as a source for this SQL query. - addStep(String, String) - Method in class AuxLine.SteppedLine
- addStop(String, Integer) - Method in class HeatmapChart.HeatmapInterpolatedColorAxis
- addTable(String, Object) - Method in interface ModelCalcFormulaContext
-
Creates a table, represented by a DMTable object in the PA DB, modelled on and populated from the given source.
- addTable(String, Map<String, Object>) - Method in interface ModelFormulaContextReadWrite
-
Add a table in the model.
- addToConfiguratorEntry(ConfiguratorEntry) - Method in class AbstractInputBuilder
-
Adds the input field (defined by this builder) to the specified form field set/section (ConfiguratorEntry).
- addToConfiguratorEntry(ConfiguratorEntry, Closure) - Method in class AbstractInputBuilder
-
Adds the input field (defined by this builder) to the specified form field set/section (ConfiguratorEntry).
- addTotal(Map<String, Object[]>) - Method in class ItemSummaryQuery
- addTree(String, Collection<String>) - Method in interface ModelCalcFormulaContext
-
Adds a tree to this model, which is effectively a FilterNode object that acts as the root of the tree, i.e. one that does not point to a parent FilterNode.
- addTree(String, ModelFilterTreesContextReadWrite.NodeSpec) - Method in interface ModelFilterTreesContextReadWrite
-
Add a tree that will be owned by this model.
- addTree(String, Matrix2D, Collection<String>) - Method in interface ModelCalcFormulaContext
-
Adds a tree to this model, consisting of nodes constructed from a data set, usually a PA query result.
- addTree(String, Matrix2D, Collection<String>, Collection<String>, String, String) - Method in interface ModelCalcFormulaContext
-
Creates or replaces a tree as in
ModelCalcFormulaContext.addTree(String, Matrix2D, Collection)
, with the additional specification of an output or output format, and/or labels. - addTreeNode(Long, String, String, String, Filter) - Method in interface ModelCalcFormulaContext
-
Adds a descendent to an existing tree node, identified by its
parentId
. - addType(String) - Method in class DMSourceInputBuilder
-
Add the source types to be displayed in the drop down list.
- addValue(double) - Method in class AdaptiveHistogram
-
Adds a data point to the histogram.
- addWarning(String) - Method in interface PublicGroovyAPI
-
Adds a warning to the logic/formula execution warning log.
- addWarningMessage(String) - Method in class DMField
-
Add a warning message on DMField level, not for a specific DMField attribute
- addWarningMessage(String, String) - Method in class DMField
-
Add a warning message pertaining to a DMField attribute
- addWatcherStep(String) - Method in class WorkflowDTO
-
Adds a watcher step to the end of the approval workflow.
- addWaterfallColumn(WaterfallColumnType, String, String) - Method in class WaterfallChart.WaterfallSeries
- addWaterfallColumn(WaterfallColumnType, String, String) - Method in class WaterfallComparisonChart.WaterfallComparisonSeries
- addWith(String, Object...) - Method in interface DatamartContext.SqlQuery
-
Adds a with clause to the SQL query, where every "?"
- addWith(String, String, Object...) - Method in interface DatamartContext.SqlQuery
-
Adds a with clause to the SQL query, where every "?"
- adjustDateByTimezoneOffset(Date) - Method in interface PublicGroovyAPI
-
Sometimes it is important which day in a given timezone a point in time is The timezone used here is the partition's timezone as defined in the application property "defaultTimezoneId" If no timezone is defined in the app property, no conversion happens Essentially this method is useful to determine the exact boundaries of a day, as e.g. in Asia the new day may already have started when in Europe or US it could be still the day prior from a pure date perspective.
- aggregate(Map<String, Object[]>, List<Object[]>) - 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 Class in net.pricefx.common.api.chart
- aggregationsFilter - Variable in class AbstractChartSeries
- alignment - Variable in class ResultMatrix.ResultMatrixStyledCell
-
Deprecated.
- all() - Method in class TieredValue
- all(String, Filter) - Static method in class Filter
-
Create a new Filter using the ALL operator.
- ALL - Enum constant in enum class InputButtonAction
- allSteps() - Method in class ModelCalculationAction
-
Sets the calculation range of the model to all steps (sets
fromStep
andtoStep
to null). - alreadySatisfiedComment - Variable in class WorkflowDTO.StepDTO
- ALT_DATE_PATTERN_1 - Static variable in class CalendarUtil
- ALT_DATE_PATTERN_2 - Static variable in class CalendarUtil
- ALT_DATETIME_PATTERN - Static variable in class CalendarUtil
- alwaysMatch() - Static method in class Filter
- and(Filter...) - Static method in class Filter
-
Create a new Filter using the AND operator.
- AND - Enum constant in enum class FilterOperator
- andCloseOn(String) - Method in interface DashboardApi
-
Closes a tab or popup window when the specified event is triggered.
- andRecalculateOn(String) - Method in interface DashboardApi
-
Specifies on what event the embedded dashboard will be recalculated.
- anyUser(String) - Method in interface PublicGroovyAPI
-
Deprecated.
- applyPlaceholder(String, Object) - Method in class RATBuilder.RABuilder
- applyType(InputType) - Method in class ContextParameter
- AppPages - Interface in net.pricefx.formulaengine.scripting
-
The constants defined in this interface are typically used as the
targetPage
parameter when defining links to jump from a dashboard to other parts of the UI. - approvalDate - Variable in class WorkflowInfo.WorkflowStepInfo
-
Date of approval, GMT timezone
- approvalDate() - Method in class Pricelist
- approvalRequiredEmailAttachments - Variable in class WorkflowInfo.WorkflowStepInfo
-
The attachments
- ApprovalState - Enum Class in net.pricefx.domain
- ApprovalStepDTO(WorkflowDTO, String) - Constructor for class WorkflowDTO.ApprovalStepDTO
- approve() - Method in class CustomFormApi.WorkflowActionApi
-
Finishes the approval operation.
- APPROVED - Enum constant in enum class RebateAgreementStatus
- APPROVED - Enum constant in enum class RebateRecordStatus
- APPROVED - Enum constant in enum class ApprovalState
-
PriceList is in this state if all its PriceListItems are approved.
- APPROVED - Enum constant in enum class AttachedDocument.DocumentStatus
- AREA - Enum constant in enum class SeriesType
- AREASPLINE - Enum constant in enum class SeriesType
- ASC - Enum constant in enum class TieredValueSortType
- ASCENDING - Enum constant in enum class SortType
- asFilter() - Method in class CustomerGroup
-
Converts CustomerGroup to Filter object.
- asFilter() - Method in class ProductGroup
-
Converts ProductGroup to a filter object.
- asFilter() - Method in class SellerGroup
-
Converts SellerGroup to a filter object.
- asFilter(String, PersistedObjectService) - Method in class DMDataSlice
- asFilter(CustomerGroup, PersistedObjectService) - Static method in class DMDataSlice
- asFilter(DMDataSource) - Method in class CustomerGroup
-
Returns resolved filter using the given DS, which should represent the Customer attributed object class.
- asFilter(DMDataSource) - Method in class ProductGroup
-
Returns resolved filter using the given Data Source, which should represent the Product attributed object class.
- asFilter(DMDataSource) - Method in class SellerGroup
-
Returns resolved filter using the given Data Source, which should represent the Seller attributed object class.
- asFilter(DMDataSource, Collection<DMDataSource>) - Method in class CustomerGroup
-
Returns resolved filter using the given Customer Data Source and external Data Source, which should represent the Customer attributed object class.
- asFilter(DMDataSource, Collection<DMDataSource>) - Method in class ProductGroup
-
Returns resolved filter using the given Product Data Source and external Data Source, which should represent the Product attributed object class.
- asFilter(DMDataSource, Collection<DMDataSource>) - Method in class SellerGroup
-
Returns resolved filter using the given Seller Data Source and external Data Source, which should represent the Seller attributed object class.
- asFilter(ProductGroup, PersistedObjectService) - Static method in class DMDataSlice
- asFilter(SellerReference) - Static method in class DMDataSlice
- asFilter(PersistedObjectService) - Method in class DMDataSlice
- asFilterWithCXSubQuery() - Method in class CustomerGroup
-
Converts CustomerGroup into a filter including converting any CX searchable items into a custom filter.
- asFilterWithPXSubQuery() - Method in class ProductGroup
-
Converts ProductGroup into a filter including converting any PX searchable items into a custom filter.
- asFilterWithSXSubQuery() - Method in class SellerGroup
-
Converts SellerGroup into a filter including converting any SX searchable items into a custom filter.
- asLink() - Method in interface IRebateRecordManager
-
Return a clickable link to the RR/COR with the default name, as the result of a formula element
- asLink(String) - Method in interface IRebateRecordManager
-
Return a clickable link to the RR/COR 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/COR for the given name and RR/COR-set, as the result of a formula element
- asListOfMaps(Map<String, Object[]>) - Method in class ItemSummaryQuery
- asMap() - Method in class LineItemHelper.LineItem
- asMap() - Method in class TieredValue
- asParam(String) - Method in interface DashboardApi
-
Exposes event payload - attribute of the specified name - as a parameter that can be read in the embedded dashboard.
- asResultMatrix(String...) - Method in interface IRebateRecordManager
-
Return a ResultMatrix listing all RR/CORs in the agreement, optionally the fields/attributes to be shown as matrix columns.
- assign(String, Object) - Method in interface RContext
-
Assigns a value to a variable in R.
- ASYNC_LOADDATA_COMPLETED - Enum constant in enum class EventType
- asyncHttpCall(String, String, String, String, Map...) - Method in interface PublicGroovyAPI
-
The asynchronous httpCall is design to issues the HTTP call to an external entity
PublicGroovyAPI.httpCall(String, String, String, String, Map[])
in the new thread (which is canceled after the time specified inFormulaEngineContext.getElementTimeout()
) - AttachedDocument - Class in net.pricefx.domain
- AttachedDocument() - Constructor for class AttachedDocument
- AttachedDocument.CompositeKey - Class in net.pricefx.domain
- AttachedDocument.DocumentStatus - Enum Class in net.pricefx.domain
- attachmentDownloadURL(String) - Method in interface ModelFormulaContextReadOnly
-
Returns the attachment download URL.
- 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
- attributeName - Variable in class AbstractProductAndCustomerInputBuilder
- auditOperation(AuditOperation, User, CommandContext, PersistedObjectService, String) - Method in class User
- auditOperation(AuditOperation, User, CommandContext, PersistedObjectService, String) - Method in class UserGroup
- AUTO_APPROVED - Enum constant in enum class ApprovalState
-
PriceGrid items can be auto-approved
- AuxLine<C> - Class in net.pricefx.common.apibuilder.chart
- AuxLine(C, String, String) - Constructor for class AuxLine
- AuxLine.Line<C> - Class in net.pricefx.common.apibuilder.chart
- AuxLine.SteppedLine<C> - Class in net.pricefx.common.apibuilder.chart
- AuxLine.VerticalLine<C> - Class in net.pricefx.common.apibuilder.chart
- AuxLineColor - Enum Class in net.pricefx.common.api.chart
- AuxLineType - Enum Class in net.pricefx.common.api.chart
- AVERAGE - Enum constant in enum class AggregationFormula
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 ModelCalculationAction
- back() - Method in class ObjRefAction
- 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
- back() - Method in interface ResultHighchart.OnPointClick
- back() - Method in interface ResultHighchart.TriggerEvent
- backEndAction(String, String, String, String, String) - Method in interface ResultMatrix
- backEndAction(String, String, String, String, String) - Method in class ResultMatrix
-
Deprecated.
- background - Variable in class ResultMatrix.ResultMatrixStyledCell
-
Deprecated.
- bandByOptions - Variable in class ChartSeries.Aggregation
- BAR - Enum constant in enum class ChartType
- BAR - Enum constant in enum class SeriesType
- 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 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.
- baseCalculableType() - Method in class Simulation
- Basic(C, String) - Constructor for class ChartOptions.Basic
- Basic(C, String) - Constructor for class ChartSeries.Basic
- Basic(S, String) - Constructor for class ChartMeasures.Basic
- Basic Categories of Groovy API Functions - Search tag in interface net.pricefx.formulaengine.scripting.PublicGroovyAPI
- Section
- BasicRebateAgreementBuilder<T> - 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
- batchFilters(DatamartContext.Table, Filter, long) - Method in interface DatamartContext
-
Generates Filters that partition the rows in the target in such a way that each batch has the number of rows as specified by the batchSize param.
- Best Practices - Search tag in Overview
- Section
- BLACK - Enum constant in enum class AuxLineColor
- BLUE - Enum constant in enum class AuxLineColor
- 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.
- bomList() - Method in interface PublicGroovyAPI
-
Rolls up the current SKU's BoM and returns the rolled up BoM records (not just the quantities).
- BOOLEAN - Enum constant in enum class InputType
- BOOLEAN - Enum constant in enum class DataType
- BOOLEAN - Enum constant in enum class FieldType
- booleanUserEntry(String) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createBooleanUserEntry(String)
instead. - BOOLEANUSERENTRY - Enum constant in enum class InputType
- BOTTOM - Enum constant in enum class LimitPosition
- boundCall(String, String, String, Boolean...) - Method in interface PublicGroovyAPI
-
Triggers a HTTPS request towards the Pricefx server, either local one or an external one.
- BOXPLOT - Enum constant in enum class ChartType
- 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 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
- BUBBLE - Enum constant in enum class ChartType
- 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 HighCharts.Chart.
- BubbleChart(IdGenerator, Invocations<MethodInvocation>) - Constructor for class BubbleChart
- BubbleChart.BubbleAdditionalMeasure - Class in net.pricefx.common.apibuilder.chart
- BubbleChart.BubbleOnChartClick - Class in net.pricefx.common.apibuilder.chart
- BubbleChart.BubbleOnChartClick.BubbleTriggerEvent - 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
- BubbleOnChartClick() - Constructor for class BubbleChart.BubbleOnChartClick
- 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
- BubbleTriggerEvent(String) - Constructor for class BubbleChart.BubbleOnChartClick.BubbleTriggerEvent
- 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 CustomFormCollectionBuilder
-
Creates an instance of
CustomFormBuilderResult
with the invocations accumulated in this builder instance - build() - Method in class QuoteBuilder
- build() - Method in class BasicRebateAgreementBuilder
- build() - Method in class RATBuilder
- build(ChartType) - Method in class AbstractChartBuilder
- buildContextParameter() - Method in class AbstractInputBuilder
-
Builds and returns the input field definition object.
- buildDataTableChart(String, String) - Method in interface IRebateRecordManager
-
Deprecated.
- builderContext - Variable in class AbstractInputBuilder
- buildFlexChart(Object) - Method in interface PublicGroovyAPI
-
Deprecated.Calls
buildFlexChart(null, definition)
. See the full documentation inPublicGroovyAPI.buildFlexChart(String, Object)
. - buildFlexChart(String, Object) - Method in interface PublicGroovyAPI
-
Deprecated.Creates a
FlexChart
from the passeddefinition
by merging it withoptions
defined within thebaseTemplateToUse
template.Although it may change in future releases, for now, a
FlexChart
is nothing else than aHighcharts
chart. Therefore, the passeddefinition
(also applies to thebaseTemplateToUse
template) must denoteHighcharts options
- please consultHighcharts
documentation for more details, and note that FlexCharts must comply to the outdated Highcharts release 4.Since
Highcharts options
are normally specified by aJavaScript object literal
, the passeddefinition
must be either aJSON
string representing suchobject literal
, or anyobject
which can be mapped to suchJSON
representation. Therefore, typically thedefiniton
will be passed as amap of maps
.Example:
def definition = [ chart: [ type: "bar" ], title: [ text: "A common FlexChart" ], series: [ [ data: [10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21] ] ] ] api.buildFlexChart(definition)
Highcharts options
are supported. Moreover, usage of some options is prohibited deliberately. These are currentlyglobal
,events
and everyJavaScript function
-based options.Note:
FlexChart
templates are defined by an administrator in the 'Configuration
' section. - buildFromOpaqueString(String) - Method in class Dictionary
- buildHighchart(Map<String, ?>) - Method in interface PublicGroovyAPI
-
Creates a
ResultHighchart
from the passeddefinition
. - buildHighmap(Map<String, ?>) - Method in interface PublicGroovyAPI
-
Creates a
ResultHighmap
from the passeddefinition
. - buildMap() - Method in class AbstractInputBuilder
-
Builds a map with input field definition.
- buildQuery(DatamartContext.Query) - Method in interface DatamartContext
-
EXPERIMENTAL: Not all aspects and properties of a query are supported.
- buildRebateRecordSearch(Filter[], PersistedObjectService) - Method in class RebateRecordSet
- buildValuesSearch(int, int, Map<String, Object>, String, List<String>, List<String>, boolean, PersistedObjectService) - Method in class LookupTable
- bulkLoadMode() - Method in interface PayoutRecordManager
-
Switches to the bulk-load mode.
- bumpVersion() - Method in class LookupTable
- BUTTON - Enum constant in enum class InputType
- ButtonInputBuilder<VT> - Class in net.pricefx.formulaengine.scripting.inputbuilder
-
Builder class for input type Button
InputType.BUTTON
- ButtonInputBuilder(InputBuilderContext, String) - Constructor for class ButtonInputBuilder
C
- CACHE_REGION_NAME - Static variable in class User
- CACHE_REGION_NAME - Static variable in class UserGroup
- calculableLineItemCollection - Variable in class LineItemHelper
- CalculableLineItemCollectionBuilder<T> - Class in net.pricefx.common.apibuilder.clicoll
-
This is the shared builder class for Quotes, RebateAgreements and Contracts.
Some important notes on the sequence in which changes to the document structure are processed:
Any modifying action (adding lines, inputs etc. or a structure object etc.) - CalculableLineItemCollectionBuilder(String, String, IdGenerator, Invocations<MethodInvocation>, HeaderPhase) - Constructor for class CalculableLineItemCollectionBuilder
- calculableLineItemCollectionMap - Variable in class LineItemHelper.LineItem
- CALCULATED - Enum constant in enum class ModelParallelCalculationFormulaSummaryContext.CalculationItem.Status
- CalculatedFieldSet - Class in net.pricefx.domain
- CalculatedFieldSet() - Constructor for class CalculatedFieldSet
- calculateGroupByData() - Method in interface ResultMatrix
-
Proceed grouping with groupBy columns (if missing
ResultMatrixGroupingException.NullOrEmptyException
is thrown) for numeric columns and aggregation strategy passed byResultMatrix.withColumnAggregation(String, Object)
orResultMatrix.withColumnAggregation(String, AggregateFunctionType)
orResultMatrix.withColumnAggregations(Map)
. - calculateGroupByData() - Method in class ResultMatrix
-
Deprecated.
- 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.
- CALCULATION_COMPLETED_CFS - Enum constant in enum class EventType
-
Calculated fields set process finished
- CALCULATION_COMPLETED_CG - Enum constant in enum class EventType
-
Calculation Grid (CG) calculation finished
- CALCULATION_COMPLETED_CT - Enum constant in enum class EventType
-
Contract (CT) calculation finished
- CALCULATION_COMPLETED_PG - Enum constant in enum class EventType
-
Price Grid (LPG) calculation finished
- CALCULATION_COMPLETED_PL - Enum constant in enum class EventType
-
Price list calculation finished
- CALCULATION_COMPLETED_RC - Enum constant in enum class EventType
-
Rebate Records (RR) calculation finished
- CALCULATION_COMPLETED_SIM - Enum constant in enum class EventType
-
Simulation calculation finished
- 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>) - Constructor for class CalculationFlowActionBuilder
- CalculationFlowActionBuilder(Invocations<MethodInvocationRecord>, CalculationFlowTimeUnit, BigDecimal, String, Boolean, CFTraitType) - Constructor for class CalculationFlowActionBuilder
- calculationItem() - Method in interface ModelParallelCalculationFormulaItemContext
- calculationItems() - Method in interface ModelParallelCalculationFormulaSummaryContext
-
Deprecated.
- CalculationResultType - Enum Class in net.pricefx.common.api
-
Enumeration of existing CalculationResultTypes.
- CalculationStatus - Enum Class in net.pricefx.domain
- calendar() - Method in interface DatamartContext
-
Instantiates a PA Calendar utility object.
- calendar() - Method in interface PublicGroovyAPI
-
Gets a
java.util.Calendar
object initialized with the current targetDate (or a new Date() if no target date is given). - calendar(Date) - Method in interface PublicGroovyAPI
-
Gets a calendar object initialized with
date
. - CALENDAR_SOURCENAME - Static variable in class DMField
- CalendarUtil - Class in net.pricefx.common.util
- CalendarUtil() - Constructor for class CalendarUtil
- CalendarUtil(String, String) - Constructor for class CalendarUtil
- CalendarUtil.TimePeriod - Class in net.pricefx.common.util
- CalendarUtil.TimeUnit - Enum Class in net.pricefx.common.util
- canAdd(User, ValidationVisitor, PersistedObjectService) - Method in class LookupTable
- canCancel() - Method in enum class CalculationStatus
- canCancel(String) - Static method in enum class CalculationStatus
- CANCEL - Enum constant in enum class InputButtonAction
- CANCELLED - Enum constant in enum class CalculationStatus
- canDelete(User, ValidationVisitor, PersistedObjectService) - Method in class LookupTable
- canDelete(User, ValidationVisitor, PersistedObjectService) - Method in class PriceGrid
- canDelete(User, ValidationVisitor, PersistedObjectService) - Method in class Pricelist
- canDoLogarithmicAxis(char) - Method in class BarLineChart
- canDoLogarithmicAxis(char) - Method in class BubbleChart
- canDoLogarithmicAxis(char) - Method in class DetailedTimeSeriesChart
- canDoLogarithmicAxis(char) - Method in class ScatterChart
- canDoLogarithmicAxis(char) - Method in class TimeSeriesChart
- canEdit(User, ValidationVisitor, PersistedObjectService, Map<String, Object>) - Method in class LookupTable
- canEdit(User, ValidationVisitor, PersistedObjectService, Map<String, Object>) - Method in class PriceGrid
- canEdit(User, ValidationVisitor, PersistedObjectService, Map<String, Object>) - Method in class Pricelist
- canEdit(User, ValidationVisitor, PersistedObjectService, Map<String, Object>) - Method in class User
- canRead(User, ValidationVisitor, PersistedObjectService) - Method in class LookupTable
- canStart() - Method in enum class CalculationStatus
- CellClickTriggerEvent(String) - Constructor for class ChartEvents.OnCellClick.CellClickTriggerEvent
- cells - Variable in class ResultMatrix.ResultMatrixCells
-
Deprecated.
- cells(String, Object...) - Method in interface ResultMatrix
- cells(String, Object...) - Method in class ResultMatrix
-
Deprecated.
- CFSAction<T> - Class in net.pricefx.common.apibuilder.calculationflowaction
-
This action starts calculation of selected CFS.
- CFSAction(T, Invocations<MethodInvocationRecord>, String) - Constructor for class CFSAction
- ChainedJobInfo - Class in net.pricefx.common.dto
-
This class is a DTO that holds information about jobs that should be executed next.
- ChainedJobInfo() - Constructor for class ChainedJobInfo
- CHANGE_NOTIFICATION_CA - Enum constant in enum class EventType
-
Update of Customer Assignment (when Customer Assignment for price list or manual price list changes)
- CHANGE_NOTIFICATION_MPL - Enum constant in enum class EventType
-
Update of an item of a manual price list (only informs that there is a change and in which manual price list)
- CHANGE_NOTIFICATION_PP - Enum constant in enum class EventType
-
Any kind or Price Parameter bulk update (delete/update), the event only informs that someone manipulated a certain table
- 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> - Class in net.pricefx.common.apibuilder.chart
- ChartEvents.OnCellClick.CellClickTriggerEvent - Class in net.pricefx.common.apibuilder.chart
- ChartEvents.OnChartClick<C,
E> - Class in net.pricefx.common.apibuilder.chart - ChartEvents.OnChartClick.ClickTriggerEvent<T> - Class in net.pricefx.common.apibuilder.chart
- ChartEvents.OnRowClick<C> - 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,
M> - Class in net.pricefx.common.apibuilder.chart - ChartMeasures.EmbeddedBoxplot<S,
M> - Class in net.pricefx.common.apibuilder.chart - ChartMeasures.Type<S,
M> - Class in net.pricefx.common.apibuilder.chart - ChartOptions - Class in net.pricefx.common.apibuilder.chart
- ChartOptions.Basic<C,
O> - Class in net.pricefx.common.apibuilder.chart - ChartOptions.EmbeddedBoxplot<C,
O> - Class in net.pricefx.common.apibuilder.chart - ChartOptions.XYLabels<C,
O> - Class in net.pricefx.common.apibuilder.chart - ChartOptions.XYMinMax<C,
O> - Class in net.pricefx.common.apibuilder.chart - ChartOptions.ZAxis<C,
O> - Class in net.pricefx.common.apibuilder.chart - ChartSeries - Class in net.pricefx.common.apibuilder.chart
- ChartSeries.Aggregation<C,
S> - Class in net.pricefx.common.apibuilder.chart - ChartSeries.Basic<C,
S> - Class in net.pricefx.common.apibuilder.chart - ChartSeries.EmbeddedBoxplot<C,
S> - Class in net.pricefx.common.apibuilder.chart - ChartType - Enum Class in net.pricefx.common.api.chart
- Cheat Sheets - Search tag in Overview
- Section
- check(String, User) - Method in class LookupTable.LTBulkloadFilterCheckCallback
- checkPassword(String) - Method in class User
-
This method checks if a passed clearText password matches the stored password hash
- children - Variable in class ModelFormulaContext.TreeNode
- children - Variable in class ModelFilterTreesContextReadWrite.NodeSpec
- children() - Method in interface ModelFilterTreesContextReadOnly.FilterTreeNode
- ClaimContext - Interface in net.pricefx.formulaengine.scripting
-
ClaimContext is used for configuration of Configure Channel Management.
- clear() - Method in class DMDataSlice
- clear() - Method in interface DatamartContext.DataSlice
- CLEAR - Enum constant in enum class InputButtonAction
- clearAttribute(String) - Method in class AttributedResult
- clearConfigParameter(String) - Method in class ContextParameter
- clearNewSchedule() - Method in class ScheduleSettings
- clearRenderInfo(String) - Method in class CalculableLineItemCollectionBuilder
-
Clears the existing render info for a field or for all fields.
- ClickTriggerEvent(String) - Constructor for class ChartEvents.OnChartClick.ClickTriggerEvent
- clone() - Method in class TieredValue
- close() - Method in interface DatamartContext.DataLoader
-
Ensure all already added row has been flushed and release all the resources.
- close() - Method in class TableContext
- close() - Method in interface StreamResults
-
Releases the often significant resources required to provide access to the query result set.
- CLOSED - Enum constant in enum class RebateAgreementStatus
- CLOSED - Enum constant in enum class AttachedDocument.DocumentStatus
- CM_MAIN_PAGE - Static variable in interface AppPages
-
ChannelManager module -
targetPageState
optionaltypedId
for specific Claim details - CM_RECORDS_PAGE - Static variable in interface AppPages
-
ChannelManager module
- CM_TYPES_PAGE - Static variable in interface AppPages
-
ChannelManager module
- Code Quality - Search tag in Overview
- Section
- COLLAPSE - Enum constant in enum class InputType
- CollapseInputBuilder<T> - Class in net.pricefx.formulaengine.scripting.inputbuilder
- CollapseInputBuilder(InputBuilderContext, String) - Constructor for class CollapseInputBuilder
- color - Variable in class ResultMatrix.ResultMatrixStyledCell
-
Deprecated.
- color() - Method in enum class AuxLineColor
- ColorAxisType - Enum Class in net.pricefx.common.api.chart
- Column - Class in net.pricefx.server.util.metamodel.dm
-
Represents a column and its metadata description.
- Column(DMField, Table) - Constructor for class Column
- com.flaptor.hist4j - package com.flaptor.hist4j
-
Provides histogram class.
- com.googlecode.genericdao.search - package com.googlecode.genericdao.search
-
Filter
is used by theSearch
class to specify a restriction on what results should be returned in the search. - comment - Variable in class WorkflowInfo.WorkflowStepInfo
-
A user comment entered during approval/denial
- ComparisonType - Enum Class in net.pricefx.common.api.chart
- COMPENSATION - Enum constant in enum class CalculationResultType
- CompensationBuilder - Class in net.pricefx.common.apibuilder.compensation
-
IMPORTANT: Please read super class notes on sequence of execution!
- CompensationBuilder(String, String, IdGenerator, Invocations<MethodInvocation>, Object, HeaderPhase) - Constructor for class CompensationBuilder
- COMPENSATIONRECORD - Enum constant in enum class CalculationResultType
- COMPLEX - Enum constant in enum class FieldFormatType
- COMPOSITEFLEXCHART - Enum constant in enum class CalculationResultType
- CompositeKey() - Constructor for class AttachedDocument.CompositeKey
- CompositeKey(Long, String) - Constructor for class AttachedDocument.CompositeKey
- COMPOSITEOFSIMPLE - Enum constant in enum class CalculationResultType
- computeFullName() - Method in class User
- CONDITION_RECORD_CREATION_FINISHED - Enum constant in enum class EventType
-
Condition records processing finished
- ConditionRecordHelper - Interface in net.pricefx.common.apihelper.conditionrecord
- CONFIG_WIZARDS_PAGE - Static variable in interface AppPages
-
Configuration pages
- CONFIGURATIONWIZARDPOPUP - Enum constant in enum class InputType
- configurator(String, String) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createConfiguratorInputBuilder(java.lang.String, java.lang.String, boolean)
(setisInline
tofalse
) instead. - configurator(String, String, Object) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createConfiguratorInputBuilder(java.lang.String, java.lang.String, boolean)
(setisInline
tofalse
) instead. - configurator(String, String, Object, Object) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createConfiguratorInputBuilder(java.lang.String, java.lang.String, boolean)
(setisInline
tofalse
) instead. - CONFIGURATOR - Enum constant in enum class InputType
- ConfiguratorEntry - Class in net.pricefx.server.dto.calculation
-
This class is used to transport a configurator entry.
- ConfiguratorEntry() - Constructor for class ConfiguratorEntry
-
Creates an empty configurator entry object.
- CONFIGURATORENTRY - Enum constant in enum class CalculationResultType
- ConfiguratorEntryArray - Class in net.pricefx.server.dto.calculation
-
This class is used to transport an array of configurator entries
- ConfiguratorEntryArray() - Constructor for class ConfiguratorEntryArray
- CONFIGURATORENTRYARRAY - Enum constant in enum class CalculationResultType
- ConfiguratorInputBuilder<VT> - Class in net.pricefx.formulaengine.scripting.inputbuilder
-
Builder class for input type Configurator or InlineConfigurator (
InputType.CONFIGURATOR
orInputType.INLINECONFIGURATOR
) - ConfiguratorInputBuilder(InputBuilderContext, String, String, boolean) - Constructor for class ConfiguratorInputBuilder
- CONFIGURATORTABLE - Enum constant in enum class InputType
- ConfiguratorTableInputBuilder - Class in net.pricefx.formulaengine.scripting.inputbuilder
- ConfiguratorTableInputBuilder(InputBuilderContext, String) - Constructor for class ConfiguratorTableInputBuilder
- conn - Variable in class TableContext
- consumeCalculationItems(Consumer<ModelParallelCalculationFormulaSummaryContext.CalculationItem>) - Method in interface ModelParallelCalculationFormulaSummaryContext
-
Iterates over all available calculation items, all status considered.
- consumeData(DatamartContext.Query, Closure<?>) - Method in interface DatamartContext
-
Deprecated.Use
DatamartContext.streamQuery(Query)
instead because of the limitation described above. - CONTAINS - Enum constant in enum class FilterOperator
- 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)
Example: - contextName() - Method in interface PublicGroovyAPI
-
Name of the current context, e.g. price list name, quote name etc.
- ContextParameter - Class in net.pricefx.server.dto.calculation
-
This class represents the input parameter, the input field.
- ContextParameter() - Constructor for class ContextParameter
- ContextParameter(String, DMFieldCollection, String, String) - Constructor for class ContextParameter
- ContextParameter(InputType, String, Object) - 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
- 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.
- contextUUID() - Method in interface PublicGroovyAPI
-
Returns a UUID of the calculation in case of list calculations.
- CONTRACT - Enum constant in enum class CalculationResultType
- ContractBuilder - Class in net.pricefx.common.apibuilder.contract
-
Please read notes in
CalculableLineItemCollectionBuilder
on how to use this builder. - ContractHelper - Class in net.pricefx.common.apibuilder.contract
-
A helper class that assists in manipulating the contract object.
- ContractHelper(Map<String, Object>) - Constructor for class ContractHelper
- ContractLineItem - Class in net.pricefx.domain
- ContractLineItem() - Constructor for class ContractLineItem
- ContractLineItem(ContractTermType) - Constructor for class ContractLineItem
- ContractStructure - Class in net.pricefx.common.apibuilder.contract
-
This is a helper object that is used to build up code-generated content of a Contract.
- ContractStructure() - Constructor for class ContractStructure
- ContractStructure.Item - Class in net.pricefx.common.apibuilder.contract
-
A DTO that holds information about the new item (contract type or folder) to be created.
- CONTRIB - Enum constant in enum class AggregationFormula
- convertValue(double) - Method in interface AdaptiveHistogram.ValueConversion
-
This method should implement the conversion function.
- copy() - Method in class DMField
- copy() - Method in class DMTable
- copyPriceItems(String, List<String>, long, String, long) - Method in interface PublicGroovyAPI
-
API method for convenient copy of price items between price calculable entities.
- copyWithoutValue() - Method in class ContextParameter
- count(String) - Method in class TableContext
-
Get the row count of a in-memory table
- 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 - Enum constant in enum class AggregationFormula
- COUNTDISTINCT - Enum constant in enum class AggregationFormula
- countKV(String) - Method in interface PublicGroovyAPI
-
Retrieves the count of all keys in table.
Note: Count is an anti-pattern for a key-value database. - cp - Variable in class AbstractInputBuilder
- create() - Method in class ActionItemApi.ActionItemBuilder
-
Finishes the create operation.
- create() - Method in class CustomFormApi.CustomFormBuilder
-
Finishes the create operation.
- createAnyUserEntry(String) - Method in class InputBuilderFactory
-
Creates new
UserEntry
InputType.USERENTRY
input (context parameter). - createBooleanUserEntry(String) - Method in class InputBuilderFactory
-
Creates new
BooleanUserEntry
Boolean
input (context parameter). - createButtonEntry(String) - Method in class InputBuilderFactory
-
Creates a new button input.
- createCollapseLayout(String) - Method in class InputBuilderFactory
-
Displays inputs in a collapsible section allowing users to expand or collapse this section.
The grouped items can be regular inputs, orInputType.ROW
elements or even another (nested)InputType.COLLAPSE
elements. - createConfigurationWizardPopup(String, String) - Method in class InputBuilderFactory
-
Creates a new user input of the
InputType.CONFIGURATIONWIZARDPOPUP
type – the "Open" button that opens the CW. - createConfiguratorEntry() - Method in interface PublicGroovyAPI
-
Creates an empty configurator entry object.
- createConfiguratorEntry(InputType, String) - Method in interface PublicGroovyAPI
-
Deprecated.Use
PublicGroovyAPI.createConfiguratorEntry()
and the Input Builder approach instead. - createConfiguratorEntry(InputType, String, Date) - Method in interface PublicGroovyAPI
-
Deprecated.Use
PublicGroovyAPI.createConfiguratorEntry()
and the Input Builder approach instead. - createConfiguratorEntryArray(Object...) - Method in interface PublicGroovyAPI
-
Creates a configurator entry array object which is to be returned from a logic element.
- createConfiguratorInputBuilder(String, String, boolean) - Method in class InputBuilderFactory
-
Creates a new
ConfiguratorEntry
(a form that must be filled with inputs – defined in the other logic). - createConfiguratorTable(String) - Method in class InputBuilderFactory
-
Creates a table (
InputType.CONFIGURATORTABLE
) where a user can add rows using the modal dialog (the pop-up Configurator). - createCustomerEntry() - Method in class InputBuilderFactory
-
Creates new
CustomerEntry
InputType.CUSTOMER
input (context parameter). - createCustomerEntry(String) - Method in class InputBuilderFactory
-
Creates new
CustomerEntry
InputType.CUSTOMER
input (context parameter). - createCustomerGroupEntry() - Method in class InputBuilderFactory
-
Creates new
CustomerGroupEntry
InputType.CUSTOMERGROUP
input (context parameter). - createCustomerGroupEntry(String) - Method in class InputBuilderFactory
-
Creates new
CustomerGroupEntry
InputType.CUSTOMERGROUP
input (context parameter). - createCustomFormListPopup(String, String) - Method in class InputBuilderFactory
-
Creates a new user input of the
InputType.CUSTOMFORMLISTPOPUP
type – the "Open" button that opens the pop-up modal. - createCustomFormPopup(String, String) - Method in class InputBuilderFactory
-
Creates a new user input of the
InputType.CUSTOMFORMPOPUP
type – the "Open" button that opens the standalone CFO. - CREATED - Enum constant in enum class ModelParallelCalculationFormulaSummaryContext.CalculationItem.Status
- createDashboardInputs(String, String, String...) - Method in class InputBuilderFactory
-
Creates a new
Dashboard Inputs
input which displays all inputs of a given dashboard. - createDashboardPopup(String) - Method in class InputBuilderFactory
-
Creates a new
InputType.DASHBOARDPOPUP
input which allows the user to select a Dashboard and define some associated preferences, including its input filters and displayed portlets. - createDateRangeUserEntry(String) - Method in class InputBuilderFactory
-
Creates new
DateRangeUserEntry
input (context parameter). - createDateTimeUserEntry(String) - Method in class InputBuilderFactory
-
Creates new
DateTimeUserEntry
input (context parameter). - createDateUserEntry(String) - Method in class InputBuilderFactory
-
Creates new
DateUserEntry
Date
input (context parameter). - createDMField(String, String) - Method in class InputBuilderFactory
-
Creates a new
DMField
InputType.DMFIELD
input field (a context parameter). - createDMFields(String, String) - Method in class InputBuilderFactory
-
Creates a new
DMField
InputType.DMFIELDS
input field (a context parameter). - createDmFilter(String, String, String) - Method in class InputBuilderFactory
-
Creates new DM dim filter input
InputType.DMDIMFILTER
. - createDmFilterBuilder(String, String) - Method in class InputBuilderFactory
-
Creates a new
InputType.DMFILTERBUILDER
input type.
NOTE:
If filters passed toDmFilterBuilder.setFilters(Object...)
are not correct, theInputBuilderExceptions.IllegalFilterException
is thrown.
If source name passed toDmFilterBuilder.setDmSourceName(String)
is not correct, theInputBuilderExceptions.NullOrEmptyArgumentException
is thrown.
Example: - createDmFilterBuilderMultiple(String, String) - Method in class InputBuilderFactory
-
Creates a new
datamartFilterBuilderUserEntries
InputType.DMFILTERBUILDERMULTIPLE
input (context parameter). - createDmQueryBuilder(String) - Method in class InputBuilderFactory
-
Advanced input allowing to build one or more queries on PA and PO data sources (DMDS, DM, DMT,...).
- createDmQueryBuilderDimOption(String, String, String, Map<String, Object>) - Method in class InputBuilderFactory
-
Creates a user input of the
DMDIMQUERYSTATEOPTION
type that loads only the list of dimension values from the Data Scope series, without querying all the data. - createDmQueryFilterBuilder(String, Map<String, Object>) - Method in class InputBuilderFactory
-
Advanced input to use jointly with DM Query Builder.
- createDMSource(String) - Method in class InputBuilderFactory
-
Creates a new
DMSource
InputType.DMSOURCE
input (a context parameter). - createElementNameFilter(String, Object, String...) - Method in interface PublicGroovyAPI
-
Creates a cross-list filter expression based on metadata.
- createFilterBuilder(String, String) - Method in class InputBuilderFactory
-
Creates new
FilterBuilderUserEntry
InputType.FILTERBUILDER
input (context parameter). - createFolder(String) - Method in class ContractStructure
-
Creates a new folder item, but does not add it to the list
- createFolder(String) - Method in class QuoteStructure
-
Creates a new folder item, but does not add it to the list
- createHiddenEntry(String) - Method in class InputBuilderFactory
-
Creates new hidden input (context parameter).
- createInputMatrix(String) - Method in class InputBuilderFactory
-
Creates new
InputMatrix
InputType.INPUTMATRIX
user input (context parameter). - createIntegerUserEntry(String) - Method in class InputBuilderFactory
- createItem(String) - Method in class ContractStructure
-
Creates a new "part" item but does not add it
- createMultiTierEntryInputBuilder(String) - Method in class InputBuilderFactory
-
Creates a new
MultiTierInputBuilder
.
Example: - createNewRevision(String) - Method in interface PublicGroovyAPI
-
Creates a revision of CalculableLineItemCollection (Quote, Rebate Agreement, Contract).
- createOptionEntry(String) - Method in class InputBuilderFactory
-
Creates new
OptionEntry
InputType.OPTION
user input (context parameter). - createOptionsEntry(String) - Method in class InputBuilderFactory
-
Creates new
OptionsEntry
InputType.OPTIONS
input (context parameter). - createOrUpdatePricegridInputAttribute(String, String, String, Long) - Method in interface PublicGroovyAPI
-
Creates or updates a user input attribute on an LPG.
- createOrUpdatePricelistInputAttribute(String, String, String, Long) - Method in interface PublicGroovyAPI
-
Creates or updates a user input attribute on a price list.
- createParameter(InputType, String) - Method in class ConfiguratorEntry
-
Creates a parameter and adds it to the list of inputs.
- createParameter(InputType, String, Date) - Method in class ConfiguratorEntry
-
Creates a parameter and adds it to the list of inputs.
- createParameter(ContextParameter) - Method in class ConfiguratorEntry
-
Creates a parameter and adds it to the list of inputs.
- createParameter(ContextParameter, Closure<?>) - Method in class ConfiguratorEntry
-
Creates a parameter and adds it to the list of inputs.
- createParsableInputTypeFile(String) - Method in class InputBuilderFactory
-
Creates a new
ParsableInputFile
InputType.PARSABLEINPUTFILE
input (a context parameter). - createPart(String) - Method in class QuoteStructure
-
Creates a new "part" item but does not add it
- createProductEntry() - Method in class InputBuilderFactory
-
Creates new
ProductEntry
InputType.PRODUCT
input (context parameter). - createProductEntry(String) - Method in class InputBuilderFactory
-
Creates new
ProductEntry
InputType.PRODUCT
user input (context parameter). - createProductGroupEntry() - Method in class InputBuilderFactory
-
Creates new
ProductGroupEntry
InputType.PRODUCTGROUP
input (context parameter). - createProductGroupEntry(String) - Method in class InputBuilderFactory
-
Creates new
ProductGroupEntry
InputType.PRODUCTGROUP
user input (context parameter). - createQuoteType(String) - Method in class InputBuilderFactory
-
Creates a new
QuoteType
InputType.QUOTETYPE
input (a context parameter). - createRadioEntry(String) - Method in class InputBuilderFactory
-
Creates a new radio input (context parameter).
- createRebateAgreement(String) - Method in class InputBuilderFactory
-
Creates a new
RebateAgreement
InputType.REBATEAGREEMENT
user input (a context parameter). - createResultMatrixFilterBuilder(String, ResultMatrix) - Method in class InputBuilderFactory
-
Creates a new user input of the
RESULTMATRIXFILTER
type. - createRevision() - Method in class CustomFormApi.OperationsApi
-
Creates a revision of a custom form, including attributes, inputs or outputs, but not attached documents, actions, notes, messages.
- createRowLayout(String) - Method in class InputBuilderFactory
-
Displays inputs in a row – inputs will appear next to one another in the user interface.
The default behavior (without employingInputBuilderFactory.createRowLayout(String)
) is to display inputs under each other. - createSellerEntry() - Method in class InputBuilderFactory
-
Creates new
SellerEntry
InputType.SELLER
input (context parameter). - createSellerEntry(String) - Method in class InputBuilderFactory
-
Creates new
SellerEntry
InputType.SELLER
user input (context parameter). - createSellerGroupEntry() - Method in class InputBuilderFactory
-
Creates new
SellerGroupEntry
InputType.SELLERGROUP
input (context parameter). - createSellerGroupEntry(String) - Method in class InputBuilderFactory
-
Creates new
SellerGroupEntry
InputType.SELLERGROUP
input (context parameter). - createSliderEntry(String) - Method in class InputBuilderFactory
-
Creates new slider input (context parameter).
- createStringUserEntry(String) - Method in class InputBuilderFactory
-
Creates new
StringUserEntry
user input (context parameter).
Example: - 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
- createTextUserEntry(String) - Method in class InputBuilderFactory
-
Creates new
TextUserEntry
InputType.TEXTUSERENTRY
user input (context parameter). - createTimeUserEntry(String) - Method in class InputBuilderFactory
-
Creates new
TimeUserEntry
user input (context parameter). - createUserEntry(String) - Method in class InputBuilderFactory
- createVLookup(String) - Method in class InputBuilderFactory
-
Creates new
LookUp
InputType.LOOKUP
input (context parameter). - CreationWorkflowDefinition - Class in net.pricefx.common.dto.creationworkflow
- CreationWorkflowDefinition() - Constructor for class CreationWorkflowDefinition
- CreationWorkflowStepDefinition - Class in net.pricefx.common.dto.creationworkflow
- CreationWorkflowStepDefinition() - Constructor for class CreationWorkflowStepDefinition
- criticalAlert(String) - Method in interface PublicGroovyAPI
-
Marks the current logic element as a critical alert and provides the given message.
- CUMCONTRIB - Enum constant in enum class AggregationFormula
- CUMSUM - Enum constant in enum class AggregationFormula
- CURRENCY - Enum constant in enum class FieldType
- currentContext() - Method in interface PublicGroovyAPI
-
Provides a Map of the current execution context info variables.
- currentContext(String) - Method in interface PublicGroovyAPI
-
In case of list processing (price lists, price grids), this method allows an easy access to values from the same list.
- currentContext(String, String) - Method in interface PublicGroovyAPI
-
In case of list processing (price lists, price grids), this method allows an easy access to values from the same list.
- currentItem() - Method in interface PublicGroovyAPI
-
In case of a list processing operation (for price lists, price grids), this method gets the currently worked on record, for example: For price calculations, it returns the price list item or price grid item or quote item. For Calculated Field Sets, it returns the row being processed, like Product/Customer/ProductExtension/PriceParameter row.
- currentItem(String) - Method in interface PublicGroovyAPI
-
The same as
PublicGroovyAPI.currentItem()
but it returns only the value of the given attribute. - currentItemByElementName(String) - Method in interface PublicGroovyAPI
-
In case of a list processing operation (for price lists, price grids), this method gets the currently worked on record's property by elementName.
- currentPartitionName() - Method in interface PublicGroovyAPI
-
Example: - currentStep() - Method in interface ModelFormulaContextReadOnly
- 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.
- CUSTOM - Enum constant in enum class EventType
-
Custom event created by a logic.
- CUSTOM_FORMS_NEW - Static variable in interface AppPages
-
New Custom Form -
targetPageState
JSON map with parameters: id (mandatory, custom form type) - CUSTOM_FORMS_PAGE - Static variable in interface AppPages
-
Custom Form page
- CUSTOM_FORMS_TYPE_PAGE - Static variable in interface AppPages
-
Custom Form Type page
- customer(String) - Method in interface PublicGroovyAPI
-
Retrieves the given attribute value from the Customers table for the customer selected by the user in the input parameter "Customer".
- 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 Customers table for the given customer.
- 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 istrue
, retrieves (and returns) the value from the customer's parent regardless if that value isnull
as well or not. - Customer - Class in net.pricefx.domain
- Customer() - Constructor for class Customer
- Customer(Partition) - Constructor for class Customer
- Customer(Partition, String, String) - Constructor for class Customer
- CUSTOMER - Enum constant in enum class InputType
- CustomerAssignment - Class in net.pricefx.domain
- CustomerAssignment() - Constructor for class CustomerAssignment
- customerExtension(String, Filter...) - Method in interface PublicGroovyAPI
-
Retrieves a list of all customer extentions records (CX) from a CX table named
extensionName
. - CustomerGroup - Class in net.pricefx.domain
-
CustomerGroup
- CustomerGroup() - Constructor for class CustomerGroup
- CUSTOMERGROUP - Enum constant in enum class InputType
- customerGroupEntry(String...) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createCustomerEntry(String)
instead. - customerGroupEntry(String, String, Object) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createCustomerEntry(String)
instead. - CustomerInputBuilder - Class in net.pricefx.formulaengine.scripting.inputbuilder
-
Builder class for input type Customer
InputType.CUSTOMER
- CustomerInputBuilder(InputBuilderContext, String) - Constructor for class CustomerInputBuilder
- 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 has a link to the given customer.
- customerToRelatedObjectsFilter(String, CustomerGroup) - 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 has a link to the given customer picker.
- 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".
- CUSTOMFORM - Enum constant in enum class CalculationResultType
- customFormApi() - Method in interface PublicGroovyAPI
-
Returns a
CustomFormApi
instance for operations related to Custom Forms. - CustomFormApi - Class in net.pricefx.server.dto.calculation
-
Utility class to work with Custom Forms in Groovy code
- CustomFormApi(FormulaEngineContext, ObjectMapper) - Constructor for class CustomFormApi
- CustomFormApi.CustomFormBuilder - Class in net.pricefx.server.dto.calculation
-
Helper class to create Custom Forms.
- CustomFormApi.DocumentActionApi - Class in net.pricefx.server.dto.calculation
-
Helper class to work with Custom Forms statuses.
- CustomFormApi.OperationsApi - Class in net.pricefx.server.dto.calculation
- CustomFormApi.RecalculateApi - Class in net.pricefx.server.dto.calculation
-
Helper class to recalculate Custom Forms.
- CustomFormApi.UpdateApi - Class in net.pricefx.server.dto.calculation
-
Helper class to update Custom Forms.
- CustomFormApi.WorkflowActionApi - Class in net.pricefx.server.dto.calculation
-
Helper class to work with Workflow statuses.
- CustomFormCollectionBuilder - Class in net.pricefx.common.apibuilder.customform
-
CustomFormCollectionBuilder is the starting point of an interface that allows you to manipulate a custom form object in a custom form header calculation logic.
The header calculation is executed twice: Once as 'pre phase' and once after that as 'post phase'.
UseisPrePhase()
andisPostPhase()
methods to detect the current phase. - CustomFormCollectionBuilder(String, String, IdGenerator, Invocations<MethodInvocation>, Map<String, Object>, HeaderPhase) - Constructor for class CustomFormCollectionBuilder
- CUSTOMFORMLISTPOPUP - Enum constant in enum class InputType
- CustomFormListPopupInputBuilder - Class in net.pricefx.formulaengine.scripting.inputbuilder
- CustomFormListPopupInputBuilder(InputBuilderContext, String, String) - Constructor for class CustomFormListPopupInputBuilder
- CUSTOMFORMPOPUP - Enum constant in enum class InputType
D
- DARK_GREEN - Enum constant in enum class AuxLineColor
- DARK_RED - Enum constant in enum class AuxLineColor
- dashboard(String) - Method in interface PublicGroovyAPI
-
Returns a
DashboardApi
instance for a dashboard of the specified name. - DASHBOARD - Enum constant in enum class CalculationResultType
- DashboardApi - Interface in net.pricefx.server.dto.calculation.dashboard
-
DashboardApi
interface is used for configuration of Embedded Dashboards. - 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 - Enum constant in enum class CalculationResultType
- Dashboard Display Modes - Search tag in interface net.pricefx.server.dto.calculation.dashboard.DashboardApi
- Section
- DASHBOARDINPUTS - Enum constant in enum class InputType
- DashboardInputsInputBuilder - Class in net.pricefx.formulaengine.scripting.inputbuilder
-
Builder class for input type
DashboardInputs
. - DashboardInputsInputBuilder(InputBuilderContext, String, String, String...) - Constructor for class DashboardInputsInputBuilder
- DASHBOARDPOPUP - Enum constant in enum class InputType
- DashboardPopupInputBuilder - Class in net.pricefx.formulaengine.scripting.inputbuilder
-
Builder class for input type
DashboardPopup
. - DashboardPopupInputBuilder(InputBuilderContext, String) - Constructor for class DashboardPopupInputBuilder
- DashboardPopupInputBuilder.Dto - Class in net.pricefx.formulaengine.scripting.inputbuilder
- dashboardWideEvent(String) - Method in interface PublicGroovyAPI
-
Constructs an event name that is unique to the current dashboard.
- DataLoadAction<T> - Class in net.pricefx.common.apibuilder.calculationflowaction
-
This action starts calculation of selected data load.
- DataLoadAction(T, 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. in email templates
- datamartCalendar() - Method in interface PublicGroovyAPI
-
Deprecated.Use
DatamartContext.calendar()
instead. - 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 for working with dates and time periods as used in the PriceAnalyzer module.
- DatamartContext.Column - Interface in net.pricefx.formulaengine
- DatamartContext.DataLoader - Interface in net.pricefx.formulaengine
-
API for loading data into a
DMDataFeed
orDMTable
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.
- DatamartContext.SqlQuery - Interface in net.pricefx.formulaengine
- DatamartContext.Table - Interface in net.pricefx.formulaengine
- datamartCustomerGroupEntry(String...) - Method in interface PublicGroovyAPI
-
Deprecated.since 13.0 - Rampur. Use
PCGroupInputBuilder.setPaSearchable(Boolean)
instead. - 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.
- datamartFilterBuilderUserEntries(String, String, Object...) - Method in interface PublicGroovyAPI
-
Deprecated.
- datamartFilterBuilderUserEntry(String, String, Object...) - Method in interface PublicGroovyAPI
-
Deprecated.
- datamartLookup(Object...) - Method in interface PublicGroovyAPI
- datamartProductGroupEntry(String...) - Method in interface PublicGroovyAPI
-
Deprecated.since 13.0 - Rampur. Use
PCGroupInputBuilder.setPaSearchable(Boolean)
instead. - datamartQuery(Object...) - Method in interface PublicGroovyAPI
-
Deprecated.
- DatamartQueryResult - Interface in net.pricefx.formulaengine
-
Provides access to a QueryResult in a formula context.
- DatamartRowSet - Interface in net.pricefx.formulaengine
-
Represents the data of a PA field collection (Data Feed, Data Source, Datamart, etc.) and provides methods to work with it.
- datamartSellerGroupEntry(String...) - Method in interface PublicGroovyAPI
-
Deprecated.since 13.0 - Rampur. Use
PCGroupInputBuilder.setPaSearchable(Boolean)
instead. - DATATABLE - Enum constant in enum class ChartType
- 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 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
- DataType - Enum Class in net.pricefx.common.api.pa
- date() - Static method in class CalendarUtil
- DATE - Enum constant in enum class FieldFormatType
- DATE - Enum constant in enum class DataType
- DATE - Enum constant in enum class FieldType
- DATE - Enum constant in enum class LookupTable.LookupTableValueType
- DateRangeInputBuilder - Class in net.pricefx.formulaengine.scripting.inputbuilder
-
Builder class for input type DateRangeUserEntry
InputType.DATERANGEUSERENTRY
. - DateRangeInputBuilder(InputBuilderContext, String) - Constructor for class DateRangeInputBuilder
- dateRangeUserEntry(String) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createDateRangeUserEntry(String)
instead. - DATERANGEUSERENTRY - Enum constant in enum class InputType
- DATETIME - Enum constant in enum class FieldFormatType
- DATETIME - Enum constant in enum class DataType
- DATETIME - Enum constant in enum class FieldType
- dateTimeUserEntry(String) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createDateTimeUserEntry(String)
instead. - DATETIMEUSERENTRY - Enum constant in enum class InputType
- dateUserEntry(String) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createDateUserEntry(String)
instead. - DATEUSERENTRY - Enum constant in enum class InputType
- DAY - Enum constant in enum class CalendarUtil.TimeUnit
- DAY - Enum constant in enum class ModelSchedulesContextReadOnly.PeriodUnit
- DB_DASHBOARDS_PAGE - Static variable in interface AppPages
-
Dashboards -
targetPageState
optional dashboard name - DEAL - Enum constant in enum class AttachedDocument.DocumentStatus
- decideFormat(Object) - Method in class ResultMatrix
-
Deprecated.
- decimalUserEntry(String) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createUserEntry(String)
instead. - DEFAULT - Enum constant in enum class ColorAxisType
- DEFAULT - Static variable in class CalendarUtil
- DEFAULT_DATE_PATTERN - Static variable in class CalendarUtil
- DEFAULT_DATETIME_PATTERN - Static variable in class CalendarUtil
- DEFAULT_SETLABEL - Static variable in class RebateRecordSet
- delete() - Method in class CustomFormApi.OperationsApi
-
Deletes a custom form with the specified id.
- delete(Filter...) - Method in interface PayoutRecordManager
-
Deletes PayoutRecords/AccrualRecords linked to the current RebateRecord/CompensationRecord that match one or more optional Filter criteria.
- delete(String) - Method in interface ModelSchedulesContextReadWrite
-
Deletes a schedule from the model.
- delete(String, Map<String, Object>) - Method in interface PublicGroovyAPI
-
Deletes an object in the collection of objects of the given type.
- deleteCalcItems(Filter...) - Method in interface DistCalcFormulaContext
-
Deprecated.As calcItems are now created on JST level, i.e. for each run of the distributed DDL, it is no longer needed, or required, to delete previously created calcItems as there will be none. This method is still included to not break existing logics, where it was common to delete the calcItems in the 'init' stage of the job.
- deleteCurrentRow() - Method in interface DatamartRowSet
-
Deletes the current row.
- deleteItem(String) - Method in class CalculableLineItemCollectionBuilder
-
Deletes an item or folder.
- deleteRecords() - Method in interface ModelCalcFormulaContext
-
Deletes all ModelRecords associated with the model, which are not yet submitted into the workflow.
- deleteRow(Map<String, Object>) - Method in interface DatamartRowSet
-
Deletes a row.
- deleteTree(String) - Method in interface ModelCalcFormulaContext
-
Deletes the tree with the given name, if it exists.
- DELIMITER - Static variable in class Filter
- DENIED - Enum constant in enum class ApprovalState
- deny() - Method in class CustomFormApi.WorkflowActionApi
-
Finishes the denial operation.
- DESC - Enum constant in enum class TieredValueSortType
- DESCENDING - Enum constant in enum class SortType
- deserialize(String) - Method in enum class DataType
- 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 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> - Class in net.pricefx.common.apibuilder.chart
- Dictionary(C, String, String) - Constructor for class Dictionary
- DIMENSION - Enum constant in enum class DMFieldInputBuilder.FieldKind
- dimFilterEntry(String, DatamartContext.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, DatamartContext.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.
- DistCalcFormulaContext - Interface in net.pricefx.formulaengine
-
DistCalcFormulaContext is a groovy api exposed through the 'dist' binding when running a DistributedCalculation DL (PA DataLoad job).
- DistFormulaContext - Interface in net.pricefx.formulaengine
-
DistFormulaContext is a groovy api exposed through the 'dist' binding when evaluating the logic for a DistributedCalculation DL through invocation of the datamart.formulaparams and datamart.distcalcexec endpoints.
- DMCalendar - Class in net.pricefx.domain
- DMCalendar() - Constructor for class DMCalendar
- DMCalendar.TimeDim - Class in net.pricefx.domain
- DMDataSlice - Class in net.pricefx.domain
- DMDataSlice() - Constructor for class DMDataSlice
- DMDataSlice(Object...) - Constructor for class DMDataSlice
- DMDataSlice(String, Object...) - Constructor for class DMDataSlice
- DMDIMFILTER - Enum constant in enum class InputType
- DMDIMQUERYSTATEOPTION - Enum constant in enum class InputType
- DMField - Class in net.pricefx.domain
- DMField() - Constructor for class DMField
- DMField(String, FieldType) - Constructor for class DMField
- DMFIELD - Enum constant in enum class InputType
- DMFieldInputBuilder - Class in net.pricefx.formulaengine.scripting.inputbuilder
- DMFieldInputBuilder(InputBuilderContext, InputType, String, String) - Constructor for class DMFieldInputBuilder
- DMFieldInputBuilder.FieldKind - Enum Class in net.pricefx.formulaengine.scripting.inputbuilder
- DMFIELDS - Enum constant in enum class InputType
- DmFilter - Class in net.pricefx.formulaengine.scripting.inputbuilder
-
Builder class for input type DMFilterBuilder
InputType.DMFILTERBUILDER
. - DmFilter(InputBuilderContext, String, String, String) - Constructor for class DmFilter
- DmFilterBuilder - Class in net.pricefx.formulaengine.scripting.inputbuilder
-
Builder class for input type DMFilterBuilder
InputType.DMFILTERBUILDER
. - DmFilterBuilder(InputBuilderContext, String, String) - Constructor for class DmFilterBuilder
- DMFILTERBUILDER - Enum constant in enum class InputType
- DMFILTERBUILDERMULTIPLE - Enum constant in enum class InputType
- DMQUERYBUILDER - Enum constant in enum class InputType
- DmQueryBuilderInputBuilder - Class in net.pricefx.formulaengine.scripting.inputbuilder
-
Builder class for input type
DmQueryBuilder
. - DMQUERYFILTERBUILDER - Enum constant in enum class InputType
- DMSOURCE - Enum constant in enum class InputType
- DMSourceInputBuilder - Class in net.pricefx.formulaengine.scripting.inputbuilder
- DMSourceInputBuilder(InputBuilderContext, String) - Constructor for class DMSourceInputBuilder
- DMTable - Class in net.pricefx.domain
- DMTable() - Constructor for class DMTable
- DMTable(String, PartitionedObject, String) - Constructor for class DMTable
- DMTable(String, PartitionedObject, DMFieldCollection) - Constructor for class DMTable
- doArchive(String) - Method in class ExportAction
-
Notifies system that archiving for selected template should be started.
- documentAction() - Method in class CustomFormApi.OperationsApi
-
Initiates an operation action on statuses.
- DocumentActionApi(Long, CustomFormService, ValidationVisitor, FormulaEngineContext, CustomFormServiceProperties, PersistedObjectService) - Constructor for class CustomFormApi.DocumentActionApi
-
Document action constructor, which allows to inject custom validator
- DocumentActionApi(Long, CustomFormService, PersistedObjectService, FormulaEngineContext, CustomFormServiceProperties) - Constructor for class CustomFormApi.DocumentActionApi
-
Default document action constructor with SimpleValidationVisitor hardcoded
- doDelete() - Method in class ActionItemApi.ActionItemBuilder
-
Finishes the delete operation.
- DOES_NOT_CONTAIN - Enum constant in enum class FilterOperator
- DOES_NOT_END_WITH - Enum constant in enum class FilterOperator
- DOES_NOT_START_WITH - Enum constant in enum class FilterOperator
- doExecute() - Method in class ActionItemApi.ActionItemBuilder
- doExport(String) - Method in class ExportAction
-
Notifies system that export for selected template should be started.
- doHardDelete() - Method in class LookupTable
- doHardDelete() - Method in class ManualPricelist
- doHardDelete() - Method in class PriceGrid
- doHardDelete() - Method in class Pricelist
- doHardDelete() - Method in class Simulation
- doRecalculate() - Method in class ActionItemApi.ActionItemBuilder
-
Recalculates the Action Item with the specified id.
- doRecalculate() - Method in class CustomFormApi.RecalculateApi
-
Finishes the recalculation operation.
- doUpdate() - Method in class ActionItemApi.ActionItemBuilder
-
Finishes the update operation.
- doUpdate() - Method in class CustomFormApi.UpdateApi
-
Finishes the update operation.
- downloadButton(String, String, String) - Method in interface ResultMatrix
- downloadButton(String, String, String) - Method in class ResultMatrix
-
Deprecated.
- DP_PAGE - Static variable in interface AppPages
-
Deprecated.The Deal Planning module has been discontinued since version 11.3.0.
- DP_TYPES_PAGE - Static variable in interface AppPages
-
Deprecated.The Deal Planning module has been discontinued since version 11.3.0.
- DRAFT - Enum constant in enum class RebateAgreementStatus
- DRAFT - Enum constant in enum class RebateRecordStatus
- DRAFT - Enum constant in enum class AttachedDocument.DocumentStatus
-
In case of changes modify AttachedDocumentView accordingly
- DRAFT - Enum constant in enum class CalculationStatus
-
draft state, nothing happening
- dragDropEnabled - Variable in class AbstractChartBuilder
- drop() - Method in interface ModelFilterTreesContextReadWrite.MutableFilterTree
-
Delete this tree
- drop() - Method in interface ModelLookupTablesContextReadWrite.MutableModelLookupTable
-
Delete this table
- dropTable(String) - Method in interface ModelCalcFormulaContext
-
Drops the table, uniquely identified by tableName within this model.
- dropTable(String) - Method in class TableContext
-
Drops an existing in-memory table.
- dropTable(DatamartContext.Table) - Method in interface ModelFormulaContextReadWrite
- duplicate() - Method in class CustomFormApi.OperationsApi
-
Duplicates a custom form, including inputs, outputs, and embedded objects.
E
- editabilityStatus - Variable in class ContractStructure.Item
- 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(C, String) - Constructor for class ChartOptions.EmbeddedBoxplot
- EmbeddedBoxplot(C, String) - Constructor for class ChartSeries.EmbeddedBoxplot
- EmbeddedBoxplot(S, String) - Constructor for class ChartMeasures.EmbeddedBoxplot
- emit(Object) - Method in interface PublicGroovyAPI
-
Emits an object to be consumed by an external thread.
- emitCompensationRecords(String, String, Filter...) - Method in interface PublicGroovyAPI
-
Emits the compensation 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 CompensationRecord as its currentItem context, and distributing one or more CompensationRecord accruals over the set of PA rows which have contributed to those accruals in some way (by revenue, volume...).
- emitCompensationRecords(String, String, String, Filter...) - Method in interface PublicGroovyAPI
-
Emits the compensation 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 CompensationRecord as its currentItem context, and distributing one or more CompensationRecord accruals over the set of PA rows which have contributed to those accruals in some way (by revenue, volume...).
- emitDMScopedObject(String, DMDataSlice) - Method in interface PublicGroovyAPI
-
Emits the partitioned object - 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 partitioned object as its currentItem context, and distributing one or more partitioned object accruals over the set of PA rows which have contributed to those accruals in some way (by revenue, volume...).
- emitPersistedObject(String) - Method in interface PublicGroovyAPI
-
Finds a PersistedObject with the given typedId and emits it if it exists.
- emitPersistedObject(String, Long) - Method in interface PublicGroovyAPI
-
Finds a 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, volume...).
- emitRebateRecords(String, 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, volume...).
- emitUserUpdateAction() - Method in class User
- ENABLE_ANALYSIS - Static variable in interface AppPages
-
Enable page to analysis
- ENABLE_APPROVALS - Static variable in interface AppPages
-
Enable page to approvals
- ENABLE_CUSTOMERS - Static variable in interface AppPages
-
Enable page to customers
- ENABLE_EARNINGS - Static variable in interface AppPages
-
Enable page to earnings
- ENABLE_FORECASTING - Static variable in interface AppPages
-
Enable page to forecasting
- ENABLE_PROGRAM_LINE - Static variable in interface AppPages
-
Enable page to program line
- ENABLE_PROGRAM_LINES - Static variable in interface AppPages
-
Enable page to program lines
- ENABLE_SETTINGS - Static variable in interface AppPages
-
Enable page to settings
- ENABLE_TERMS - Static variable in interface AppPages
-
Enable page to terms
- enableAutoFlushMode() - Method in interface PublicGroovyAPI
-
Sets the db session flush mode to AUTO so that subsequent db operations will work with the actual state of domain objects db which have just been updated during the logic execution (via
PublicGroovyAPI.add(String, Map)
,PublicGroovyAPI.update(String, Map)
,PublicGroovyAPI.addOrUpdate(String, List)
,PublicGroovyAPI.delete(String, Map)
). - endDate(Date) - Method in enum class CalendarUtil.TimeUnit
- ENDS_WITH - Enum constant in enum class FilterOperator
- 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.
- EQUAL - Enum constant in enum class FilterOperator
- equals(Object) - Method in class Filter
- equals(Object) - Method in class WorkflowDTO.StepDTO
- equals(Object) - Method in class AttachedDocument.CompositeKey
- equals(Object) - Method in class CustomerGroup
-
Indicates (returns true or false) whether another object is equal.
- equals(Object) - Method in class DMField
- equals(Object) - Method in class ContextParameter
- ERROR - Enum constant in enum class CalculationStatus
-
Error during computation.
- ERRORS - Static variable in class ModelEvaluator
- eval(String) - Method in interface RContext
-
Parses and evaluates an R expression and returns the result.
- evalCustomerFilterLogic(String, String) - Method in interface PublicGroovyAPI
-
Evaluates the customer (group) filter logic.
- evalExpression(String) - Method in interface PublicGroovyAPI
-
Evaluates an arithmetic expression that is passed as a string.
- evalProductFilterLogic(String, String) - Method in interface PublicGroovyAPI
-
Evaluates the product (group) filter logic.
- evalSellerFilterLogic(String, String) - Method in interface PublicGroovyAPI
-
Example: - evaluate(String, Map<String, Object>) - Method in interface ModelContext
- evaluate(String, Map<String, Object>, Map<String, Object>) - Method in interface ModelContext
-
This method is useful if the calling logic wants to keep in its global cache some data stored in api.global of the evaluated logic.
- evaluate(Map<?, ?>) - Method in interface ModelPMMLContext.PMMLEvaluator
-
Evaluates the pmml model with the given inputs and returns a set of results.
- evaluate(Map<String, Object>) - Method in class ModelEvaluator
-
Executes a model's evaluation logic, taking a map of input parameters.
- evaluateTree(ModelFormulaContext.TreeNode, Map<String, Object>) - Method in class ModelEvaluator
-
Determines the node in a model tree that complies to the given input, starting from a given TreeNode.
- eventName - Variable in class AbstractChartEvent.TriggerEvent
- EventType - Enum Class in net.pricefx.common.api
-
All possible event type constants.
- Example - Search tag in class net.pricefx.formulaengine.scripting.inputbuilder.InputBuilderFactory
- Section
- Examples - Search tag in interface net.pricefx.server.dto.calculation.dashboard.DashboardApi
- Section
- Examples (internal access only) - Search tag in Overview
- Section
- exclude(CalendarUtil.TimePeriod) - Method in class DMDataSlice
- exclude(CalendarUtil.TimePeriod) - Method in interface DatamartContext.DataSlice
- exclude(CustomerGroup) - Method in class DMDataSlice
- exclude(CustomerGroup) - Method in interface DatamartContext.DataSlice
- exclude(ProductGroup) - Method in class DMDataSlice
- exclude(ProductGroup) - Method in interface DatamartContext.DataSlice
- exclude(SellerReference) - Method in class DMDataSlice
- 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(String) - Method in class TableContext
- executeQuery(DatamartContext.Query) - Method in interface DatamartContext
-
Executes the given
DatamartContext.Query
. - 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 the future releases.
The DB schema that can be queried is constructed on the fly by means of view definitions. - executeSqlQuery(DatamartContext.SqlQuery) - Method in interface DatamartContext
-
Executes an ANSI compliant SQL SELECT statement in the PA DB.
- 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<T> - Class in net.pricefx.common.apibuilder.calculationflowaction
-
This action starts exporting or archiving.
- ExportAction(T, Invocations<MethodInvocationRecord>, String) - Constructor for class ExportAction
- exportDate() - Method in class Pricelist
- Expression<O> - Class in net.pricefx.common.apibuilder.chart
- Expression(O, String, String) - Constructor for class Expression
- extraCSS - Variable in class ResultMatrix.ResultMatrixStyledCell
-
Deprecated.
F
- FAILED - Enum constant in enum class ModelParallelCalculationFormulaSummaryContext.CalculationItem.Status
- fc - Variable in class Table
- fc() - Method in class Table
- fetch() - Method in interface ModelFilterTreesContextReadOnly.FilterTree
-
Fetch the whole tree.
- fetchBranch(long) - Method in interface ModelFilterTreesContextReadOnly.FilterTree
-
Fetch one branch of the tree, starting from the given node up to the root.
- fetchKV(String, Map<String, Object>, int) - Method in interface PublicGroovyAPI
-
Retrieves multiple values from the specified table.
- field - Variable in class Column
- FIELD_ACTIVATED - Static variable in class User
- FIELD_CUSTOMERID - Static variable in class Customer
- FIELD_DISTRIBUTIONKEY - Static variable in class DMField
- FIELD_EMAIL - Static variable in class User
- FIELD_EXPRESSION - Static variable in class DMField
- FIELD_FORMAT - Static variable in class DMField
- FIELD_FORMULAELEMENT - Static variable in class DMField
- FIELD_ID - Static variable in class LookupTable
- FIELD_LABEL - Static variable in class DMField
- FIELD_LOGINNAME - Static variable in class User
- FIELD_NAME - Static variable in class DMField
- FIELD_NAME - Static variable in class DMTable
- FIELD_NAME - Static variable in class LookupTable
- FIELD_OWNER - Static variable in class DMTable
- FIELD_OWNER - Static variable in class LookupTable
- FIELD_PARTITIONINGKEY - Static variable in class DMField
- FIELD_REBATERECORDSETID - Static variable in class RebateRecordSet
- FIELD_SOURCE - Static variable in class DMField
- FIELD_SOURCEFIELD - Static variable in class DMField
- FIELD_TYPE - Static variable in class DMField
- FieldFormatType - Enum Class in net.pricefx.common.api
-
Enumeration of existing FieldFormatTypes.
- fieldSelectionEntry(String, String) - Method in interface DatamartContext
- fieldSelectionEntry(String, String, Collection<String>, Boolean) - Method in interface DatamartContext
- fieldSelectionEntry(String, DatamartContext.Table, String) - Method in interface DatamartContext
-
FC field selector, optionally limited to fields of a given type.
- fieldSelectionEntry(String, DatamartContext.Table, String, Boolean) - Method in interface DatamartContext
-
FC field selector, optionally limited to fields of a given type.
- FieldType - Enum Class in net.pricefx.common.api.pa
- fileInfixTimestamp() - Method in class CalendarUtil
- fileInfixTimestamp(Date) - Method in class CalendarUtil
- fillSubmitter(User) - Method in class Pricelist
- fillWfLastExecutedByName(User) - Method in class Pricelist
- filter - Variable in class ModelFormulaContext.TreeNode
- filter - Variable in class ModelFilterTreesContextReadWrite.NodeSpec
-
Defines the filter of the tree view node.
- filter() - Method in interface ModelFilterTreesContextReadOnly.FilterTreeNode
- filter(Filter) - Method in class ResultMatrix
-
Deprecated.
- filter(String, Object) - Method in interface PublicGroovyAPI
-
Deprecated.Use
equal(String, Object)
instead - filter(String, Object, Object) - Method in interface PublicGroovyAPI
-
Deprecated.Use the
Filter
functions instead - Filter - Class in com.googlecode.genericdao.search
-
A
Filter
is used by theSearch
class to specify a restriction on what results should be returned in the search. - Filter() - Constructor for class Filter
- Filter(String, Object) - Constructor for class Filter
- Filter(String, Object, int) - Constructor for class Filter
- Filter(Map<String, ?>) - Constructor for class Filter
- FILTERBUILDER - Enum constant in enum class InputType
- FilterBuilderInputBuilder - Class in net.pricefx.formulaengine.scripting.inputbuilder
-
Builder class for input type FilterBuilder
InputType.FILTERBUILDER
. - FilterBuilderInputBuilder(InputBuilderContext, String, String) - Constructor for class FilterBuilderInputBuilder
- filterBuilderUserEntry(String, String) - Method in interface PublicGroovyAPI
-
Deprecated.
- filterDescription - Variable in class ModelFilterTreesContextReadWrite.NodeSpec
-
Defines the label for the filter.
- filterDescription() - Method in interface ModelFilterTreesContextReadOnly.FilterTreeNode
- filterFormulaName - Variable in class AbstractProductAndCustomerInputBuilder
- filterFormulaParam - Variable in class AbstractProductAndCustomerInputBuilder
- 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 Class in net.pricefx.common.api.chart
- filters - Variable in class AbstractChartSeries
- Filters<O> - Class in net.pricefx.common.apibuilder.chart
- Filters(O, String, String) - Constructor for class Filters
- filterTreesContext() - Method in interface ModelFormulaContextReadOnly
- filterTreesContext() - Method in interface ModelFormulaContextReadWrite
- find(Filter...) - Method in interface PayoutRecordManager
-
Retrieves PayoutRecords or AccrualRecords linked to the current RebateRecord/CompensationRecord that match one or more optional Filter criteria.
- 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>, boolean, 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, Map<String, String>, boolean, Filter...) - Method in interface PublicGroovyAPI
-
The Swiss army knife method of the API.
- find(String, int, Filter...) - Method in interface PublicGroovyAPI
-
Deprecated.Instead use
PublicGroovyAPI.find(String, int, int, String, List, Filter...)
where you should always specify the fields to be returned. - find(String, int, String, Filter...) - Method in interface PublicGroovyAPI
-
Deprecated.Instead use
PublicGroovyAPI.find(String, int, int, String, List, Filter...)
where you should always specify the fields to be returned. - find(String, Filter...) - Method in interface PublicGroovyAPI
-
Deprecated.Instead use
PublicGroovyAPI.find(String, int, int, String, List, Filter...)
in order to always specify the fields to be returned (for performance reasons). - findAllWithContractTermTypeUN(String) - Method in class ContractHelper
-
Finds all contract line items with the specified contract term type.
- findAllWithLabel(String) - Method in class LineItemHelper
- findAllWithRebateTypeUN(String) - Method in class RebateAgreementHelper
- 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.
- findAttachedDocuments(String, String, Filter...) - Method in interface PublicGroovyAPI
-
Deprecated.The Deal Planning module has been discontinued since version 11.3.0.
- findByLineId(String) - Method in class LineItemHelper
- findCalcItem(Object, Object) - Method in interface ModelCalcFormulaContext
-
Deprecated.
- findCalcItems(Filter) - Method in interface DistCalcFormulaContext
-
Deprecated.Provided for backwards compatibility only. It is discouraged to configure behaviour where the processing of a calculation item (batch) is dependent on some other calculation item(s).
- findCalcItems(Object) - Method in interface ModelCalcFormulaContext
-
Deprecated.
- findCalculatedFieldSets(Date, String) - Method in interface PublicGroovyAPI
-
Returns a list of calculated field sets that match the targetDate.
- findCompensationRecordLoad(String) - Method in interface PublicGroovyAPI
-
Example: - 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 which match the given CustomerGroup (the first 200 entries are returned).
- findCustomersInGroup(CustomerGroup, int, String) - Method in interface PublicGroovyAPI
-
Retrieves a list of customers which match the given CustomerGroup with custom paging and sorting.
- findDataLoad(String, String, String) - Method in interface PublicGroovyAPI
-
Example: - findLookupTable(String) - Method in interface PublicGroovyAPI
-
Finds a Company Parameter / Price Parameter table object (LT): of the given name; which is valid at the current target date; whose Status is Active or Simulation Only (Simulation Only tables will be used only when the logic is run as simulation); if executed during simulation, it must have a matching Simulation Set.
- findLookupTableValues(String, Filter...) - Method in interface PublicGroovyAPI
-
Returns a filtered list of rows of a Company Parameter / Price Parameter table values.
- findLookupTableValues(String, String, Filter...) - Method in interface PublicGroovyAPI
-
Returns sorted rows of a Company Parameter / Price Parameter table (optionally filtered).
- findLookupTableValues(String, List<String>, String, Filter...) - Method in interface PublicGroovyAPI
-
Returns sorted rows of a Company Parameter / Price Parameter table (optionally filtered).
- findLookupTableValues(String, Map<String, Object>, List<String>, String, Filter...) - Method in interface PublicGroovyAPI
-
Returns sorted rows of a Company Parameter / 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. list's validAfter <= targetDate and expiryDate > targetDate).
- 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's 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. price grid's targetDate <= targetDate).
- findPricelists(Date, String) - Method in interface PublicGroovyAPI
-
Returns a list of price lists that match the targetDate (i.e. list's targetDate <= targetDate and expiryDate > targetDate).
- findRebateRecordLoad(String) - Method in interface PublicGroovyAPI
-
Example: - findRecord(String, Date, String) - Method in interface ModelFormulaContext
-
Finds the ModelRecord, if it exists, with the given name, valid on the given day (record.startDate <= validOnDate <= record.endDate), and with the given workflow status, if not
null
. - findRecords(Filter, String...) - Method in class ModelEvaluator
-
Equivalent to
ModelFormulaContext.findRecords(Filter, String...)
. - findRecords(Filter, String...) - Method in interface ModelFormulaContext
-
Finds ModelRecords associated to this model using only Filter criteria.
- findRow(String, Object) - Method in interface ResultMatrix
-
Retrieves a particular row based on a value check
- findRow(String, Object) - Method in class ResultMatrix
-
Deprecated.
- findSellersInGroup(SellerGroup) - Method in interface PublicGroovyAPI
-
Retrieves a list of sellers that match the given SellerGroup (the first 200 entries are returned).
- findSellersInGroup(SellerGroup, int, String) - Method in interface PublicGroovyAPI
-
Retrieves a list of sellers that match the given SellerGroup with custom paging and sorting.
- findSimulations(Date, String) - Method in interface PublicGroovyAPI
-
Returns a list of simulations that match the targetDate (i.e. list's targetDate <= targetDate).
- findTreeNode(String, List<String>) - Method in interface ModelFormulaContext
-
List
addTree(String treeName, Matrix2D data, Collection levelCols, Collection labelCols, String outputColName, String outputColFormat); String treeName, Matrix2D data, Collection levelCols, Collection labelCols, String outputColName, String outputColFormat ); Finds the tree node, if it exists, in the given tree with the given path
. - findWorkflowInfo(String, Object) - Method in interface PublicGroovyAPI
-
Finds active workflows for the given approvable.
- first() - Method in interface DatamartRowSet
-
Sets the current row index of this
DatamartRowSet
to the first row. - FLEXCHART - Enum constant in enum class CalculationResultType
- flush() - Method in interface DatamartContext.DataLoader
-
Flushes the data to the DB.
- flush() - Method in interface PayoutRecordManager
-
To be called when all records have been created and/or updated.
- fontweight - Variable in class ResultMatrix.ResultMatrixStyledCell
-
Deprecated.
- format(Object) - Method in enum class DataType
- formatCurrency(String, Object) - Method in interface PublicGroovyAPI
-
Formats a number with the currency symbol as a String.
- formatCurrency(String, String, Object) - Method in interface PublicGroovyAPI
-
Formats a number with the currency symbol as a String.
- formatDate(LocalDate) - Method in class CalendarUtil
- formatDate(Date) - Method in class CalendarUtil
- formatDateTime(LocalDateTime) - Method in class CalendarUtil
- formatDateTime(Date) - Method in class CalendarUtil
- formatDateTime(DateTime) - Method in class CalendarUtil
- 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
-
Formats a string like
String.format(java.lang.String, java.lang.Object...)
. - formatting - Variable in class ResultMatrix.ResultMatrixStyledCell
-
Deprecated.
- Formula<S> - Class in net.pricefx.common.apibuilder.chart
- Formula(S, String, String) - Constructor for class Formula
- FORMULA - Enum constant in enum class AggregationFormula
- fromAttachment(String) - Method in interface ModelPMMLContext
-
Loads a @link{PMMLEvaluator} from a given attachment of the model and returns it.
- fromExisting(String) - Method in class RATBuilder
- fromFirstStep() - Method in class ModelCalculationAction
-
Sets the calculation range of steps of the specified model, beginning with the first step (included).
- fromListOfMaps(Collection<String>, Collection<Map<String, Object>>) - Static method in interface Matrix2D
- fromListOfMaps(Collection<Map<String, Object>>) - Static method in interface Matrix2D
- fromMap(ObjectMapper, Map<String, Object>) - Static method in class CustomerGroup
-
Creates CustomerGroup object from a Map object that represents CustomerGroup.
- fromMap(ObjectMapper, Map<String, Object>) - Static method in class ProductGroup
-
Creates ProductGroup object from a Map object that represents ProductGroup.
- fromMap(ObjectMapper, Map<String, Object>) - Static method in class SellerGroup
-
Creates SellerGroup object from a Map object that represents SellerGroup.
- 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
- fromMap(Map<String, Object>) - Static method in class CustomerGroup
-
Creates CustomerGroup object from a Map object that represents CustomerGroup.
Allows you, for example, to use this object in a Datamart query with usage of the "where" clause. - fromMap(Map<String, Object>) - Static method in class ProductGroup
-
Creates ProductGroup object from a Map object that represents ProductGroup.
Allows you, for example, to use this object in a Datamart query with usage of the "where" clause. - fromMap(Map<String, Object>) - Static method in class SellerGroup
-
Creates SellerGroup object from a Map object that represents SellerGroup.
Allows you, for example, to use this object in a Datamart query with usage of the "where" clause. - fromMap(Map<String, String>) - Static method in class TieredValue
- fromMap(Map<String, String>, TieredValueSortType, TieredValueValidationType) - Static method in class TieredValue
- fromParams(Map) - Method in class RATBuilder
- fromQueryBuilderState(Map<String, Object>) - Method in class AbstractChartBuilder
-
Configures a
DataTableChart
based on the output of theQueryBuilder
Dashboard input. - fromResultMatrix(ResultMatrix) - Static method in interface Matrix2D
- fromSimpleFilter(String, String) - Static method in class CustomerGroup
-
Returns CustomerGroup created from a simple fieldName and fieldValue filter.
- fromSimpleFilter(String, String) - Static method in class ProductGroup
-
Returns ProducGroup created from a simple fieldName and fieldValue filter.
- fromSimpleFilter(String, String) - Static method in class SellerGroup
-
Returns SellerGroup created from a simple fieldName and fieldValue filter.
- fromStep(String) - Method in class ModelCalculationAction
-
Sets the calculation range of steps of the specified model, beginning with the specified step (included).
- FUNCTION - Enum constant in enum class AggregationFormula
G
- GAUGE - Enum constant in enum class CalculationResultType
- generateQuerySQL(PersistedObjectService, String, String, T) - Method in class ItemSummaryQuery
- get() - Method in interface IRebateRecordManager
-
Get the RR/COR with the default name linked to the current RA/CO.lineitem
- 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. - get(int) - Method in class TieredValue
- get(Object) - Static method in enum class DataType
- get(String) - Static method in enum class FieldFormatType
- get(String) - Static method in enum class CalendarUtil.TimeUnit
- get(String) - Static method in enum class LookupTable.LookupTableType
- get(String) - Static method in enum class LookupTable.LookupTableValueType
- get(String) - Method in interface IRebateRecordManager
-
Get the RR/COR with the given name linked to the current RA/CO.lineitem
- get(String) - Method in interface RContext
-
Retreives a value from R
- get(String, String) - Method in interface IRebateRecordManager
-
In the given RR/COR-set, get the RR/COR with the given name linked to the current RA/CO.lineitem
- get(String, String) - Method in interface PayoutRecordManager
-
Retrieves the existing payout or accrual record with the given type and name, linked to the current RebateRecord/CompensationRecord.
- get(String, CalendarUtil.TimeUnit) - Static method in enum class CalendarUtil.TimeUnit
- getAccumCount(double) - Method in class AdaptiveHistogram
-
Returns the cumulative density function for a given data point.
- getAction() - Method in class ModelCalculationAction
- getAction() - Method in interface ModelSchedulesContextReadOnly.ModelSchedule
- getActions() - Method in class CalculationFlowActionBuilder
- getAdditionalConfig() - Method in class ConfiguratorEntry
-
Gets the Map of additional configurations
- getAdditionalInfo1() - Method in class CustomerAssignment
- getAdditionalInfo1() - Method in class User
- getAdditionalInfo1() - Method in class UserGroup
- getAdditionalInfo2() - Method in class CustomerAssignment
- getAdditionalInfo2() - Method in class User
- getAdditionalInfo2() - Method in class UserGroup
- getAdditionalInfo3() - Method in class CustomerAssignment
- getAdditionalInfo3() - Method in class User
- getAdditionalInfo3() - Method in class UserGroup
- getAdditionalInfo4() - Method in class CustomerAssignment
- getAdditionalInfo4() - Method in class User
- getAdditionalInfo4() - Method in class UserGroup
- getAddUnknownValues() - Method in class ContextParameter
- getAgentOption1(PersistedObjectService, JobStatusTracker, int) - Method in class PriceGrid
- getAgentOption1(PersistedObjectService, JobStatusTracker, int) - Method in class Pricelist
- getAggregation() - Method in class WaterfallChart.WaterfallSeries
- getAggregation() - Method in class WaterfallComparisonChart.WaterfallComparisonSeries
- getAggregationMode() - Method in class ItemSummaryQuery.Projection
- getAggregationStrategy() - Method in interface ResultMatrix
- getAggregationStrategy() - Method in class ResultMatrix
-
Deprecated.
- getAll() - Method in interface IRebateRecordManager
-
Get all RR/CORs linked to the current agreement (via RR/COR --> RLI/COLO --> RBA/CO).
- getAll(String) - Method in interface IRebateRecordManager
-
Get all RR/CORs linked to the line item with the given lineID in the current agreement (via RR/COR --> RLI/COLI).
- getAllFields() - Method in interface DatamartRowSet
-
Provides the list of all the fields.
- getAllGroups() - Method in class User
-
Gets all groups of a user including those assigned by a business role
- getAllItemsFilter(T) - Method in class ItemSummaryQuery
- getAllocationFields() - Method in interface DistFormulaContext
-
Proxy for DL.calculationConfig.allocationFields, specifying the fields that are going to be updated, including the aggregation expressions that define the allocation math.
- getAllRoleNames() - Method in class User
-
THIS SHOULD NOT BE USED IN CODE!.
- getAllRoles() - Method in class User
-
Gets all roles of a user including those assigned by a business role
- getAlreadySatisfiedComment() - Method in class WorkflowDTO.StepDTO
- getAlwaysEditable() - Method in class ContextParameter
- getApprovalDate() - Method in class Pricelist
- getApprovalDate() - Method in class SummaryCalculableObjectItem
- getApprovalDatePartitionDefaultTZ() - Method in class WorkflowInfo.WorkflowStepInfo
-
Date of approval, partition default timezone
- getApprovalRequiredEmailAttachments() - Method in class WorkflowDTO.ApprovalStepDTO
- getApprovalRequiredEmailAttachments() - Method in class Pricelist
- getApprovalState() - Method in class PriceGrid
- getApprovalState() - Method in class Pricelist
- getApprovalState() - Method in class SummaryCalculableObjectItem
- getApprovedByName() - Method in class AttachedDocument
- getApprovedByName() - Method in class Pricelist
- 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)
- getAssignment() - Method in class CustomerAssignment
- getAssignmentId() - Method in class CustomerAssignment
- getAssignmentType() - Method in class CustomerAssignment
- getAsyncHttpCallResult(Future<Object>, boolean) - Method in interface PublicGroovyAPI
-
Helper method for api.asyncHttpCall() which is design to collect the result.
- getAttachments() - Method in interface ModelFormulaContext
- getAttribute(String) - Method in class AttributedResult
- getAttributeMetaMapPrefix() - Method in class Customer
- 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
- getBandByOptions() - Method in class ChartSeries.Aggregation
- getBaseCO() - Method in class Simulation
- getBaseCOType() - Method in class Simulation
- getBasePriceGridId() - Method in class Simulation
- getBasePricelistId() - Method in class Simulation
- getBaseTemplateToUse() - Method in class ResultFlexChart
- getBaseURL() - Method in interface PublicGroovyAPI
-
Returns the base URL component of the current instance.
- getBatchInfo() - Method in interface PublicGroovyAPI
-
Retrieves the information about the current batch of items being calculated by a calculation 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.
- getBusinessKey() - Method in class Customer
- getBusinessRoles() - Method in class User
- getCalcItem() - Method in interface DistFormulaContext
-
In a distributed calculation step, this method retrieves the item to be calculated.
- 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 a CalculableLineItemCollection (CLIC) object e.g., a Quote, Rebate Agreement, Contract, or Sales Compensations.
- getCalculableLineItemCollection(String, Filter) - Method in interface PublicGroovyAPI
-
Retrieves all CalculableLineItemCollections (CLIC) objects that match the filter's and type code's criteria.
- 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 ModelCalculationAction
- getCalculate() - Method in class PricelistAction
- getCalculate() - Method in class RebateRecordAction
- getCalculate() - Method in class SimulationAction
- getCalculatedBaseTypedId() - Method in class Simulation
- getCalculatedFieldSetConfiguration() - Method in class CalculatedFieldSet
- getCalculationConcurrencyKey() - Method in class CalculatedFieldSet
- 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 PriceOptimizer 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"
Example: - getCalculationStep() - Method in interface ModelFormulaContext
-
A ModelType definition, optionally (but usually) defines a number of calculation steps.
- getCcyField() - Method in class DMField
- getCfsLabel() - Method in class CFSAction
- getChildren() - Method in class LineItemHelper.LineItem
-
Provides list of all children of this folder.
- getClaimContext() - Method in interface PublicGroovyAPI
-
Gives the current item context in a claim validation.
- getClassByName(String, BiFunction<MetaAttributed, String, AttributeMeta>) - Method in class Customer
- getClientSideDistinctName() - Method in class ItemSummaryQuery.Projection
-
Client side distinct name.
- getColumn(int) - Method in interface DatamartContext.Table
- getColumn(int) - Method in class Table
- getColumn(String) - Method in interface DatamartContext.Table
-
Convenience method for retrieving a column by its name.
- getColumn(String) - Method in interface Matrix2D
- getColumn(String) - Method in class Table
- getColumnByLabel(String) - Method in interface DatamartContext.Table
-
Convenience method for retrieving a column by its label.
- getColumnByLabel(String) - Method in class Table
- getColumnCount() - Method in interface Matrix2D
- getColumnDataType(String) - Method in interface Matrix2D
- getColumnFormats() - Method in interface ResultMatrix
-
Gets individual column formats (if specified)
- getColumnFormats() - Method in class ResultMatrix
-
Deprecated.
- getColumnLabel(long) - Method in interface Matrix2D
- getColumnLabels() - Method in interface Matrix2D
- getColumnNumber() - Method in interface DatamartContext.Column
- getColumns() - Method in interface ResultMatrix
-
Gets a list of defined columns
- getColumns() - Method in class ResultMatrix
-
Deprecated.
- getColumns(Collection<String>) - Method in interface Matrix2D
- getColumnTooltips() - Method in interface ResultMatrix
-
Gets the currently assigned column tooltips
- getColumnTooltips() - Method in class ResultMatrix
-
Deprecated.
- getColumnTranslations() - Method in interface ResultMatrix
-
Gets current column translations in raw format
- getColumnTranslations() - Method in class ResultMatrix
-
Deprecated.
- getColumnValues(long) - Method in interface Matrix2D
- getCombinedParameters(String) - Method in class ChainedJobInfo
- getComments() - Method in class SummaryCalculableObjectItem
- getCompensationView() - Method in class CompensationBuilder
-
Gets the full compensation object as a nested map.
- getConditionRecordLogicName() - Method in class WorkflowDTO.ApprovalStepDTO
- getConfiguration() - Method in class CalculatedFieldSet
- getConfiguration() - Method in class PriceGrid
- getConfiguration() - Method in class Pricelist
- getContractTermTypeUN() - Method in class LineItemHelper.LineItem
- getContractView() - Method in class ContractBuilder
-
Gets the full Contract object as a nested map.
- getConversionRateFieldName(String, String) - Static method in class DMField
- getCopyValuesNamedQuery() - Method in class LookupTable
- 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.
- getCreatedByName() - Method in class AttachedDocument
- getCreatedByName() - Method in class CustomerAssignment
- getCreatedByName() - Method in class LookupTable
- getCreatedByName() - Method in class ManualPricelist
- getCreatedByName() - Method in class PriceGrid
- getCreatedByName() - Method in class Pricelist
- 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.
- getCurrentRow() - Method in interface DatamartRowSet
-
Returns the current row.
- getCustomerFieldLabel() - Method in class CustomerGroup
-
Returns the customer field label when an item (not a filter statement) from the customer group picker is selected.
- getCustomerFieldName() - Method in class CustomerGroup
-
Returns the customer field name when an item (not a filter statement) from the customer group picker is selected.
- getCustomerFieldValue() - Method in class CustomerGroup
-
Returns the customer field value when an item (not a filter statement) from the customer group picker is selected.
- getCustomerFilterCriteria() - Method in class CustomerGroup
-
Returns a filter criteria as a map of filters by a criteria selected from the customer group picker.
- getCustomerFilterCriteria() - Method in class User
- getCustomerFilterCriteriaJson() - Method in class CustomerGroup
-
Returns a filter as JSON by a criteria selected from the customer group picker.
- getCustomerFilterCriteriaMap() - Method in class User
- getCustomerGroup() - Method in class CustomerAssignment
- getCustomerid() - Method in class Customer
-
Needed to get attribute by name in formulas
- getCustomerId() - Method in class Customer
- getCustomerIdsFromCustomerGroup(CustomerGroup) - Method in interface PublicGroovyAPI
-
Returns a list of Customer IDs based on the definition of the customer group.
Note: If the CustomerGroup input map is received from Ember (the former frontend version) then it must be converted to theCustomerGroup
object using thefromMap()
method before it can be used as a parameter forgetCustomerIdsFromCustomerGroup()
.
This conversion is not needed when there is a React version of the frontend in use.
Example (fromMap()
employed for conversion to the CustomerGroup object): - getData() - Method in interface DatamartQueryResult
-
Retreives the query result data. .
- getDataContext() - Method in class TableContext
- getDataFeed(String) - Method in interface DatamartContext
-
Gets a table object representing a DataFeed with the given name.
- getDataLoader() - Method in interface DistCalcFormulaContext
-
Provides access to the DataLoader instance that allows adding rows to the Result table linked to the DL.
- getDataLoader() - Method in interface ModelCalcFormulaContext
- getDataLoadLabel() - Method in class DataLoadAction
- getDataLoadType() - Method in class DataLoadAction
- getDataMap() - Method in class WorkflowDTO
- getDatamart(String) - Method in interface DatamartContext
-
Gets a table object representing a Datamart with the given name.
- getDatamart(String, Boolean) - Method in interface DatamartContext
-
Gets a table object representing a Datamart with the given name, using either it's refresh or published data, depending on the value of the useRefreshData argument.
- getDatamartContext() - Method in interface PublicGroovyAPI
-
Provides an API for querying and loading PA data.
- getDatamartRowSet() - Method in interface PublicGroovyAPI
-
A
DatamartRowSet
provides access to the rows being loaded or calculated. - getDatamartRowSet(String) - Method in interface PublicGroovyAPI
-
A
DatamartRowSet
provides access to the rows currently being loaded or calculated. - getDataSource(String) - Method in interface DatamartContext
-
Gets a table object representing a DataSource with the given name.
- getDataType() - Method in class DMField
- getDateDimFieldName() - Method in class DMCalendar.TimeDim
- getDateFieldName() - Method in class DMDataSlice
- getDateTimeFormat() - Method in class ScheduleSettings
- getDay(Date) - Method in class CalendarUtil
- getDaysDiff(String, String) - Method in class CalendarUtil
- 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).
- getDbColumn() - Method in class DMField
- getDbTable() - Method in class DMField
- getDef() - Method in interface ModelFormulaContext
-
A typical (set of) PO logic(s) covers various stages: definition, calculation, analysis, record and evaluation.
- getDefault(PersistedObjectService) - Static method in class RebateRecordSet
- getDefaultConditionRecordLogicName() - Method in class WorkflowDTO
- getDefaultDataLoad(PersistedObjectService) - Method in class DMTable
- getDefaultFormat() - Method in interface ResultMatrix
-
Gets the default format
- getDefaultFormat() - Method in class ResultMatrix
-
Deprecated.
- getDefaultPostApprovalStepLogicName() - Method in class WorkflowDTO
- getDefaults() - Method in interface ModelFormulaContext
-
When a clients retrieves the required input parameters for a given stage (definition, calculation step, analysis...), there is the option to set an initial value for a parameter.
- getDefaultSchema() - Method in class TableContext
- getDefaultTrackerType() - Method in class CalculatedFieldSet
- getDefaultTrackerType() - Method in class PriceGrid
- getDefaultTrackerType() - Method in class Pricelist
- getDefaultTrackerType() - Method in class RebateRecordSet
- getDefaultTrackerType() - Method in class Simulation
- getDefaultUserGroupEdit() - Method in class User
- getDefaultUserGroupViewDetails() - Method in class User
- getDefaultValue() - Method in class DMField
- getDefaultValue(String) - Method in class ConfiguratorEntry
-
Retrieves the default value of a specific tracked input (i.e., created using the
InputBuilderFactory
and tracked for default value withAbstractInputBuilder.setDefaultValueTracking(boolean)
enabled. - getDenialReasons() - Method in class WorkflowDTO.ApprovalStepDTO
-
Returns all denial reasons defined for this approval step
- getDenialReasons() - Method in class WorkflowDTO
- getDeniedByName() - Method in class AttachedDocument
- getDeniedByName() - Method in class Pricelist
- getDependencies() - Method in class DMField
- getDependenciesAsList() - Method in class DMField
- getDescription() - Method in class PriceGrid
- getDescription() - Method in class Pricelist
- getDictionary() - Method in class AbstractChartBuilder
- getDimensions() - Method in interface DatamartContext.DataProfilerResult
- getDimFieldName() - Method in class DMCalendar.TimeDim
- 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
- getDocTypedId() - Method in class AttachedDocument.CompositeKey
- getDocTypedId() - Method in class AttachedDocument
- getDocumentType() - Method in class AttachedDocument
- getDomainFilter() - Method in class CustomerGroup
- getDomainFilter() - Method in class ProductGroup
- getDomainFilter() - Method in class SellerGroup
- getDomainObjectType() - Method in class CustomerGroup
- getDomainObjectType() - Method in class ProductGroup
- getDomainObjectType() - Method in class SellerGroup
- getDomainTableName() - Method in class CustomerGroup
- getDomainTableName() - Method in class ProductGroup
- getDomainTableName() - Method in class SellerGroup
- getEffectiveTargetDate(PersistedObjectService) - Method in class PriceGrid
- getElement(String) - Method in interface PublicGroovyAPI
-
Deprecated.This function is deprecated and has been replaced with the Groovy binding variable
out
. Useout.<ElementName>
(oroutput.<ElementName>
) instead. - getEmail() - Method in class User
- 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
- getEmailLocale() - Method in class User
- getEndDate() - Method in class CalendarUtil.TimePeriod
- getEndDate(String) - Method in class CalendarUtil
- getEndDate(String) - Method in interface DatamartContext.Calendar
-
Returns the end date of a given TimePeriod.
- getEndPeriod() - Method in class CalendarUtil.TimePeriod
- getEngineContext() - Method in class InputBuilderContext
- getEntity() - Method in class DMField
- getEntries() - Method in interface ResultMatrix
-
Returns the current list entries as a list (=the rows) of maps (= the row content)
- getEntries() - Method in class ConfiguratorEntryArray
- getEntries() - Method in class ResultMatrix
-
Deprecated.
- getErrorMessagesAsMap() - Method in class DMField
- getErrorMode() - Method in class Pricelist
- getEvents() - Method in class ResultHighchart
-
Not intended for public use, required for JSON serialization.
- 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
- getExecutionStatusI18n() - Method in class WorkflowInfo.WorkflowStepInfo
- getExistAsTmpOnly() - Method in class QuoteLineItem
- getExpandedGroups() - Method in interface ResultMatrix
- getExpandedGroups() - Method in class ResultMatrix
-
Deprecated.
- getExpiryDate() - Method in class ManualPricelist
- getExpiryDate() - Method in class Pricelist
- getExpiryDate() - Method in class SummaryCalculableObjectItem
- getExplicitNames() - Method in class Customer
- getExportDate() - Method in class Pricelist
- getExpression() - Method in class DMField
- getExtendedData() - Method in class User
- getField() - Method in class Column
- getFieldCollection() - Method in class Table
- 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
- getFields() - Method in interface ModelFormulaContext
-
Retrieves the field definitions previously added using
ModelFormulaContext.addField(Object)
. - getFilter() - Method in class ObjRefAction
- getFilter() - Method in class ContextParameter
- getFilterCriteriaForObjectExtension(String) - Method in class User
- getFilterNode() - Method in interface ModelFormulaContext
-
In the context of a call to the
datamart.modeleval
end point (JSON API), the client request can specify the 'filterNodeId' parameter. - getFilterNodePath() - Method in interface ModelFormulaContext
-
Like
ModelFormulaContext.getFilterNodePath(Long)
, but for the preset FilterNode revealed byModelFormulaContext.getFilterNode()
only. - getFilterNodePath(Long) - Method in interface ModelFormulaContext
-
Given the id of a FilterNode, in some tree previously added to the model, this method returns the logical path from the root to that node.
- getFilters() - Method in class AbstractChartSeries
- getFirstInput() - Method in class ConfiguratorEntry
-
Gets the first context parameter.
- getFirstName() - Method in class User
- getFlattedInputs(List<Map<String, Object>>) - Static method in class LineItemHelper
- getFlexChart() - Method in class ResultFlexChart
- getFormat() - Method in class DMField
- getFormattingOptions() - Method in class ContextParameter
- getFormatType() - Method in class LookupTable
- getFormulaElement() - Method in class DMField
- getFormulaParameters() - Method in class LivePriceGridAction
- getFQLoginName() - Method in class User
- getFromStep() - Method in class ModelCalculationAction
- getFrozenColumns() - Method in interface ResultMatrix
-
Retrieves a list containing the names of columns that are currently set as frozen.
- getFrozenColumns() - Method in class ResultMatrix
-
Deprecated.
- getFunction() - Method in class DMField
- getFunctionalType() - Method in class DMField
- getGlobal() - Method in interface PublicGroovyAPI
-
A publicly available cache (as a hashmap) for storing and sharing values across logic elements.
- getGroupBy() - Method in interface ResultMatrix
- getGroupBy() - Method in class ResultMatrix
-
Deprecated.
- getGroupByColumnLabel() - Method in interface ResultMatrix
-
Retrieves the custom label for the Group column.
- getGroupByColumnLabel() - Method in class ResultMatrix
-
Deprecated.
- getGroupByData() - Method in interface ResultMatrix
- getGroupByData() - Method in class ResultMatrix
-
Deprecated.
- getGroups() - Method in class User
- getHasCriticalAlert() - Method in class Pricelist
- getHashMethod() - Method in class User
- getHeaderClass() - Method in class ContractLineItem
- getHeaderClass() - Method in class QuoteLineItem
- getHeaderClass() - Method in class RebateAgreementLineItem
- getHeaderTypeUniqueName() - Method in class PriceGrid
- getHelper() - Method in class CompensationBuilder
-
Gets a helper class that assists in manipulating the compensation object.
- getHelper() - Method in class ContractBuilder
-
Gets a helper class that assists in manipulating the Contract object.
- getHelper() - Method in class CustomFormCollectionBuilder
-
Gets a helper class that assists in manipulating the custom form
- getHelper() - Method in class QuoteBuilder
-
Gets a helper class that assists in manipulating the quote object.
- getHelper() - Method in class RebateAgreementBuilder
-
Gets a helper class that assists in manipulating the Rebate Agreement object.
- getHiddenActions() - Method in class ConfiguratorEntry
-
Retrieves a list of hidden pop-up Configurator buttons.
- getHideWarnings() - Method in class LookupTable
- getId() - Method in class AttachedDocument.CompositeKey
- getId() - Method in class ItemRecommendation
- getId(Object) - Method in interface PublicGroovyAPI
-
Returns the ID part of an object.
- getIgnoreSecKeyFiltering() - Method in class Simulation
- getIgnoreTargetDate() - Method in class LivePriceGridAction
- getIncLoadDate() - Method in interface DistFormulaContext
-
Proxy for DL.incLoadDate.
- getInput() - Method in interface ModelFormulaContext
-
Exposes all the input values passed in with a ModelEval request (user entries), or all of the inputs persisted in the model, when in a calculation.
- getInput() - Method in class AbstractInputBuilder
-
Builds the input field definition (
ContextParameter
) - the object representation of the input field. - getInputByName(String) - Method in class LineItemHelper.LineItem
- getInputByName(String) - Method in class ConfiguratorEntry
-
Get
ContextParameter
by provided name - getInputs() - Method in class LineItemHelper.LineItem
- getInputs() - Method in class ConfiguratorEntry
-
Gets the list of context parameters.
- getInputs() - Method in class ContextParameter
- getInputType() - Method in class ContextParameter
- getIntegrationStatus() - Method in class ManualPricelist
- getIntegrationStatus() - Method in class PriceGrid
- getIntegrationStatus() - Method in class Pricelist
- getInternalExpr() - Method in class DMField
- getIstanceId() - Method in class RATBuilder.RABuilder
- getItemActiveCalculationResults(String) - Method in interface PublicGroovyAPI
-
Gets the current complete active (i.e. approved) calculation results of the given item.
- getItemAttributeMetaClass() - Method in class CalculatedFieldSet
- getItemAttributeMetaClass() - Method in class PriceGrid
- getItemAttributeMetaClass() - Method in class Pricelist
- getItemAttributeMetaClass() - Method in class RebateRecordSet
- getItemAttributeMetaClass() - Method in class Simulation
- getItemClass() - Method in class CalculatedFieldSet
- getItemClass() - Method in class PriceGrid
- getItemClass() - Method in class Pricelist
- getItemClass() - Method in class RebateRecordSet
- getItemClass() - Method in class Simulation
- getItemClassS(MatrixableCalculableObject.ListType) - Static method in class PriceGrid
- getItemClassS(MatrixableCalculableObject.ListType) - Static method in class Pricelist
- getItemClassS(MatrixableCalculableObject.ListType) - Static method in class Simulation
- 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
- getItemListFilterField() - Method in class CalculatedFieldSet
- getItemListFilterField() - Method in class ManualPricelist
- getItemListFilterField() - Method in class PriceGrid
- getItemListFilterField() - Method in class Pricelist
- getItemListFilterField() - Method in class RebateRecordSet
- getItemListFilterField() - Method in class Simulation
- getItemListFilterFieldS() - Static method in class ManualPricelist
- getItemListFilterFieldS() - Static method in class PriceGrid
- getItemListFilterFieldS() - Static method in class Pricelist
- getItemListFilterFieldS() - Static method in class RebateRecordSet
- getItemListFilterFieldS() - Static method in class Simulation
- 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 in which this list has been calculated during this cycle.
- getJobName() - Method in class ExportAction
- getJobType() - Method in class CalculatedFieldSet
- getJobType() - Method in class PriceGrid
- getJobType() - Method in class Pricelist
- getJobType() - Method in class Simulation
- getJsonLookupTableClass() - Method in class LookupTable
- getJsonLookupTableMeta(LookupTable, PersistedObjectService) - Static method in class LookupTable
- getJstId() - Method in class Pricelist
- getKey2() - Method in class SummaryCalculableObjectItem
- getKeyFields() - Method in interface DatamartRowSet
-
Provides the list of the key fields.
- getKV(String, Map<String, Object>) - Method in interface PublicGroovyAPI
-
Retrieves a single value ('payload') based on the primary key match.
- getLabel() - Method in class LineItemHelper.LineItem
- getLabel() - Method in class CreationWorkflowStepDefinition
-
Retrieves the label of the Creation Workflow step (the
CreationWorkflowStepDefinition
object). - getLabel() - Method in class AttachedDocument
- getLabel() - Method in class CustomerGroup
-
Returns the customer field label when an item (not a filter statement) from the customer group picker is selected.
- getLabel() - Method in class DMField
-
For a translated object, the legacy "label" field may serve as a non-translated technical label.
- getLabel() - Method in class ProductGroup
-
Returns the product field label when an item (not a filter statement) from the product group picker is selected.
- getLabel() - Method in class SellerGroup
-
Returns the seller field label when an item (not a filter statement) from the seller group picker is selected.
- getLabel() - Method in interface DatamartContext.Column
- getLabel() - Method in interface ModelFormulaContext
- getLabel() - Method in class ContextParameter
- getLabel() - Method in class ProductReferenceRecord
- getLabelsFromQueryBuilder(Map<String, Object>, String) - Method in interface DatamartContext
-
Convenience method to get the labels defined in a
Query Builder
input. - getLabelTranslations() - Method in class DMField
-
A Map, with locale (String) as key and translated label (String) as value.
- getLabelTranslations() - Method in class ContextParameter
- getLastLogin() - Method in class User
- getLastName() - Method in class User
- getLastTermsOfUseAgreedDate() - Method in class User
- getLastTermsOfUseVersionAgreed() - Method in class User
- getLastUpdateByName() - Method in class AttachedDocument
- getLastUpdateByName() - Method in class CustomerAssignment
- getLastUpdateByName() - Method in class LookupTable
- getLastUpdateByName() - Method in class ManualPricelist
- getLastUpdateByName() - Method in class PriceGrid
- getLastUpdateByName() - Method in class Pricelist
- getLastValueChangedByLogic(String) - Method in class ConfiguratorEntry
-
Retrieves the last value of a specified
ContextParameter
that was changed by Groovy logic, together with the timestamp of when the change occurred.
If tracking is not enabled or the specified input does not exist within the givenConfiguratorEntry
, anConfiguratorEntryException.ChangeByLogicNotTrackedException
will be thrown. - getLineId() - Method in class LineItemHelper.LineItem
- getLineItemTypedId() - Method in interface ClaimContext
-
Get line item typed id in Allocation Formula only
- getLinkedCFStypedId() - Method in class ManualPricelist
- getListId() - Method in class ProductReferenceRecord
- getListId() - Method in class SummaryCalculableObjectItem
- getListLabel() - Method in class ProductReferenceRecord
- getListLabel() - Method in class SummaryCalculableObjectItem
- getListType() - Method in class PriceGrid
- getListType() - Method in class Pricelist
- getListType() - Method in class Simulation
- getLivePriceGridLabel() - Method in class LivePriceGridAction
- getLoadMode() - Method in interface DistFormulaContext
-
Proxy for DL.loadMode, specifying how the result data is going to be uploaded to the target.
- getLocale() - Method in interface PublicGroovyAPI
-
Returns the language part of the current request's locale (e.g.
- getLogger() - Method in class RebateAgreementLineItem
- getLoginName() - Method in class User
- getLookupTableId() - Method in class LookupTable
- getLookupTableId() - Method in class ContextParameter
- getLookupValueFieldName(int) - Method in class LookupTable
- getMandatoryComments() - Method in class WorkflowDTO.ApprovalStepDTO
-
Returns mandatory comments for this approval step
- 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
- getManualResultPrice() - Method in class SummaryCalculableObjectItem
- getMap() - Method in interface DatamartContext.DataProfilerResult
-
All the results in a 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.
- getMatrixLookupTableClass() - Method in class LookupTable
- getMatrixLookupTableMeta(LookupTable, PersistedObjectService) - Static method in class LookupTable
- 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
- getMeasureType() - Method in class DMField
- getMessage() - Method in class ConfiguratorEntry
-
Gets the message.
- getMessages() - Method in class DMField
- getMin() - Method in class ResultGauge
-
The minimum dial value.
- getMinApprovalsForGroups() - Method in class WorkflowDTO.ApprovalStepDTO
-
Returns the minimum number of approvers needed for each user group in this step.
- getMinApprovalsNeeded() - Method in class WorkflowDTO.ApprovalStepDTO
-
Returns the minimum number of approvers needed for this approval step
- getModel(String) - Method in interface DatamartContext
-
Gets a table object representing a Model with the given name.
- getModelUniqueName() - Method in class ModelCalculationAction
- getMonth(Date) - Method in class CalendarUtil
- getName() - Method in enum class FilterOperator
- getName() - Method in enum class CalendarUtil.TimeUnit
- getName() - Method in class Customer
- getName() - Method in class DMField
- getName() - Method in interface DatamartContext.Column
- getName() - Method in interface ModelSchedulesContextReadOnly.ModelSchedule
-
The name of the model schedule.
- getName() - Method in class ContextParameter
- getNewNumberOfTimeUnits() - Method in class ScheduleSettings
-
Gets newly set number of time units.
- getNewRecordsMaxLimits() - Method in class ActionItemApi
-
Returns configured limits for newly created action items.
- 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
- getNextJobs() - Method in class CFSAction
- getNextJobs() - Method in class DataLoadAction
- getNextJobs() - Method in class LivePriceGridAction
- getNextJobs() - Method in class PricelistAction
- getNextJobs() - Method in class SimulationAction
- getNextJobs() - Method in class ChainedJobInfo
- getNodeId() - Method in class LookupTable
- getNodeId() - Method in class ManualPricelist
- getNodeId() - Method in class PriceGrid
- getNodeId() - Method in class Pricelist
- getNoSession() - Method in class User
- getNotificationOnlyToUsers() - Method in class WorkflowDTO.ApprovalStepDTO
-
Returns the subset of approvers that should recieve email notification.
- getNumberOfApprovedItems() - Method in class PriceGrid
- getNumberOfAutoApprovedItems() - Method in class PriceGrid
- getNumberOfDeniedItems() - Method in class PriceGrid
- getNumberOfFailedItems() - Method in class CalculatedFieldSet
- getNumberOfKeyFields() - Method in class LookupTable
- getNumberOfOpenItems() - Method in class PriceGrid
- getNumberOfProjections() - Method in class ItemSummaryQuery
- getNumberOfSubmittedItems() - Method in class PriceGrid
- 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 ModelCalculationAction
- getObjectName() - Method in class ObjRefAction
- getObjectName() - Method in class PricelistAction
- getObjectName() - Method in class RebateRecordAction
- getObjectName() - Method in class ScheduleSettings
- getObjectName() - Method in class SimulationAction
- getObjectService() - Method in class ContextParameter
- getObjectTypedIds() - Method in class ItemSummaryQuery
- getOperator() - Method in class Filter
- getOptions() - Method in class AbstractChartBuilder
- 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
- getOrCreate(String, PersistedObjectService) - Static method in class RebateRecordSet
- getOrCreateFilterFormula() - Method in class AbstractProductAndCustomerInputBuilder
- getOutputByName(String) - Method in class LineItemHelper.LineItem
- getOutputs() - Method in class LineItemHelper.LineItem
- getOwner() - Method in class DMTable
- getOwner() - Method in class LookupTable
- getOwningFC() - Method in class DMField
- getParameter(String) - Method in interface PublicGroovyAPI
-
Retrieves an already generated (in the previous logic code) input parameter in the form of a
ContextParameter
object. - getParameterConfig() - Method in class ContextParameter
- getParameterGroup() - Method in class ContextParameter
- getParameters() - Method in class ChainedJobInfo
- getParams() - Method in class ModelEvaluator
-
Equivalent to
ModelFormulaContext.getParams()
. - getParams() - Method in interface ModelFormulaContext
-
Gets all the entries of the LookupTable (PP) named 'Model Params <model.uniqueName>'.
- getParent() - Method in class LineItemHelper.LineItem
- getParentId() - Method in class Customer
- getParentTypedId() - Method in class Pricelist
- getPartialCalculationDate() - Method in class PriceGrid
- getPartition() - Method in class ObjRefAction
- getPasswordExpiry() - Method in class User
- getPasswordHash() - Method in class User
- getPasswordSalt() - Method in class User
- getPercentileValue(long, int) - Method in interface Matrix2D
-
Calculates the value at the given percentile in the given numeric column.
- getPeriod() - Method in interface ModelSchedulesContextReadOnly.ModelSchedule
- getPermissions() - Method in class User
- getPlatformManaged() - Method in class User
- getPostStepLogicName() - Method in class WorkflowDTO.ApprovalStepDTO
- getPreferenceName() - Method in interface ResultMatrix
-
Gets the preference name
- getPreferenceName() - Method in class ContextParameter
- getPreferenceName() - Method in class ResultMatrix
-
Deprecated.
- getPrefix() - Method in class ResultGauge
-
The label prefix.
- getPreviousPrice() - Method in class SummaryCalculableObjectItem
- getPreviousPricelistId() - Method in class Pricelist
- getPreviousValue(String) - Method in class ConfiguratorEntry
-
Retrieves the previous value of a specific tracked input (i.e., created using the
InputBuilderFactory
and tracked for previous value withAbstractInputBuilder.setPreviousValueTracking(boolean)
} enabled. - getPriceChange() - Method in class SummaryCalculableObjectItem
- getPriceChangePct() - Method in class SummaryCalculableObjectItem
- getPriceGridConfiguration() - Method in class PriceGrid
- getPriceGridId() - Method in class PriceGrid
- getPriceGridSummaryQuery() - Method in interface PublicGroovyAPI
-
Creates a summary query object that can be parameterized and is then subsequently used in
PublicGroovyAPI.runSummaryQuery(ItemSummaryQuery)
. - getPriceGridType() - Method in class PriceGrid
- getPricelistConfiguration() - Method in class Pricelist
- getPricelistId() - Method in class Pricelist
- getPricelistItem(String) - Method in interface PublicGroovyAPI
-
Similar to the
PublicGroovyAPI.pricelistItem(String)
function. - getPricelistName() - Method in class PricelistAction
- getPricelistPricegridTypeUniqueName() - Method in class Pricelist
- getPricelistSummaryQuery() - Method in interface PublicGroovyAPI
-
Creates a summary query object that can be parameterized and is then subsequently used in
PublicGroovyAPI.runSummaryQuery(ItemSummaryQuery)
. - getPricelistType() - Method in class Pricelist
- 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
- getPriority() - Method in class CustomerAssignment
- getProcessingMode() - Method in class Pricelist
- getProductFieldLabel() - Method in class ProductGroup
-
Returns the product field label when an item (not a filter statement) from the product group picker is selected.
- getProductFieldName() - Method in class ProductGroup
-
Returns the product field name when an item (not a filter statement) from the product group picker is selected.
- getProductFieldValue() - Method in class ProductGroup
-
Returns the product field value when an item (not a filter statement) from the product group picker is selected.
- getProductFilter() - Method in class ItemSummaryQuery
- getProductFilterCriteria() - Method in class ProductGroup
-
Returns a filter as JSON by a criteria selected from the product group picker.
- getProductFilterCriteria() - Method in class User
- getProductFilterCriteriaJson() - Method in class ProductGroup
-
Returns a filter as deserialized JSON by a criteria selected from the product group picker.
- getProductFilterCriteriaMap() - Method in class User
- getProductGroupBy() - Method in class ItemSummaryQuery
- getProductReferences(String, Set<String>) - Method in interface PublicGroovyAPI
-
Returns a list of product reference records showing 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
-
Provides an optimized way to get to certain object attributes.
- getPropertyByElementName(Object, String) - Method in interface PublicGroovyAPI
-
Gets object attributes by elementName.
- getQuarter(Date) - Method in class CalendarUtil
- getQuoteView() - Method in class QuoteBuilder
-
Gets the full quote object as a nested map.
- getRank() - Method in class DMField
- 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
-
Gets the full rebate agreement object as a nested map.
- getRebateRecordSetCalculationLabel() - Method in class RebateRecordAction
- getRebateRecordSetId() - Method in class RebateRecordSet
- getRebateRecordSummaryQuery() - Method in interface PublicGroovyAPI
-
Creates a summary query object that can be parameterized and is then subsequently used in
PublicGroovyAPI.runSummaryQuery(ItemSummaryQuery)
. - getRebateTypeUN() - Method in class LineItemHelper.LineItem
- getReceiveAdminEmail() - Method in class User
- getRecord() - Method in interface ModelCalcFormulaContext
-
Gets the ModelRecord ('PolicyRecord' in the UI) set as context in the 'record' logic evaluation (the logic set in the ModelType.recordLogic attribute).
- getRecord() - Method in interface ModelFormulaContext
-
Gets the ModelRecord ('PolicyRecord' in the UI) set as context in the 'record' logic evaluation (the logic set in the ModelType.recordLogic attribute).
- getRecordSetId() - Method in class RebateRecordSet
- getRelativeTargetDateDays() - Method in class CalculatedFieldSet
- getRelativeTargetDateDays() - Method in class PriceGrid
- getRequestedCurrentStep() - Method in class CreationWorkflowDefinition
- getRequireTFA() - Method in class User
- getRestrictToSkus() - Method in class LivePriceGridAction
- getResult() - Method in class AttributedResult
- getResult() - Method in class WrappedResult
- getResult(String) - Method in interface IRebateRecordManager
-
Get the formula element result for the RR/COR with the default name linked to the current RA/CO.lineitem
- getResult(String, String) - Method in interface IRebateRecordManager
-
Get the formula element result for the RR/COR with the given name linked to the current RA/CO.lineitem
- getResult(String, String, String) - Method in interface IRebateRecordManager
-
In the given RR/COR-set, get the formula element result for the RR/COR with the given name linked to the current RA/CO.lineitem
- getResultPrice() - Method in class SummaryCalculableObjectItem
- getResultTable() - Method in interface DistCalcFormulaContext
-
A Distributed Calculation stores the calculated rows in a table specific to the DL, and separate from the target table.
- getResultType() - Method in interface ResultMatrix
- getResultType() - Method in class ConfiguratorEntry
-
The CalculationResultType for this class.
- getResultType() - Method in class ConfiguratorEntryArray
- 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
- getRoleNames() - Method in class User
-
THIS SHOULD NOT BE USED IN CODE!.
- getRoles() - Method in class User
- getRollup(String) - Method in interface DatamartContext
-
Gets a table object representing a FieldCollection representing a rollup with the given label.
- getRoot() - Method in class LineItemHelper
- getRow() - Method in interface ClaimContext
-
Get parsed row from excel claim input.
- getRow(Map<String, Object>) - Method in interface DatamartRowSet
-
Get the row with the given key values.
- getRowCount() - Method in interface Matrix2D
- getRows() - Method in interface DatamartRowSet
- getRowValues(long) - Method in interface Matrix2D
- getRunDefaultPostApprovalStepLogicOnEmptyWorkflow() - Method in class WorkflowDTO
- getSandboxCallback() - Method in class InputBuilderContext
- getSanitizedProductGroupBy() - Method in class ItemSummaryQuery
- 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.
- getScore() - Method in class ItemRecommendation
- getSecondaryKey() - Method in interface PublicGroovyAPI
-
The same as
api.currentItem("key2")
. - getSectors() - Method in class ResultGauge
- getSellerFieldLabel() - Method in class SellerGroup
-
Returns the seller field label when an item (not a filter statement) from the seller group picker is selected.
- getSellerFieldName() - Method in class SellerGroup
-
Returns the seller field name when an item (not a filter statement) from the seller group picker is selected.
- getSellerFieldValue() - Method in class SellerGroup
-
Returns the seller field value when an item (not a filter statement) from the seller group picker is selected.
- getSellerFilterCriteria() - Method in class SellerGroup
-
Returns a filter as JSON by a criteria selected from the seller group picker.
- getSellerFilterCriteria() - Method in class User
- getSellerFilterCriteriaJson() - Method in class SellerGroup
-
Returns a filter as deserialized JSON by a criteria selected from the seller group picker.
- getSellerFilterCriteriaMap() - Method in class User
- 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).
- getShotgunThreshold(PersistedObjectService, JobStatusTracker) - Method in class CalculatedFieldSet
- getShotgunThreshold(PersistedObjectService, JobStatusTracker) - Method in class PriceGrid
- getShotgunThreshold(PersistedObjectService, JobStatusTracker) - Method in class Pricelist
- getShotgunThreshold(PersistedObjectService, JobStatusTracker) - Method in class Simulation
- getShouldSendNotification() - Method in class CreationWorkflowStepDefinition
-
Returns the value of the
shouldSendNotification
field. - getSiblings() - Method in class LineItemHelper.LineItem
- getSignificantFields() - Method in class Customer
- getSignificantFields() - Method in class User
- getSimulationLabel() - Method in class SimulationAction
- getSimulationSet() - Method in class ManualPricelistAction
- getSimulationSet() - Method in class Simulation
- 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 QuoteLineItem
- getSku() - Method in class ProductReferenceRecord
- getSku() - Method in class SummaryCalculableObjectItem
- getSKU() - Method in class LineItemHelper.LineItem
- getSkusFromProductGroup(ProductGroup) - Method in interface PublicGroovyAPI
-
Returns a list of SKUs based on the definition of the product group.
Note: If the ProductGroup input map is received from Ember (the former frontend version) then it must be converted to theProductGroup
object using thefromMap()
method before it can be used as a parameter forgetSkusFromProductGroup()
.
This conversion is not needed when there is a React version of the frontend in use.
Example (fromMap()
employed for conversion to the ProductGroup object): - getSource() - Method in class DMField
- getSourceField() - Method in class DMField
- getSourceName() - Method in class DMTable
- getSourceName() - Method in interface DatamartContext.Table
-
The underlying FC's source name.
- getSourceName() - Method in interface ModelFormulaContext
-
Returns the source name of this model, which is often needed as a parameter in queries, charts and such on the model in the analysis phase; and avoids retreiving the whole model with get().
- getSourceName() - Method in class Table
- getSourceQuery() - Method in interface ModelFormulaContext
- getSsoOnly() - Method in class User
- getStartDate() - Method in class CalendarUtil.TimePeriod
- getStartDate() - Method in interface ModelSchedulesContextReadOnly.ModelSchedule
- getStartDate(String) - Method in class CalendarUtil
- getStartDate(String) - Method in interface DatamartContext.Calendar
-
Returns the start date of a given TimePeriod.
- getStartingDate() - Method in class ScheduleSettings
-
Starting date and time of the associated formula
- getStartPeriod() - Method in class CalendarUtil.TimePeriod
- getStatus() - Method in class AttachedDocument
- getStep(String) - Method in class WorkflowDTO
-
Retrieves a workflow step with given name (if it exists)
- getSteps() - Method in class CreationWorkflowDefinition
-
Retrieves a list of all steps in the given workflow.
- getSteps() - Method in class InsertWorkflowStepsDTO
- getSteps() - Method in class WorkflowDTO
- getSubLineItems() - Method in class LineItemHelper.LineItem
- getSubmitDate() - Method in class Pricelist
- getSubmitReason() - Method in class WorkflowDTO
-
Gets reason entered by submitter
- getSubmittedByName() - Method in class AttachedDocument
- getSubmittedByName() - Method in class Pricelist
- getSuffix() - Method in class ResultGauge
- getSummary() - Method in interface DatamartQueryResult
-
Additional query summary information,
- getTable() - Method in interface DatamartContext.Column
- getTable() - Method in interface DatamartContext.Query
- getTable() - Method in class Column
- getTable(String) - Method in class ModelEvaluator
-
Equivalent to
ModelFormulaContext.getTable(String)
. - getTable(String) - Method in interface ModelFormulaContext
-
Gets a table object representing the DMTable with the given name, which was previously created using the
ModelCalcFormulaContext.addTable(String, Object)
method while calculating the model. - 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
- getTarget() - Method in interface DistFormulaContext
-
Proxy for DL.targetName, i.e. the name of the target for which data is being calculated.
- getTargetDate() - Method in class ManualPricelist
- getTargetDate() - Method in class SummaryCalculableObjectItem
- getTargetFields() - Method in interface DistFormulaContext
-
Proxy for DL.calculationConfig.targetFields, specifying the fields that are going to be updated (enriched) by this calculation.
- getTargetObject() - Method in class ChainedJobInfo
- 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
- getTierForTarget(BigDecimal) - Method in class TieredValue
- getTimeDimFieldName(DMField, CalendarUtil.TimeUnit) - Static method in class DMField
- getTimePeriod(String) - Method in class CalendarUtil
- getTimePeriod(String) - Method in interface DatamartContext.Calendar
-
Returns the TimePeriod object matching its string representation.
- getTimePeriodAsFilter(CalendarUtil.TimePeriod, String) - Method in class DMCalendar
- getTimePeriodByDate(String, String) - Method in class CalendarUtil
- 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.
- getTimePeriodName(Date, CalendarUtil.TimeUnit) - Method in class CalendarUtil
- getTimePeriodName(CalendarUtil.TimePeriod) - Method in class CalendarUtil
- getTimePeriodNames(String, String, String) - Method in class CalendarUtil
- getTimePeriodNames(String, String, String) - Method in interface DatamartContext.Calendar
-
Useful for constructing Options lists (user entry / input parameters).
- getTimePeriods(String, String, String) - Method in class CalendarUtil
- getTimePeriods(String, String, String) - Method in interface DatamartContext.Calendar
-
The same as
DatamartContext.Calendar.getTimePeriodNames(String, String, String)
but it returns a list of TimePeriod objects, rather than the corresponding period names. - getTimePeriods(Date, Date, CalendarUtil.TimeUnit) - Method in class CalendarUtil
- getTimePeriods(Date, Date, CalendarUtil.TimeUnit) - Method in interface DatamartContext.Calendar
- getTimeUnit() - Method in class ScheduleSettings
-
Gets you time unit as seen in the UI.
- getTimeUnit() - Method in class CalendarUtil.TimePeriod
- getTimeUnit() - Method in class DMCalendar.TimeDim
- getTimeZone(String) - Method in interface PublicGroovyAPI
-
Provides a wrapper for the org.joda.time.DateTimeZone.forId(String tzString) method.
- getTitle() - Method in interface ResultMatrix
-
Gets the current title
- getTitle() - Method in class ResultMatrix
-
Deprecated.
- getToStep() - Method in class ModelCalculationAction
- getTotalRow() - Method in interface ResultMatrix
-
Retrieves a value assigned to the
totalRow
property within the ResultMatrix. - getTotalRow() - Method in class ResultMatrix
-
Deprecated.
- getTotalRows() - Method in class TableContext
-
Returns the total row count over all used in-memory tables.
- getTraitType() - Method in class ScheduleSettings
- getTree(String) - Method in class ModelEvaluator
-
Retrieves the root node of the tree with the given name, if it exists (i.e. was created by the model).
- getTreeArtificialRoot() - Method in class Customer
- getTreeLabel() - Method in class QuoteLineItem
- getType() - Method in class WorkflowDTO
-
Returns the type of the workflow.
- getType() - Method in class DMField
- getType() - Method in class DMTable
- getType() - Method in class LookupTable
- getType() - Method in class ContextParameter
- getType(AttributeMeta) - Static method in class DMField
- getTypeCode() - Method in class ObjRefAction
- getTypeCode() - Method in class AttachedDocument
- getTypeCode() - Method in class SummaryCalculableObjectItem
- getTypedId() - Method in class WorkflowDTO
- getTypedId() - Method in class AttachedDocument
- getTypedId() - Method in class ContextParameter
- getTypedId() - Method in class SummaryCalculableObjectItem
- getTypeUniqueName() - Method in class AttachedDocument
- getUniqueName() - Method in class WorkflowDTO.StepDTO
-
Gets the name of the step
- getUniqueName() - Method in class AttachedDocument
- getUniqueName() - Method in class Pricelist
- getUniqueName() - Method in interface ModelFormulaContext
- getUniqueNamePrefix(PersistedObjectService) - Method in class Pricelist
- getUomField() - Method in class DMField
- getUpdateDate() - Method in class PriceGrid
- getUpdateDate() - Method in class Pricelist
- getUpdateDate() - Method in class RebateRecordSet
- getUpdatedBy() - Method in class PriceGrid
- getUpdatedBy() - Method in class Pricelist
- getUpdatedBy() - Method in class RebateRecordSet
- getURL() - Method in class ContextParameter
- getUsedSimulationFormulas() - Method in class Simulation
- getUsedSimulationLookups() - Method in class Simulation
- getUseFilterCriteria() - Method in class Simulation
- getUserApprover() - Method in class WorkflowInfo.WorkflowStepInfo
-
Deprecated.
- getUserAssignee() - Method in class CreationWorkflowStepDefinition
-
Deprecated.
- getUserAssignees() - Method in class CreationWorkflowStepDefinition
-
Retrieves users assigned (userAssignees) to the Creation Workflow Step.
- getUseRefreshData() - Method in class Table
- 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)
- getUserGroupAssignee() - Method in class CreationWorkflowStepDefinition
-
Deprecated.
- getUserGroupAssignees() - Method in class CreationWorkflowStepDefinition
-
Retrieves user groups assigned to the Creation Workflow Step.
- getUserGroupEdit() - Method in class AttachedDocument
- getUserGroupEdit() - Method in class CalculatedFieldSet
- getUserGroupEdit() - Method in class Customer
- getUserGroupEdit() - Method in class LookupTable
- getUserGroupEdit() - Method in class ManualPricelist
- getUserGroupEdit() - Method in class PriceGrid
- getUserGroupEdit() - Method in class Pricelist
- getUserGroupEdit() - Method in class RebateRecordSet
- getUserGroupEdit() - Method in class Simulation
- getUserGroupEdit() - Method in class ContextParameter
- getUserGroupViewDetails() - Method in class AttachedDocument
- getUserGroupViewDetails() - Method in class CalculatedFieldSet
- getUserGroupViewDetails() - Method in class Customer
- getUserGroupViewDetails() - Method in class LookupTable
- getUserGroupViewDetails() - Method in class ManualPricelist
- getUserGroupViewDetails() - Method in class PriceGrid
- getUserGroupViewDetails() - Method in class Pricelist
- getUserGroupViewDetails() - Method in class RebateRecordSet
- getUserGroupViewDetails() - Method in class Simulation
- getUserGroupWatcher() - Method in class WorkflowDTO.WatcherStepDTO
-
Deprecated.Gets user group name in case of group watcher (or null otherwise)
- getUserGroupWatchers() - Method in class CreationWorkflowStepDefinition
-
Retrieves watcher user groups (userGroupWatchers) from the Creation Workflow Step.
- 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 CreationWorkflowStepDefinition
-
Retrieves watchers (userWatchers) from the Creation Workflow Step.
- 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 class WaterfallColumnType
- getValue() - Method in interface Matrix2D
-
Convenience getter of values in the matrix.
- getValue() - Method in class ContextParameter
- getValue() - Method in class ResultGauge
-
The current value on the dial.
- getValue(long, long) - Method in interface Matrix2D
- getValue(FormulaEngineContext) - Method in class DMField
- getValueByName(String, BiFunction<MetaAttributed, String, AttributeMeta>) - Method in class Customer
- 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.
- getValueType() - Method in class LookupTable
- getVersion() - Method in class SummaryCalculableObjectItem
- getViaName(String) - Static method in enum class FilterOperator
- getViaValue(String) - Static method in enum class WaterfallColumnType
- getVisibility() - Method in class DMField
- getWeek(Date) - Method in class CalendarUtil
- getWeight() - Method in class ItemSummaryQuery.Projection
- getWfLastExecutedByName() - Method in class Pricelist
- getWizardDashboardName() - Method in class User
- getWorkflowStatus() - Method in class AttachedDocument
- getWorkflowStatus() - Method in class Pricelist
- getXLookupTableClass() - Method in class LookupTable
- getYear(Date) - Method in class CalendarUtil
- GRAY - Enum constant in enum class AuxLineColor
- GREATER_THAN - Enum constant in enum class FilterOperator
- GREATER_THAN_OR_EQUAL_TO - Enum constant in enum class FilterOperator
- 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.
- GREEN - Enum constant in enum class AuxLineColor
- Groovy API Fulltext Search (experimental) - Search tag in Overview
- Section
- GROUPED - Enum constant in enum class ComparisonType
H
- hardDelete(PersistedObjectService) - Method in class UserGroup
- hashCode() - Method in class Filter
- hashCode() - Method in class WorkflowDTO.StepDTO
- hashCode() - Method in class AttachedDocument.CompositeKey
- hashCode() - Method in class CustomerGroup
-
Returns a hash code value for the given object.
- hashCode() - Method in class DMField
- hashCode() - Method in class ContextParameter
- hasModuleAccess(ApplicationModule) - Method in class User
- hasSource(DMFieldCollection) - Method in class DMField
- hasSource(DMQuery) - Method in class DMField
- having(Filter...) - Method in interface DatamartContext.Query
-
Adds generic
Filter
s to the query's HAVING clause. - having(String...) - Method in interface DatamartContext.Query
-
Parses and ANDs one or more SQL-like conditions to the query's HAVING clause.
- HEATMAP - Enum constant in enum class ChartType
- 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 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
- helper - Variable in class LineItemHelper.LineItem
- HIDDEN - Enum constant in enum class InputType
- hideTrack(boolean) - Method in class SliderInputBuilder
-
Shows or hide the slider track (colored bar from lower bound to the cursor materializing the selected value).
- HIGHCHART - Enum constant in enum class CalculationResultType
- HIGHMAP - Enum constant in enum class CalculationResultType
- HISTOGRAM - Enum constant in enum class ChartType
- 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 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
- id - Variable in class ModelFormulaContext.TreeNode
- id() - Method in interface ModelFilterTreesContextReadOnly.FilterTreeNode
- id() - Method in interface ModelLookupTablesContextReadOnly.ModelLookupTable
- IDGenerator(String) - Constructor for class ItemSummaryQuery.IDGenerator
- idToLineItem - Variable in class LineItemHelper
- ignoreTargetDate(Boolean) - Method in class LivePriceGridAction
-
Sets the ignoreTargetDate of this job.
- ilike(String, String) - Static method in class Filter
-
Create a new Filter using the ILIKE operator.
- imageCell(Object) - Method in interface ResultMatrix
-
Creates an image cell that can then be added as row value.
- imageCell(Object) - Method in class ResultMatrix
-
Deprecated.
- in(String, Object...) - Static method in class Filter
-
Create a new Filter using the IN operator.
- in(String, Collection<?>) - Static method in class Filter
-
Create a new Filter using the IN operator.
- IN_SET - Enum constant in enum class FilterOperator
- include(CalendarUtil.TimePeriod) - Method in class DMDataSlice
- include(CalendarUtil.TimePeriod) - Method in interface DatamartContext.DataSlice
- include(CustomerGroup) - Method in class DMDataSlice
- include(CustomerGroup) - Method in interface DatamartContext.DataSlice
- include(ProductGroup) - Method in class DMDataSlice
- include(ProductGroup) - Method in interface DatamartContext.DataSlice
- include(SellerReference) - Method in class DMDataSlice
- INDEX - Enum constant in enum class AggregationFormula
- indexOfMax() - Method in interface Matrix2D
- indexOfMin() - Method in interface Matrix2D
- initInternalExpr() - Method in class DMField
- inlineConfigurator(String, String) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createConfiguratorInputBuilder(java.lang.String, java.lang.String, boolean)
(setisInline
totrue
) instead. - inlineConfigurator(String, String, Object) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createConfiguratorInputBuilder(java.lang.String, java.lang.String, boolean)
(setisInline
totrue
) instead. - inlineConfigurator(String, String, Object, Object) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createConfiguratorInputBuilder(java.lang.String, java.lang.String, boolean)
(setisInline
totrue
) instead. - INLINECONFIGURATOR - Enum constant in enum class InputType
- input(String) - Method in interface PublicGroovyAPI
-
Deprecated.This method has been deprecated. Instead of
api.input("abcd")
useinput.abcd
. - InputBuilderContext - Class in net.pricefx.formulaengine.scripting.inputbuilder
- InputBuilderContext(FormulaEngineContext, SandboxCallback) - Constructor for class InputBuilderContext
- inputBuilderFactory() - Method in interface PublicGroovyAPI
-
Provides factory to build various types of inputs.
- InputBuilderFactory - Class in net.pricefx.formulaengine.scripting.inputbuilder
-
Input Builder Factory class as a convenient way to create inputs (user entries, context parameters).
- InputBuilderFactory(FormulaEngineContext, SandboxCallback) - Constructor for class InputBuilderFactory
-
Use
api.inputBuilderFactory()
PublicGroovyAPI.inputBuilderFactory()
to obtain instance of this class from Groovy API. - InputButtonAction - Enum Class in net.pricefx.common.api
- inputMatrix(String, String...) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createInputMatrix(String)
instead. - inputMatrix(String, Map<String, Object>, String...) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createInputMatrix(String)
instead. - INPUTMATRIX - Enum constant in enum class InputType
- InputMatrixInputBuilder - Class in net.pricefx.formulaengine.scripting.inputbuilder
-
Builder class for input type InputMatrix
InputType.INPUTMATRIX
- InputMatrixInputBuilder(InputBuilderContext, String) - Constructor for class InputMatrixInputBuilder
- inputs - Variable in class ContractStructure.Item
- inputs - Variable in class QuoteStructure.Item
- inputs() - Method in interface ModelParallelCalculationFormulaItemContext.CalculationItem
- inputs(String, String) - Method in interface ModelFormulaContextReadOnly
-
This gives access to the previous steps saved inputs.
- InputType - Enum Class in net.pricefx.common.api
-
Enumeration of existing InputTypes.
- 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
- INT - Enum constant in enum class LookupTable.LookupTableValueType
- INT - Enum constant in enum class Matrix2D.BucketNaming
- INTEGER - Enum constant in enum class FieldFormatType
- INTEGER - Enum constant in enum class FieldType
- integerUserEntry(String) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createIntegerUserEntry(String)
instead. - INTEGERUSERENTRY - Enum constant in enum class InputType
- INTERPOLATED - Enum constant in enum class ColorAxisType
- INVALIDATED - Enum constant in enum class RebateAgreementStatus
- INVALIDATED - Enum constant in enum class RebateRecordStatus
- INVALIDATED - Enum constant in enum class AttachedDocument.DocumentStatus
- invokeAddAdditionalMeasure() - Method in class AbstractChartSeries
- invokeAddSeries() - Method in class AbstractChartBuilder
- invokeGetOptions() - Method in class AbstractChartBuilder
- invokeGetSeries() - Method in class AbstractChartBuilder
- IRebateRecordGroupManager - Interface in net.pricefx.formulaengine
-
IRebateRecordGroupManager is the interface that allows you to manipulate a RebateRecordGroup (RRG type code) in a calculation logic.
The Rebate Record Group is available via therebateRecordGroup
binding variable (see theset()
example below). - IRebateRecordManager - Interface in net.pricefx.formulaengine
-
The RebateRecordManager API is exposed to Groovy logic elements in the following contexts:
- IS_NULL - Enum constant in enum class FilterOperator
- isActivated() - Method in class User
- isActiveStep - Variable in class WorkflowInfo.WorkflowStepInfo
-
Is the this step active?
- isAddStepRestrictedToWFAdmin() - Method in class WorkflowDTO
- isAggregation() - Method in class DMField
- isAlreadySatisfied() - Method in class WorkflowInfo.WorkflowStepInfo
- isApprovalStep() - Method in class WorkflowInfo.WorkflowStepInfo
- isApproved() - Method in class WorkflowInfo.WorkflowStepInfo
- isArchive() - Method in class ExportAction
- isAssignable(Object) - Method in enum class DataType
- isAssignable(Object) - Method in class DMField
- isAttached() - Method in class AttachedDocument
- isAudited() - Method in class User
- isAudited() - Method in class UserGroup
- isAutoConvertToDeal() - Method in class WorkflowDTO
- isAuxiliary() - Method in class DMField
- isBoolean(Object) - Static method in enum class DataType
- isCalculated() - Method in class DMField
- isCalendarField() - Method in class DMField
- isChartType(String) - Static method in enum class ChartType
- isClosed() - Method in class TableContext
- isColumnar() - Method in class DMTable
- isCustomerParam() - Method in class ContextParameter
- isDate(Object) - Static method in enum class DataType
- isDateTime(Object) - Static method in enum class DataType
- isDebugMode() - Method in interface PublicGroovyAPI
-
Returns true if the logic is being executed via the UI "Test Logic" execution mode.
- isDefaultValueTracked(String) - Method in class ConfiguratorEntry
-
Checks if the default value tracking for the specified
ContextParameter
is enabled. - isDenialReasonOptional() - Method in class WorkflowDTO.ApprovalStepDTO
-
Returns whether the denial reasons are optional in this approval step.
- isDenialReasonOptional() - Method in class WorkflowDTO
- isDenied() - Method in class WorkflowInfo.WorkflowStepInfo
- isDeployed() - Method in class DMField
- isDimension() - Method in class DMField
- isDistributedMode() - Method in interface PublicGroovyAPI
-
Returns true if the calculation is executed in the distributed mode.
- isDistributionKey() - Method in class DMField
- isDoCount() - Method in class ItemSummaryQuery
- isDualGroupBy() - Method in class ItemSummaryQuery
- isEmailWatcher - Variable in class WorkflowInfo.WorkflowStepInfo
- isEmpty() - Method in interface DatamartRowSet
-
Returns
true
if thisDatamartRowSet
contains no rows. - isEmpty() - Method in interface Matrix2D
-
A matrix is empty if it has no rows.
- isEmpty(String) - Static method in class Filter
-
Create a new Filter using the IS EMPTY operator.
- isEnableAdvancedFilter() - Method in class ContextParameter
- isEnableClientFilter() - Method in interface ResultMatrix
- isEnableClientFilter() - Method in class ContextParameter
- isEnableClientFilter() - Method in class ResultMatrix
-
Deprecated.
- isEnableGroupByControls() - Method in interface ResultMatrix
-
Returns
true
(default) if "Group by" controls are enabled andfalse
when they are disabled. - isEnableGroupByControls() - Method in class ResultMatrix
-
Deprecated.
- isEscapeHTML() - Method in interface ResultMatrix
-
Is HTML escaping enabled?
- isEscapeHTML() - Method in class ResultMatrix
-
Deprecated.
- isExecuteOnError() - Method in class ChainedJobInfo
- isExport() - Method in class ExportAction
- isFilter(Map<String, ?>) - Static method in class Filter
- isFinal() - Method in class AttachedDocument
- isFirstLogin() - Method in class User
- isFirstRun(String) - Method in class ConfiguratorEntry
-
Retrieves the first run flag for a specific tracked input (i.e., created using the
InputBuilderFactory
and tracked for first run withAbstractInputBuilder.setFirstRunTracking(boolean)
enabled. - isFirstRunTracked(String) - Method in class ConfiguratorEntry
-
Checks if the first run value tracking for the specified
ContextParameter
is enabled. - isFolder - Variable in class ContractStructure.Item
- isFolder - Variable in class QuoteStructure.Item
- isFolder() - Method in class LineItemHelper.LineItem
- isFolder() - Method in class QuoteLineItem
- isFullListCalculation() - Method in interface PublicGroovyAPI
-
Indicates whether the current calculation is recalculating the entire list or only parts of it.
- isGroupable() - Method in enum class FieldType
- isGroupApprover - Variable in class WorkflowInfo.WorkflowStepInfo
-
Is this step an approval node by a user group?
- isGroupByDataExpanded() - Method in interface ResultMatrix
- isGroupByDataExpanded() - Method in class ResultMatrix
-
Deprecated.
- isHiddenParam() - Method in class ContextParameter
- isIncremental() - Method in interface DistFormulaContext
-
Proxy for DL.incremental.
- isInGroup(UserGroup) - Method in class User
- isInitialized() - Method in class WorkflowInfo.WorkflowStepInfo
- isInputGenerationExecution() - Method in interface PublicGroovyAPI
-
Returns true if the logic/formula is being executed in the so called input generation mode (special type of the execution run used to determine the logic input parameters).
- isKey() - Method in class DMField
- isLong(Object) - Static method in enum class DataType
- isLookupType() - Method in class ContextParameter
- isMassUpdate() - Method in class WorkflowDTO
- isMatrix() - Method in class PriceGrid
- isMatrix() - Method in class Pricelist
- isMatrix() - Method in class Simulation
- isMatrixLookupTableValueClass(Class<?>) - Static method in class LookupTable
- isMatrixParam() - Method in class ContextParameter
- isMultiApprovalAllowed() - Method in class WorkflowDTO.ApprovalStepDTO
-
Enables the user to approve the same approval step several times if that step requires multiple approvers.
- 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.
- isNumber(Object) - Static method in enum class DataType
- isNumeric() - Method in enum class DataType
- isNumeric() - Method in enum class FieldType
- isNumeric() - Method in class DMField
- isOptionParam() - Method in class ContextParameter
- isOptionsParam() - Method in class ContextParameter
- isParallelStepApprovalAllowed() - Method in class WorkflowDTO.ApprovalStepDTO
-
Enables the users can approve all parallel steps at once
- isParent() - Method in class Customer
- isPartitioningKey() - Method in class DMField
- isPercentBasis() - Method in class DMField
- isPeriodic() - Method in class ScheduleSettings
-
If this CF item is period or not.
- isPersisted() - Method in class DMField
- isPerUnitBasis() - Method in class DMField
- isPlasma() - Method in class LookupTable
- isPostPhase() - Method in class CalculableLineItemCollectionBuilder
-
Determines the current calculation phase of the header logic execution.
- isPostStepLogicFailed() - Method in class InsertWorkflowStepsDTO
- isPreExecuted() - Method in class WorkflowInfo.WorkflowStepInfo
- isPreferencesDisabled() - Method in interface ResultMatrix
-
Tells whether saving of matrix grid preferences is disabled.
- isPreferencesDisabled() - Method in class ResultMatrix
-
Deprecated.
- isPrePhase() - Method in class CalculableLineItemCollectionBuilder
-
Determines the current calculation phase of the header logic execution.
- isPreviousValueTracked(String) - Method in class ConfiguratorEntry
-
Checks if the previous value of a specified
ContextParameter
is being tracked. - isPricingDate() - Method in class DMField
- isProductGroupParam() - Method in class ContextParameter
- isProductParam() - Method in class ContextParameter
- isQueryable() - Method in class DMField
- isQueryable() - Method in class DMTable
- isQueryBuilderJoin(Map<String, Object>) - Method in interface DatamartContext
-
Find out if a join query was configured in a
Query Builder
input. - isRequired() - Method in class ContextParameter
- isRoot() - Method in class LineItemHelper.LineItem
- isScheduleChangeRequested() - Method in class ScheduleSettings
- isSecondPass() - Method in interface PublicGroovyAPI
-
Deprecated.Use
PublicGroovyAPI.getIterationNumber()
> 0 instead. - isSelectStepOnDeny() - Method in class WorkflowDTO
- isShotgunEnabled() - Method in class CalculatedFieldSet
- isShotgunEnabled() - Method in class PriceGrid
- isShotgunEnabled() - Method in class Pricelist
- isShotgunEnabled() - Method in class Simulation
- isShotgunModeEnabled() - Method in class Simulation
- isShowGroupByColumns() - Method in interface ResultMatrix
-
Returns
true
if "Group by" columns are shown andfalse
when they are hidden. - isShowGroupByColumns() - Method in class ResultMatrix
-
Deprecated.
- isShowGroupByControls() - Method in interface ResultMatrix
-
Returns
true
(default) if "Group by" controls are shown andfalse
when they are hidden. - isShowGroupByControls() - Method in class ResultMatrix
-
Deprecated.
- isSortingDisabled() - Method in interface ResultMatrix
-
UI sorting of matrix grid
- isSortingDisabled() - Method in class ResultMatrix
-
Deprecated.
- isStartImmediatelyTraitActive() - Method in class ScheduleSettings
- isSyntaxCheck() - Method in interface PublicGroovyAPI
-
Deprecated.Use
PublicGroovyAPI.isInputGenerationExecution()
instead. - isSystem() - Method in class DMField
- isSystemUser() - Method in class User
- isTakesListOfSubFilters() - Method in class Filter
- isTakesListOfValues() - Method in class Filter
- isTakesNoProperty() - Method in class Filter
- isTakesNoValue() - Method in class Filter
- isTakesSingleSubFilter() - Method in class Filter
- isTakesSingleValue() - Method in class Filter
- isTime() - Method in enum class DataType
- isTime() - Method in class DMField
- 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.
- isValid() - Method in class TieredValue
- isValid(String) - Static method in enum class InputButtonAction
- isValueChangeByLogicTracked(String) - Method in class ConfiguratorEntry
-
Checks if a specified
ContextParameter
is tracked for the value change by the Groovy logic - isView() - Method in class Table
- isWatcherStep() - Method in class WorkflowInfo.WorkflowStepInfo
- isWithdrawn() - Method in class WorkflowInfo.WorkflowStepInfo
- isWorkflowEmailingActivated() - Method in class User
- Item() - Constructor for class ContractStructure.Item
- Item() - Constructor for class QuoteStructure.Item
- ITEM_APPROVED_CGI - Enum constant in enum class EventType
-
Calculation Grid (CG) line Item approved
- ITEM_APPROVED_CL - Enum constant in enum class EventType
-
Claim approved
- ITEM_APPROVED_CO - Enum constant in enum class EventType
-
Compensation Plan approved
- ITEM_APPROVED_COR - Enum constant in enum class EventType
-
Compensation Record approved
- ITEM_APPROVED_CT - Enum constant in enum class EventType
-
PromotionManager contract approved
- ITEM_APPROVED_DCR - Enum constant in enum class EventType
-
Data Change Request approved
- ITEM_APPROVED_PGI - Enum constant in enum class EventType
-
Price Grid (LPG) line Item approved
- ITEM_APPROVED_PL - Enum constant in enum class EventType
-
Price list approved
- ITEM_APPROVED_Q - Enum constant in enum class EventType
-
Quote approved
- ITEM_APPROVED_RBA - Enum constant in enum class EventType
-
Rebate Agreement approved
- ITEM_APPROVED_RR - Enum constant in enum class EventType
-
Rebate Record approved
- ITEM_APPROVED_RRG - Enum constant in enum class EventType
-
Rebate Record Group approved
- ITEM_DENIED_CGI - Enum constant in enum class EventType
-
Calculation Grid (CG) line Item denied
- ITEM_DENIED_PGI - Enum constant in enum class EventType
-
Price Grid (LPG) line Item denied
- ITEM_PL_REVOKED - Enum constant in enum class EventType
-
Price list revoked
- ITEM_UPDATE_CGI - Enum constant in enum class EventType
-
Calculation grid line item updated (manual data change of the record)
- ITEM_UPDATE_CL - Enum constant in enum class EventType
-
Claim Agreement updated
- ITEM_UPDATE_CO - Enum constant in enum class EventType
-
Compensation plan updated
- ITEM_UPDATE_COR - Enum constant in enum class EventType
-
Compensation Record updated
- ITEM_UPDATE_CT - Enum constant in enum class EventType
-
PromotionManager contract updated
- ITEM_UPDATE_MPLI - Enum constant in enum class EventType
-
Manual pricelist line item updated (add/update/delete – detailed info about the operation, contains the MPLI record detail)
- ITEM_UPDATE_PGI - Enum constant in enum class EventType
-
Price grid line item updated (manual data change of the record)
- ITEM_UPDATE_PPV - Enum constant in enum class EventType
-
Any kind of Price Parameter value update (LTV or MLTVx) (add/update – the event contains the record itself)
- ITEM_UPDATE_PR - Enum constant in enum class EventType
-
Price Record updated (add/update/delete)
- ITEM_UPDATE_Q - Enum constant in enum class EventType
-
Quote updated (when the Status changes), the event contains complete Quote Header information
- ITEM_UPDATE_RBA - Enum constant in enum class EventType
-
Rebate agreement updated
- ITEM_UPDATE_RR - Enum constant in enum class EventType
-
Rebate Record updated
- ItemRecommendation - Class in net.pricefx.server.dto.calculation
-
Represents a scored item recommendation calculated by logic.
- ItemRecommendation(String, Double) - Constructor for class ItemRecommendation
- items - Variable in class ContractStructure.Item
- items - Variable in class ContractStructure
-
The list of items to add in this level of the contract
- items - Variable in class QuoteStructure.Item
- items - Variable in class QuoteStructure
-
The list of items to add in this level of the quote
- itemsStateChanged(PersistedObjectService) - Method in class PriceGrid
- itemsStateChanged(PersistedObjectService) - Method in class Pricelist
- ItemSummaryQuery<T> - 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
- JOB_FAILED - Enum constant in enum class EventType
-
When any scheduled job failed (price list calculation, Data Load, CFS,… ), i.e. whatever you can find in the JST table with the status Error
- jobSize(PersistedObjectService, JobStatusTracker, int) - Method in class CalculatedFieldSet
- jobSize(PersistedObjectService, JobStatusTracker, int) - Method in class PriceGrid
- jobSize(PersistedObjectService, JobStatusTracker, int) - Method in class Pricelist
- jobSize(PersistedObjectService, JobStatusTracker, int) - Method in class Simulation
- JSON - Enum constant in enum class LookupTable.LookupTableType
- JSON - Enum constant in enum class LookupTable.LookupTableValueType
- JSON2 - Enum constant in enum class LookupTable.LookupTableValueType
- 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
- key() - Method in interface ModelParallelCalculationFormulaItemContext.CalculationItem
- KEY - Enum constant in enum class DMFieldInputBuilder.FieldKind
- Knowledge Base - Search tag in Overview
- Section
- kurtosis(String) - Method in interface Matrix2D
L
- label - Variable in class ModelFilterTreesContextReadWrite.NodeSpec
-
Defines the value of the tree view node for the "label" field – the label of the node.
- label - Variable in class ResultMatrix.ResultMatrixBackEndCell
-
Deprecated.
- label - Variable in class ResultMatrix.ResultMatrixCells
-
Deprecated.
- label - Variable in class ResultMatrix.ResultMatrixDownloadCell
-
Deprecated.
- label - Variable in class ProductReferenceRecord
-
The label of the target (=containing) object (e.g. quote line item)
- label() - Method in interface ModelFilterTreesContextReadOnly.FilterTreeNode
- label() - Method in interface ModelFormulaContextReadOnly
- labelOrContractTermType - Variable in class ContractStructure.Item
- labelOrSku - Variable in class QuoteStructure.Item
- labelTranslations - Variable in class DMField
- LARGE - Enum constant in enum class AbstractInputBuilder.InputWidth
- last() - Method in interface DatamartRowSet
-
Sets the current row index of this
DatamartRowSet
to the last row. - lastUpdateDate() - Method in class User
- layout - Variable in class AbstractChartBuilder
- layout() - Method in class AbstractChartBuilder
- LESS_THAN - Enum constant in enum class FilterOperator
- LESS_THAN_OR_EQUAL_TO - Enum constant in enum class FilterOperator
- 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 interface ResultMatrix
- libraryImage(String, String) - Method in class ResultMatrix
-
Deprecated.
- LIGHT_BLUE - Enum constant in enum class AuxLineColor
- LIGHT_GREEN - Enum constant in enum class AuxLineColor
- LIGHT_RED - Enum constant in enum class AuxLineColor
- like(String, String) - Static method in class Filter
-
Create a new Filter using the LIKE operator.
- LimitPosition - Enum Class in net.pricefx.common.api.chart
- LimitToMeasure<S> - Class in net.pricefx.common.apibuilder.chart
- LimitToMeasure(S, String, String) - Constructor for class LimitToMeasure
- LimitType - Enum Class in net.pricefx.common.api.chart
- Line(C, String, String) - Constructor for class AuxLine.Line
- LINE - Enum constant in enum class AuxLineType
- LINE - Enum constant in enum class SeriesType
- lineItemFromMap(Map<String, Object>) - Method in class LineItemHelper
-
Creates the LineItem object from the given map.
- LineItemHelper - Class in net.pricefx.common.apibuilder.clicoll
- LineItemHelper(Map<String, Object>) - Constructor for class LineItemHelper
- LineItemHelper.LineItem - Class in net.pricefx.common.apibuilder.clicoll
-
This class represents either a line item or a folder of a document (e.g. quote/contract/rebate)
- lineItemMap - Variable in class LineItemHelper.LineItem
- LINK - Enum constant in enum class FieldFormatType
- linkButtonCell(Object, String, Object, Object) - Method in interface ResultMatrix
-
Displays a button inside a cell of the table.
- linkButtonCell(Object, String, Object, Object) - Method in class ResultMatrix
-
Deprecated.better use the shorter
ResultMatrix.LinkButtonCell
- linkCell(Object, String, Object) - Method in interface ResultMatrix
- linkCell(Object, String, Object) - Method in class ResultMatrix
-
Deprecated.
- linkToPriceGrid(Object, long, Filter) - Method in interface ResultMatrix
- linkToPriceList(Object, long, Filter) - Method in interface ResultMatrix
- linkToPriceParameter(Object, long) - Method in interface ResultMatrix
- listId - Variable in class ProductReferenceRecord
-
The ID of the target parent object.
- listLabel - Variable in class ProductReferenceRecord
-
Label of target parent object
- LivePriceGridAction<T> - Class in net.pricefx.common.apibuilder.calculationflowaction
-
This action starts calculation of selected LPG for all skus or restricted set of skus.
- LivePriceGridAction(T, Invocations<MethodInvocationRecord>, String) - Constructor for class LivePriceGridAction
- load(List<Map<String, Object>>, boolean) - Method in interface ModelLookupTablesContextReadWrite.MutableModelLookupTable
-
Loads some data in this table
- loadRows(String, List<Map<String, Object>>) - Method in class TableContext
-
Load data into an existing in-memory table.
- loadRows(String, PublicGroovyAPI.ResultIterator) - Method in class TableContext
-
Load data into an existing in-memory table.
- loadRows(String, StreamResults) - Method in class TableContext
- loadRows(DatamartRowSet) - Method in interface DatamartRowSet
-
Adds rows from another
DatamartRowSet
. - loadRows(Matrix2D) - Method in interface DatamartRowSet
-
Add rows from a #Matrix2D.
- loadRows(Matrix2D, Collection<String>) - Method in interface DatamartRowSet
-
Add rows from a #Matrix2D, possibly only a subset of the matrix columns.
- loadRows(Matrix2D, Map<String, String>) - Method in interface DatamartRowSet
-
Add rows from a #Matrix2D, possibly only a subset of the matrix columns.
- loadTable(DatamartContext.Table, Object) - Method in interface ModelCalcFormulaContext
-
Load data into an existing table without truncating it.
- loadTable(DatamartContext.Table, Object, boolean) - Method in interface ModelCalcFormulaContext
-
Load data into an existing table, optionally truncating it.
- loadTable(DatamartContext.Table, DatamartContext.Query) - Method in interface ModelParallelCalculationFormulaItemContext
-
Sample code:
- loadTable(DatamartContext.Table, DatamartContext.Query, boolean) - Method in interface ModelFormulaContextReadWrite
-
Sample code:
- loadTable(DatamartContext.Table, DatamartContext.SqlQuery) - Method in interface ModelParallelCalculationFormulaItemContext
-
Sample code:
- loadTable(DatamartContext.Table, DatamartContext.SqlQuery, boolean) - Method in interface ModelFormulaContextReadWrite
-
Sample code:
- LOB - Enum constant in enum class DataType
- LOB - Enum constant in enum class FieldType
- localize(String) - Method in interface PublicGroovyAPI
-
Method designed to prepare a translation key as ready to be internationalized in UI.
Key can contain only alphanumerics and underscores orSandboxApiException.LocalizeKeyException
will be thrown.
Empty ornull
key will be translated to{{}}
.
Example: - log(Object) - Method in interface PublicGroovyAPI
-
This function can be used by the Pricefx Support team only.
- log(String, Object) - Method in interface PublicGroovyAPI
-
This function is meant to be used by the Pricefx application internally only.
- logInfo(Object) - Method in interface PublicGroovyAPI
-
Logs an INFO message to the system error log which can be displayed in Tools > Logs > View Log.
- logInfo(String, Object) - Method in interface PublicGroovyAPI
-
Logs an INFO warning message to the system error log which can be displayed in Tools > Logs > View Log.
- logWarn(Object) - Method in interface PublicGroovyAPI
-
Logs a WARN message to the system error log which can be displayed in 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 Tools > Logs > View Log.
- LONG - Enum constant in enum class DataType
- LOOKUP - Enum constant in enum class InputType
- lookupTable(String) - Method in interface ModelLookupTablesContextReadOnly
- lookupTable(String) - Method in interface ModelLookupTablesContextReadWrite
- LookupTable - Class in net.pricefx.domain
- LookupTable() - Constructor for class LookupTable
- LookupTable(Partition, String, String) - Constructor for class LookupTable
- LookupTable.LookupTableType - Enum Class in net.pricefx.domain
- LookupTable.LookupTableValueType - Enum Class in net.pricefx.domain
- LookupTable.LTBulkloadFilterCheckCallback - Class in net.pricefx.domain
- lookupTablesContext() - Method in interface ModelFormulaContextReadOnly
- lookupTablesContext() - Method in interface ModelFormulaContextReadWrite
- LOST - Enum constant in enum class AttachedDocument.DocumentStatus
- LTBulkloadFilterCheckCallback(PersistedObjectService) - Constructor for class LookupTable.LTBulkloadFilterCheckCallback
M
- ManualPricelist - Class in net.pricefx.domain
- ManualPricelist() - Constructor for class ManualPricelist
- ManualPricelist(Partition, String, String) - Constructor for class ManualPricelist
- ManualPricelistAction<T> - Class in net.pricefx.common.apibuilder.calculationflowaction
-
This action starts calculation of selected manual pricelist.
- ManualPricelistAction(T, 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) - Method in interface PublicGroovyAPI
-
Removes the dirty flag from the specified item set previously by
PublicGroovyAPI.markItemDirty(String)
. - markItemClean(String, String) - Method in interface PublicGroovyAPI
-
Removes the dirty flag from the specified item set previously by
PublicGroovyAPI.markItemDirty(String, String)
. - markItemClean(String, String, String) - Method in interface PublicGroovyAPI
-
Removes the dirty flag from the specified item set previously by
PublicGroovyAPI.markItemDirty(String, String, String)
. - markItemClean(String, String, String, String) - Method in interface PublicGroovyAPI
-
Removes the dirty flag from the specified item set previously by
PublicGroovyAPI.markItemDirty(String, String, String, String)
. - markItemClean(String, String, String, String, String) - Method in interface PublicGroovyAPI
-
Removes the dirty flag from the specified item set previously by
PublicGroovyAPI.markItemDirty(String, String, String, String, String)
. - markItemClean(String, String, String, String, String, String) - Method in interface PublicGroovyAPI
-
Removes the dirty flag from the specified item set previously by
PublicGroovyAPI.markItemDirty(String, String, String, String, String, String)
. - markItemDirty() - Method in interface PublicGroovyAPI
-
Sets the dirty flag on the specified item, i.e. the second calculation run will be triggered and this item will be included in the 2nd pass.
- markItemDirty(String) - Method in interface PublicGroovyAPI
-
Sets the dirty flag on the specified item, i.e. the second calculation run will be triggered and this item will be included in the 2nd pass.
- markItemDirty(String, String) - Method in interface PublicGroovyAPI
-
Sets the dirty flag on the specified item, i.e. the second calculation run will be triggered and this item will be included in the 2nd pass.
- markItemDirty(String, String, String) - Method in interface PublicGroovyAPI
-
Sets the dirty flag on the specified item, i.e. the second calculation run will be triggered and this item will be included in the 2nd pass.
- markItemDirty(String, String, String, String) - Method in interface PublicGroovyAPI
-
Sets the dirty flag on the specified item, i.e. the second calculation run will be triggered and this item will be included in the 2nd pass.
- markItemDirty(String, String, String, String, String) - Method in interface PublicGroovyAPI
-
Sets the dirty flag on the specified item, i.e. the second calculation run will be triggered and this item will be included in the 2nd pass.
- markItemDirty(String, String, String, String, String, String) - Method in interface PublicGroovyAPI
-
Sets the dirty flag on the specified item, i.e. the second calculation run will be triggered and this item will be included in the 2nd pass.
- massDelete(String, Filter) - Method in interface PublicGroovyAPI
-
Mass delete of the objects in the collection of the given type (based on the Filter's criteria).
- matches(MatcherContext) - Method in class Filter
- matches(Map<String, Object>) - Method in class Filter
-
The method verifies if this
Filter
would successfully match the provided combination of values. - MATRIX - Enum constant in enum class CalculationResultType
- MATRIX - Enum constant in enum class LookupTable.LookupTableType
- MATRIX - Enum constant in enum class LookupTable.LookupTableValueType
- MATRIX2 - Enum constant in enum class LookupTable.LookupTableValueType
- 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 Class in net.pricefx.formulaengine.scripting
- MATRIX3 - Enum constant in enum class LookupTable.LookupTableValueType
- MATRIX4 - Enum constant in enum class LookupTable.LookupTableValueType
- MATRIX5 - Enum constant in enum class LookupTable.LookupTableValueType
- MATRIX6 - Enum constant in enum class LookupTable.LookupTableValueType
- MATRIXLOOKUP - Enum constant in enum class InputType
- max() - Method in interface Matrix2D
- MAX - Enum constant in enum class AbstractInputBuilder.InputWidth
- MAX_LOB_LENGTH - Static variable in enum class DataType
- MAX_STRING_LENGTH - Static variable in enum class DataType
- MD_BOM_PAGE - Static variable in interface AppPages
-
Master Data - Bill of Material page
- MD_COMPETITION_PAGE - Static variable in interface AppPages
-
Master Data
- MD_CUSTOMERS_PAGE - Static variable in interface AppPages
-
Master Data -
targetPageState
optionaltypedId
for specific Customer details - MD_CX_PAGE - Static variable in interface AppPages
-
Master Data - Customer Extensions page
- MD_DCR_PAGE - Static variable in interface AppPages
-
Master Data -
targetPageState
optionaltypedId
for specific Data Change Request details - MD_PP_PAGE - Static variable in interface AppPages
-
Master Data -
targetPageState
optionaltypedId
for specific PricingParameter details - MD_PRODUCTS_PAGE - Static variable in interface AppPages
-
Master Data -
targetPageState
optionaltypedId
for specific Product details - MD_PX_PAGE - Static variable in interface AppPages
-
Master Data - Product Extensions page
- MD_SELLER_EXTENSIONS_PAGE - Static variable in interface AppPages
-
Master Data - Seller Extensions page
- MD_SELLERS_PAGE - Static variable in interface AppPages
-
Master Data - Sellers page
- MD_WIZARD_PAGE - Static variable in interface AppPages
-
Master Data -
targetPageState
optionaltypedId
for specific Wizard details - mean() - Method in interface Matrix2D
- MEDIUM - Enum constant in enum class AbstractInputBuilder.InputWidth
- merge(DatamartRowSet) - Method in interface DatamartRowSet
-
Updates rows in this set, for which a row with the same key exists in the other set.
- 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
- metricName - Variable in enum class EventType
- min() - Method in interface Matrix2D
- MIN_MAX - Enum constant in enum class WhiskerType
- model(String) - Method in interface PublicGroovyAPI
-
Provides an API for interacting with an existing model (MO).
- ModelCalcFormulaContext - Interface in net.pricefx.formulaengine
-
The ModelCalcFormulaContext is exposed to model logics through the
model
binding, when calculating a model. - ModelCalculationAction<T> - Class in net.pricefx.common.apibuilder.calculationflowaction
-
If nothing is specified, all the steps of the model will be calculated.
- ModelCalculationAction(T, Invocations<MethodInvocationRecord>, String) - Constructor for class ModelCalculationAction
- ModelCalculationFormulaContext - Interface in net.pricefx.formulaengine.optimization
-
The
ModelCalculationFormulaContext
is exposed to model calculation logics through themodel
binding. - ModelContext - Interface in net.pricefx.formulaengine.optimization
- ModelEvaluationFormulaContext - Interface in net.pricefx.formulaengine.optimization
-
The
ModelEvaluationFormulaContext
is exposed to model evaluation logics through themodel
binding. - modelEvaluator(String) - Method in interface PublicGroovyAPI
-
Instantiates a model evaluator, providing access to a previously set up model (DMM).
- ModelEvaluator - Class in net.pricefx.formulaengine
-
A ModelEvaluator exposes a previously prepared/trained/calculated model to non-PO modules (Groovy logics).
- ModelEvaluator(DMModel, FormulaEngineContext) - Constructor for class ModelEvaluator
- ModelEvaluator.PMMLEvaluator - Interface in net.pricefx.formulaengine
-
Deprecated.
- ModelFilterTreesContextReadOnly - Interface in net.pricefx.formulaengine.optimization
- ModelFilterTreesContextReadOnly.FilterTree - Interface in net.pricefx.formulaengine.optimization
-
Represents a tree that can be fetched in various manners.
- ModelFilterTreesContextReadOnly.FilterTreeNode - Interface in net.pricefx.formulaengine.optimization
-
Represents an in-memory tree that can be walked up and down.
- ModelFilterTreesContextReadWrite - Interface in net.pricefx.formulaengine.optimization
- ModelFilterTreesContextReadWrite.MutableFilterTree - Interface in net.pricefx.formulaengine.optimization
- ModelFilterTreesContextReadWrite.NodeSpec - Class in net.pricefx.formulaengine.optimization
-
Represents an in-memory tree.
- ModelFormulaContext - Interface in net.pricefx.formulaengine
-
The ModelFormulaContext is exposed to model logics through the
model
binding. - ModelFormulaContext.TreeNode - Class in net.pricefx.formulaengine
-
Representation of a node in a model tree (see for ex.
- ModelFormulaContextReadOnly - Interface in net.pricefx.formulaengine.optimization
- ModelFormulaContextReadWrite - Interface in net.pricefx.formulaengine.optimization
- ModelLookupTablesContextReadOnly - Interface in net.pricefx.formulaengine.optimization
- ModelLookupTablesContextReadOnly.ModelLookupTable - Interface in net.pricefx.formulaengine.optimization
-
Represents a
LookupTable
owned by aModelObject
- ModelLookupTablesContextReadWrite - Interface in net.pricefx.formulaengine.optimization
- ModelLookupTablesContextReadWrite.MutableModelLookupTable - Interface in net.pricefx.formulaengine.optimization
-
Represents a
LookupTable
owned by a ModelObject with mutable operations - ModelParallelCalculationFormulaInitContext - Interface in net.pricefx.formulaengine.optimization
-
The
ModelParallelCalculationFormulaInitContext
is exposed to model parallel calculation logics through themodel
binding. - ModelParallelCalculationFormulaItemContext - Interface in net.pricefx.formulaengine.optimization
-
The
ModelParallelCalculationFormulaItemContext
is exposed to model parallel calculation logics through themodel
binding. - ModelParallelCalculationFormulaItemContext.CalculationItem - Interface in net.pricefx.formulaengine.optimization
- ModelParallelCalculationFormulaSummaryContext - Interface in net.pricefx.formulaengine.optimization
-
The
ModelParallelCalculationFormulaSummaryContext
is exposed to model parallel calculation logics through themodel
binding. - ModelParallelCalculationFormulaSummaryContext.CalculationItem - Interface in net.pricefx.formulaengine.optimization
- ModelParallelCalculationFormulaSummaryContext.CalculationItem.Status - Enum Class in net.pricefx.formulaengine.optimization
- ModelPMMLContext - Interface in net.pricefx.formulaengine.optimization
-
The
ModelPMMLContext
is exposed to model evaluations and calculations viamodel
binding. - ModelPMMLContext.PMMLEvaluator - Interface in net.pricefx.formulaengine.optimization
-
An evaluable PMML model.
- MODELRECORDS - Enum constant in enum class CalculationResultType
- ModelSchedulesContextReadOnly - Interface in net.pricefx.formulaengine.optimization
- ModelSchedulesContextReadOnly.ModelSchedule - Interface in net.pricefx.formulaengine.optimization
-
The representation of a Model Schedule accessible from a read only context.
- ModelSchedulesContextReadOnly.PeriodUnit - Enum Class in net.pricefx.formulaengine.optimization
- ModelSchedulesContextReadWrite - Interface in net.pricefx.formulaengine.optimization
- ModelSchedulesContextReadWrite.NewScheduleBuilder - Interface in net.pricefx.formulaengine.optimization
-
A builder object helping to add or update a model schedule.
- MONEY - Enum constant in enum class FieldFormatType
- MONEY - Enum constant in enum class FieldType
- MONEY_CHF - Enum constant in enum class FieldFormatType
- MONEY_EUR - Enum constant in enum class FieldFormatType
- MONEY_GBP - Enum constant in enum class FieldFormatType
- MONEY_JPY - Enum constant in enum class FieldFormatType
- MONEY_PLN - Enum constant in enum class FieldFormatType
- MONEY_USD - Enum constant in enum class FieldFormatType
- MONTH - Enum constant in enum class CalendarUtil.TimeUnit
- MONTH - Enum constant in enum class ModelSchedulesContextReadOnly.PeriodUnit
- MORE - Enum constant in enum class AggregationFormula
- moveItem(String, String) - Method in class CalculableLineItemCollectionBuilder
-
Moves an item or folder under a new parent.
- movePriceItems(String, List<String>, long, String, long) - Method in interface PublicGroovyAPI
-
API method for convenient movement of price items between price calculable entities.
- multiKey(Object...) - Method in interface PublicGroovyAPI
-
Constructs a new composite key object which can be used as a key in a map.
- multiplyTargets(BigDecimal) - Method in class TieredValue
- multiplyValues(BigDecimal) - Method in class TieredValue
- multiTierEntry(String, String...) - Method in interface PublicGroovyAPI
-
Deprecated.
- MULTITIERENTRY - Enum constant in enum class InputType
- MultiTierInputBuilder<VT> - Class in net.pricefx.formulaengine.scripting.inputbuilder
-
Builder class for input type MultiTierEntry
InputType.MULTITIERENTRY
. - MultiTierInputBuilder(InputBuilderContext, String) - Constructor for class MultiTierInputBuilder
N
- name - Variable in class ModelFormulaContext.TreeNode
- name - Variable in class ModelFilterTreesContextReadWrite.NodeSpec
-
Defines the value of the tree view node for the "name" field.
- name - Variable in class DashboardPopupInputBuilder.Dto
-
Dashboard uniqueName
- name() - Method in interface ModelFilterTreesContextReadOnly.FilterTree
- name() - Method in interface ModelFilterTreesContextReadOnly.FilterTreeNode
- NAME - Static variable in class RATBuilder
- NAME - Static variable in class RATBuilder.RABuilder
- namedEntities(List<Object>) - Method in interface PublicGroovyAPI
-
When given a list of entities (result of api.find,...), it converts the list of meta attributed entities to a list of maps where each map is a serialized entity whose keys are using field names from the attribute meta object.
- names(String) - Method in interface RContext
-
Often in R, results have a 'names' attribute, for example the parameter names in an lm() regression
- net.pricefx.common.api - package net.pricefx.common.api
-
Provides several classes commonly used in Pricefx API.
- net.pricefx.common.api.chart - package net.pricefx.common.api.chart
-
Chart API to work with charts.
- net.pricefx.common.api.pa - package net.pricefx.common.api.pa
- net.pricefx.common.apibuilder.calculationflowaction - package net.pricefx.common.apibuilder.calculationflowaction
-
Provides CalculationFlow API.
- net.pricefx.common.apibuilder.chart - package net.pricefx.common.apibuilder.chart
-
Chart Builder API to work with charts.
- net.pricefx.common.apibuilder.clicoll - package net.pricefx.common.apibuilder.clicoll
-
Calculable Line Item Collection (clicoll) API can be used to manipulate Quotes, Contracts and Rebate Agreements from header logic.
- net.pricefx.common.apibuilder.compensation - package net.pricefx.common.apibuilder.compensation
-
CompensationBuilder API allows to manipulate a rebate agreement object from a header logic.
- net.pricefx.common.apibuilder.contract - package net.pricefx.common.apibuilder.contract
-
ContractBuilder API allows to manipulate a contract object from a header logic.
- net.pricefx.common.apibuilder.customform - package net.pricefx.common.apibuilder.customform
- net.pricefx.common.apibuilder.quote - package net.pricefx.common.apibuilder.quote
-
QuoteBuilder API allows to manipulate a quote object from a quote header logic.
- net.pricefx.common.apibuilder.rebateagreement - package net.pricefx.common.apibuilder.rebateagreement
-
RebateAgreementBuilder API allows to manipulate a rebate agreement object from a header logic.
- net.pricefx.common.apihelper.conditionrecord - package net.pricefx.common.apihelper.conditionrecord
- net.pricefx.common.dto - package net.pricefx.common.dto
-
Defines set of data transfer object (DTO) classes.
- net.pricefx.common.dto.creationworkflow - package net.pricefx.common.dto.creationworkflow
- net.pricefx.common.util - package net.pricefx.common.util
-
Provides set of util classes.
- net.pricefx.domain - package net.pricefx.domain
-
Defines set of domain object classes.
- net.pricefx.formulaengine - package net.pricefx.formulaengine
-
Provides Formula Engine API classes.
- net.pricefx.formulaengine.optimization - package net.pricefx.formulaengine.optimization
- net.pricefx.formulaengine.scripting - package net.pricefx.formulaengine.scripting
-
Provides API related to scripting, including interface
PublicGroovyAPI
, that represents what can be reached in the Groovy element syntax asapi
. - net.pricefx.formulaengine.scripting.inputbuilder - package net.pricefx.formulaengine.scripting.inputbuilder
-
Provides
InputBuilderFactory
as a convenient way to create Inputs. - net.pricefx.formulaengine.scripting.portlets - package net.pricefx.formulaengine.scripting.portlets
- net.pricefx.server.dto - package net.pricefx.server.dto
-
Defines set of data transfer object (DTO) classes.
- net.pricefx.server.dto.calculation - package net.pricefx.server.dto.calculation
-
Defines set of data transfer object (DTO) classes related to Calculations.
- net.pricefx.server.dto.calculation.dashboard - package net.pricefx.server.dto.calculation.dashboard
-
Provides Dashboard API classes.
- net.pricefx.server.dto.calculation.notification - package net.pricefx.server.dto.calculation.notification
- net.pricefx.server.protocol - package net.pricefx.server.protocol
-
Provides
StreamResults
interface. - net.pricefx.server.util.metamodel.dm - package net.pricefx.server.util.metamodel.dm
- net.pricefx.service - package net.pricefx.service
-
Provides ItemSummaryQuery interface.
- net.pricefx.workflowengine - package net.pricefx.workflowengine
-
Provides Workflow API.
- neverMatch() - Static method in class Filter
- NEW_PASSWORD_HASH - Static variable in class User
- NEW_PASSWORD_NOSESSION_HASH - Static variable in class User
- NEW_PRICELIST - Enum constant in enum class Pricelist.ProcessingMode
-
Creates a new pricelist Will wipe potentially existing results Uses specified product selection criteria
- NEW_REVISION - Enum constant in enum class Pricelist.ProcessingMode
-
Only valid if previous pricelist specified.
- NEW_REVISION_BYCRITERIA - Enum constant in enum class Pricelist.ProcessingMode
-
Only valid if previous pricelist specified.
- newActionItem() - Method in class ActionItemApi
-
Initiates a builder object to create a new Action Item (AI).
- 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
- newChartBuilder() - Method in interface PublicGroovyAPI
-
The
ChartBuilder
API allows you to create PA DataAnalyzer chart definitions to be displayed in Dashboard portlets, quote headers and more UI areas. - newController() - Method in interface PublicGroovyAPI
-
Creates a new dashboard controller object that can be further customized.
- newCreationWorkflow() - Method in interface PublicGroovyAPI
-
Creates the
CreationWorkflowDefinition
object using the specified steps.
Available for: Agreements & Promotions (Contracts), Compensation Plans, Quotes, and Rebate Agreements.
Example (step1, step2, step3 must be already defined within the logic usingapi.newCreationWorkflowStep()
): - newCreationWorkflowStep() - Method in interface PublicGroovyAPI
-
Creates the workflow step (the
CreationWorkflowStepDefinition
object). - newCustomForm() - Method in class CustomFormApi
-
Initiates a builder object to create a new Custom Form.
- newDataLoader(DatamartContext.Table) - Method in interface DatamartContext
- newDataLoader(DatamartContext.Table, List<String>) - Method in interface DatamartContext
- newDatamartSlice() - Method in interface DatamartContext
-
Creates a new DatamartSlice which allows for setting filter criteria along the Time, CustomerGroup, ProductGroup or any other dimension in a Datamart.
- newDatamartSlice() - Method in interface PublicGroovyAPI
-
Deprecated.Use
DatamartContext.newDatamartSlice()
instead. - newDatamartSlice(String, Object...) - Method in interface DatamartContext
-
Creates a new DatamartSlice which allows for setting filter criteria along the Time, CustomerGroup, ProductGroup or any other dimension in a Datamart, initialized with the name of the time dimension field and an optional set of filter criteria.
- newDatamartSlice(String, Object...) - Method in interface PublicGroovyAPI
-
Deprecated.Use
DatamartContext.newDatamartSlice(String, Object...)
instead. - newDataTable() - Method in class ChartBuilder
- newDetailedTimeSeries() - Method in class ChartBuilder
- newExecution() - Method in interface DashboardApi
-
Create execution to run a dashboard logic.
- 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
- newItemRecommendation(String, Double) - Method in interface PublicGroovyAPI
-
Creates and returns a new ItemRecommendation object for Cross-sell and Upsell API.
- newJoinFromQueryBuilder(Map<String, Object>) - Method in interface DatamartContext
-
Gets the join query defined in
Query Builder
source series. - newJoinFromQueryFilterBuilder(Map<String, Object>, Map<String, Object>) - Method in interface DatamartContext
-
When combining a
Query Builder
and aQuery Filter
this method returns the join query with the filter already applied in theSQL query
. - newJsonLookupTableValue() - Method in class LookupTable
- 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.
- newMatrixLookupTableValue() - Method in class LookupTable
- newPie() - Method in class ChartBuilder
- newQueriesFromQueryBuilder(Map<String, Object>) - Method in interface DatamartContext
-
Gets all
Query Builder
source series, ordered as configured in the UI (i.e. ordered as in the providedbuilderState
. - newQuery(String) - Method in class TableContext
- newQuery(DatamartContext.Query) - Method in interface DatamartContext
-
Creates 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(DatamartContext.Table) - Method in interface DatamartContext
-
Builds a new query on the given table.
- newQuery(DatamartContext.Table, boolean) - Method in interface DatamartContext
-
Builds a new query on the given table allowing you to disable a rollup aggregation.
- newQuery(Table) - Method in class TableContext
- newQueryFromQueryFilterBuilder(Map<String, Object>, Map<String, Object>) - Method in interface DatamartContext
-
When combining a
Query Builder
and aQuery Filter
this method returns the selected source query with the filter already applied in theDatamartContext.Query.where(Filter...)
clause. - newReviewByUserGroups() - Method in interface PublicGroovyAPI
- newReviewParallelSubSteps(IsParallelSubStep...) - Method in interface PublicGroovyAPI
- newReviewSequentialSubSteps(IsSequentialSubStep...) - Method in interface PublicGroovyAPI
- newReviewStep() - Method in interface PublicGroovyAPI
- newReviewSubStep() - Method in interface PublicGroovyAPI
- newRow() - Method in interface DatamartRowSet
-
Creates a representation of a new row, potentially populated with default values.
- newScatter() - Method in class ChartBuilder
- newSchedule(String) - Method in interface ModelSchedulesContextReadWrite
-
Creates or updates a Model Schedule.
- newSqlQuery() - Method in interface DatamartContext
-
Instantiates a query object for building SQL statements from source queries, with clauses and parameter bindings.
- newSystemPortlet(String) - Method in interface PublicGroovyAPI
-
Creates a representation of a System portlet, like the Quotes list, To Do list, Quick Product Search, etc.
- newTimePeriod(String, String) - Method in class CalendarUtil
- newTimePeriod(String, String, String) - Method in class CalendarUtil
- newTimeSeries() - Method in class ChartBuilder
- newTimeSeriesScatter() - Method in class ChartBuilder
- newWaterfall() - Method in class ChartBuilder
- newWaterfallComparison() - Method in class ChartBuilder
- newXLookupTableValue() - Method in class LookupTable
- next() - Method in interface DatamartRowSet
-
Sets the current row index of this
DatamartRowSet
to the next row. - next() - Method in interface StreamResults
-
Moves the cursor forward one row from its current position.
- nextNamedEntity() - Method in interface PublicGroovyAPI.ResultIterator
- NO_VALIDATION - Enum constant in enum class TieredValueValidationType
- NodeSpec() - Constructor for class ModelFilterTreesContextReadWrite.NodeSpec
- NonAggrFieldAxis<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.
- NONE - Enum constant in enum class ComparisonType
- NONE - Enum constant in enum class WhiskerType
- 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
- normalizeDateTimes() - Method in interface ResultMatrix
-
Search for non null
FieldFormatType.DATETIME
columns and convert them intoDateTime
- normalizeDateTimes() - Method in class ResultMatrix
-
Deprecated.
- 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.
- NOT - Enum constant in enum class FilterOperator
- NOT_APPROVED - Enum constant in enum class ApprovalState
-
PriceList is in this state if all its PriceListItems are not approved.
- NOT_EQUAL - Enum constant in enum class FilterOperator
- NOT_IN_SET - Enum constant in enum class FilterOperator
- NOT_NULL - Enum constant in enum class FilterOperator
- notEqual(String, Object) - Static method in class Filter
-
Create a new Filter using the !
- notificationApi() - Method in interface PublicGroovyAPI
-
Returns a
NotificationApi
instance for operations related to Notifications. - NotificationApi - Interface in net.pricefx.server.dto.calculation.notification
-
The
NotificationApi
interface is used for configuring Notifications. - notIn(String, Object...) - Static method in class Filter
-
Create a new Filter using the NOT IN operator.
- notIn(String, Collection<?>) - Static method in class Filter
-
Create a new Filter using the NOT IN operator.
- NUMBER - Enum constant in enum class DataType
- NUMBER - Enum constant in enum class FieldType
- numberToString(Number, int) - Static method in enum class DataType
- NUMERIC - Enum constant in enum class FieldFormatType
- NUMERIC - Enum constant in enum class DMFieldInputBuilder.FieldKind
- NUMERIC_LONG - Enum constant in enum class FieldFormatType
O
- ObjRefAction<T> - Class in net.pricefx.common.apibuilder.calculationflowaction
-
This action starts calculation of selected rebate record set records.
- ObjRefAction(T, Invocations<MethodInvocationRecord>) - Constructor for class ObjRefAction
- objService - Variable in class TableContext
- OFFER - Enum constant in enum class AttachedDocument.DocumentStatus
- offsetDate(Date, int) - Method in enum class CalendarUtil.TimeUnit
- OK - Enum constant in enum class InputButtonAction
- onApprove(User) - Method in class Pricelist
- onApproved(User) - Method in class Pricelist
- onApproved(User, PersistedObjectService) - Method in class Pricelist
- 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 BubbleChart
- onClick() - Method in class ScatterChart
- onDelete(PersistedObjectService) - Method in class CalculatedFieldSet
- onDelete(PersistedObjectService) - Method in class CustomerAssignment
- onDelete(PersistedObjectService) - Method in class LookupTable
- onDeny(User) - Method in class Pricelist
- oneStep(String) - Method in class ModelCalculationAction
-
Calculates the step of the model.
- onNoApprovalRequired(User, WorkflowDTO, ApprovalActionsService) - Method in class Pricelist
- onPointClick() - Method in class ResultHighchart
-
BETA
Allows to define events that will be triggered when the user clicks in the chart/map. - onPreProcessing(Map<String, Object>, LocalDateTime) - Method in class Customer
- onPreProcessing(Map<String, Object>, LocalDateTime) - Method in class LookupTable
- onPreProcessing(Map<String, Object>, LocalDateTime) - Method in class PriceGrid
- onPreProcessing(Map<String, Object>, LocalDateTime) - Method in class Pricelist
- onRowClick() - Method in class AbstractChartBuilder
- OnRowClick(C) - Constructor for class ChartEvents.OnRowClick
- onRowSelection() - Method in interface ResultMatrix
-
Configures a client-side UI event.
- onRowSelection() - Method in class ResultMatrix
-
Deprecated.
- onSavedOrUpdated(PersistedObjectService) - Method in class LookupTable
- onSavedOrUpdated(PersistedObjectService) - Method in class User
- onSaveOrUpdate(PersistedObjectService) - Method in class LookupTable
- onSaveOrUpdate(PersistedObjectService) - Method in class ManualPricelist
- onSaveOrUpdate(PersistedObjectService) - Method in class PriceGrid
- onSaveOrUpdate(PersistedObjectService) - Method in class Pricelist
- onSaveOrUpdate(PersistedObjectService) - Method in class User
- onSubmit(User) - Method in class Pricelist
- onTreeObjectAdd(Map<String, Object>, PersistedObjectService) - Method in class Customer
- onTreeObjectAddChildren(Map<String, Object>, PersistedObjectService) - Method in class Customer
- onTreeObjectRemove(Map<String, Object>, PersistedObjectService) - Method in class Customer
- onTreeObjectUpdate(Map<String, Object>, PersistedObjectService) - Method in class Customer
- onWithdraw() - Method in class Pricelist
- 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
- OPEN - Enum constant in enum class RebateAgreementStatus
- OPEN - Enum constant in enum class AttachedDocument.DocumentStatus
- openInModalOrRecalculateOn(String) - Method in interface DashboardApi
-
On specified event the embedded dashboard will be opened in a new modal window and recalculated.
- openInTabOrRecalculateOn(String) - Method in interface DashboardApi
-
On specified event the embedded dashboard will be opened in a new tab and recalculated.
- openInWindowOrRecalculateOn(String) - Method in interface DashboardApi
-
Deprecated.
- operator - Variable in class Filter
-
The type of comparison to do between the property and the value.
- option(String, Object...) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createOptionEntry(String)
instead. - option(String, List<Object>, Map<String, Object>) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createOptionEntry(String)
instead. - OPTION - Enum constant in enum class InputType
- OptionInputBuilder - Class in net.pricefx.formulaengine.scripting.inputbuilder
-
Builder class for input type Option and Options (
InputType.OPTION
andInputType.OPTIONS
). - OptionInputBuilder(InputBuilderContext, InputType, String) - Constructor for class OptionInputBuilder
- options - Variable in class ScatterChart
- options - Variable in class TimeSeriesScatterChart
- options(String, Object...) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createOptionsEntry(String)
instead. - options(String, List<Object>, Map<String, Object>) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createOptionsEntry(String)
instead. - OPTIONS - Enum constant in enum class InputType
- or(Filter...) - Static method in class Filter
-
Create a new Filter using the OR operator.
- OR - Enum constant in enum class FilterOperator
- ORANGE - Enum constant in enum class AuxLineColor
- 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.
- otherCustomer(String, String, boolean, String, Object) - Method in interface PublicGroovyAPI
-
Triggers a custom-named customer picker input parameter.
- otherProduct(String) - Method in interface PublicGroovyAPI
-
Triggers a custom-named product picker input parameter.
- otherProduct(String, String) - Method in interface PublicGroovyAPI
-
Triggers a custom-named product picker input parameter.
Example: - otherProduct(String, String, String, Object) - Method in interface PublicGroovyAPI
-
Triggers a custom-named product picker input parameter.
Example: - otherSeller(String) - Method in interface PublicGroovyAPI
-
Triggers a custom-named seller picker input parameter.
- otherSeller(String, String) - Method in interface PublicGroovyAPI
-
Triggers a custom-named seller picker input parameter.
- otherSeller(String, String, String, Object) - Method in interface PublicGroovyAPI
-
Triggers a custom-named seller picker input parameter.
- OUTLIER_15_IQR - Enum constant in enum class WhiskerType
- OUTLIER_30_IQR - Enum constant in enum class WhiskerType
- output - Variable in class ModelFormulaContext.TreeNode
- outputs() - Method in interface ModelParallelCalculationFormulaSummaryContext.CalculationItem
- outputs(String, String) - Method in interface ModelFormulaContextReadOnly
-
This method gives access to the results of calculations of this Model object, that is: Formula Calculations that produce a result per element. Job Trigger Calculations that may produce an arbitrary map of results, depending on the image used.
P
- P_01_99TH - Enum constant in enum class WhiskerType
- P_02_09_91_98TH - Enum constant in enum class WhiskerType
- P_02_98TH - Enum constant in enum class WhiskerType
- P_05_95TH - Enum constant in enum class WhiskerType
- P_09_91TH - Enum constant in enum class WhiskerType
- P_10_90TH - Enum constant in enum class WhiskerType
- PA_CHART_BARLINE_PAGE - Static variable in interface AppPages
-
PriceAnalyzer module
- PA_CHART_BOXPLOT_PAGE - Static variable in interface AppPages
-
PriceAnalyzer module
- PA_CHART_BUBBLE_PAGE - Static variable in interface AppPages
-
PriceAnalyzer module
- PA_CHART_COMPARISONWF_PAGE - Static variable in interface AppPages
-
PriceAnalyzer module
- PA_CHART_DATATABLE_PAGE - Static variable in interface AppPages
-
PriceAnalyzer module
- PA_CHART_DETAILEDTIME_PAGE - Static variable in interface AppPages
-
PriceAnalyzer module
- PA_CHART_HEATMAP_PAGE - Static variable in interface AppPages
-
PriceAnalyzer module
- PA_CHART_HISTOGRAM_PAGE - Static variable in interface AppPages
-
PriceAnalyzer module
- PA_CHART_PAGE - Static variable in interface AppPages
-
PriceAnalyzer module
- PA_CHART_PIE_PAGE - Static variable in interface AppPages
-
PriceAnalyzer module
- PA_CHART_SCATTER_PAGE - Static variable in interface AppPages
-
PriceAnalyzer module
- PA_CHART_TIMESCATTER_PAGE - Static variable in interface AppPages
-
PriceAnalyzer module
- PA_CHART_TIMESERIES_PAGE - Static variable in interface AppPages
-
PriceAnalyzer module
- PA_CHART_WATERFALL_PAGE - Static variable in interface AppPages
-
PriceAnalyzer module
- PA_DATASOURCES_PAGE - Static variable in interface AppPages
-
PriceAnalyzer module -
targetPageState
optionaltypedId
for specific DataSource details - PA_ROLLUPS_PAGE - Static variable in interface AppPages
-
PriceAnalyzer module
- PADATALOAD_COMPLETED - Enum constant in enum class EventType
-
PriceAnalyzer Data Load process finished
- PAQUERY - Enum constant in enum class CalculationResultType
- parent() - Method in interface ModelFilterTreesContextReadOnly.FilterTreeNode
- parentId - Variable in class ContractStructure
-
The level of the contract.
- parentId - Variable in class QuoteStructure
-
The level of the quote.
- parentId - Variable in class ModelFormulaContext.TreeNode
- parentIdToLineItems - Variable in class LineItemHelper
- parsableInputFile(String) - Method in interface PublicGroovyAPI
-
Creates an input parameter that lets the user pick a file.
- PARSABLEINPUTFILE - Enum constant in enum class InputType
- 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 data structures.
- parse(Object) - Method in enum class DataType
- parse(Object, Locale) - Method in enum class DataType
- parseDate(String) - Method in class CalendarUtil
- 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 class CalendarUtil
- 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
- parseTimePeriod(String) - Method in class CalendarUtil
- parseValue(Object) - Method in class DMField
- partialCalculationDate() - Method in class PriceGrid
- PARTIALDEAL - Enum constant in enum class AttachedDocument.DocumentStatus
- PARTIALLY_APPROVED - Enum constant in enum class ApprovalState
-
PriceGrid is in this state if some of PriceGridItems are approved some are not approved.
- passwordExpiry() - Method in class User
- PayoutRecordManager - Interface in net.pricefx.formulaengine
-
API that can be accessed via the 'payoutRecords' binding (available in the RebateRecord calculation context — i.e., when calculating a RebateRecord in a RebateRecordCalculation task), or via the 'accrualRecords' binding (available in the CompensationRecord calculation context).
- PB_LPG_PAGE - Static variable in interface AppPages
-
PriceBuilder module -
targetPageState
optionaltypedId
for specific Live Price Grid details - PB_MPL_PAGE - Static variable in interface AppPages
-
PriceBuilder module - Manual Price Lists page
- PB_PL_ADD_SKU_PAGE - Static variable in interface AppPages
-
PriceBuilder module -
targetPageState
mandatorytypedId
for specific price list - PB_PL_PAGE - Static variable in interface AppPages
-
PriceBuilder module -
targetPageState
optionaltypedId
for specific Price List details - PB_SIMULATION_PAGE - Static variable in interface AppPages
-
PriceBuilder module
- PCGroupInputBuilder - Class in net.pricefx.formulaengine.scripting.inputbuilder
-
Builder class for input type ProductGroup, CustomerGroup and SellerGroup
- PCGroupInputBuilder(InputBuilderContext, InputType, String) - Constructor for class PCGroupInputBuilder
- PENDING - Enum constant in enum class CalculationStatus
-
Waiting for the next background worker to pick it up for processing.
- PERCENT - Enum constant in enum class AggregationFormula
- PERCENT - Enum constant in enum class FieldFormatType
- PERUNIT - Enum constant in enum class AggregationFormula
- PERUNIT_INDEX - Enum constant in enum class AggregationFormula
- phase - Variable in class CalculableLineItemCollectionBuilder
- PIE - Enum constant in enum class ChartType
- 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 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
- plot(String, String) - Method in interface RContext
-
Future functionality - Not yet implemented!
- PM_CONTRACTS_PAGE - Static variable in interface AppPages
-
PromotionManager module -
targetPageState
optionaltypedId
for specific Contract details - PM_NEW_CONTRACT - Static variable in interface AppPages
-
PromotionManager module -
targetPageState
- pmmlContext() - Method in interface ModelFormulaContextReadOnly
- pmmlEvaluator(String) - Method in class ModelEvaluator
-
Returns an instance of
ModelEvaluator.PMMLEvaluator
that can safely be stored inapi.global
so that future usage can reuse the already loaded PMML in memory. - PO_NEW_MODEL - Static variable in interface AppPages
-
New Model (only from Contextual Actions in PLPGTT)
- Portlet - Interface in net.pricefx.formulaengine.scripting.portlets
-
Common interface for the portlet behavior.
- portletNames - Variable in class DashboardPopupInputBuilder.Dto
-
Dashboard portlet names are actually the dashboard logic's LogicElement uniqueNames.
- postProcessRow(Map<String, Object>) - Method in class ItemSummaryQuery
- preferences - Variable in class DashboardPopupInputBuilder.Dto
-
Properties map:
- prepareAsDtoForUpdate(ValidationVisitor, PersistedObjectService) - Method in class DMTable
- prepareAsDtoForUpdate(PersistedObjectService) - Method in class DMField
- previous() - Method in interface DatamartRowSet
-
Sets the current row index of this
DatamartRowSet
to the previous row. - 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.
- Pricefx REST API Documentation - Search tag in Overview
- Section
- Pricefx Studio - Search tag in Overview
- Section
- Pricefx Training Portal - Search tag in Overview
- Section
- Pricefx Unity Documentation - Search tag in Overview
- Section
- PriceGrid - Class in net.pricefx.domain
- PriceGrid - Enum constant in enum class Simulation.SimulationType
- PriceGrid() - Constructor for class PriceGrid
- pricelist(String) - Method in interface PublicGroovyAPI
-
Looks up the result price (considering a manual override) of an SKU being calculated (SKU in the context) in a price list of the given name.
- pricelist(String, String) - Method in interface PublicGroovyAPI
-
Looks up the value of the attribute given by
attributeName
(considering a manual override) of an SKU being calculated (SKU in the context) 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. - Pricelist - Class in net.pricefx.domain
- Pricelist() - Constructor for class Pricelist
- Pricelist(Pricelist) - Constructor for class Pricelist
- PriceList - Enum constant in enum class Simulation.SimulationType
- Pricelist.PricelistErrorModeType - Enum Class in net.pricefx.domain
-
ABORT is used as default
- Pricelist.ProcessingMode - Enum Class in net.pricefx.domain
- PricelistAction<T> - Class in net.pricefx.common.apibuilder.calculationflowaction
-
This action starts calculation of selected pricelist.
- PricelistAction(T, 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.
- pricelistItem(String, String, String, Date) - 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.
- print(String) - Method in interface RContext
-
When evaluating an expression in R some output may be printed as a side effect, such as by lm().
- printTablesDefinitions(String) - Method in class TableContext
-
Returns a debug string that contains the complete schema definition for the temporary in-memory database.
- PROCESSING - Enum constant in enum class CalculationStatus
-
The system is processing the computation.
- processPostLoad() - Method in class Pricelist
- product() - Method in interface PublicGroovyAPI
-
Retrieves the product object for the SKU currently being calculated (SKU in the context).
- product(String) - Method in interface PublicGroovyAPI
-
Retrieves the given attribute value from the Products table for the SKU being calculated (the SKU in the context).
- product(String, String) - Method in interface PublicGroovyAPI
-
Retrieves the given attribute value from the Products 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.
- PRODUCT - Enum constant in enum class InputType
- productCompetition() - Method in interface PublicGroovyAPI
-
Retrieves a list of all product competition rows/records (PCOMP) for the SKU being calculated (SKU in the context).
- productCompetition(Filter...) - Method in interface PublicGroovyAPI
-
Retrieves a list of product competition rows/records (PCOMP) for the SKU being calculated (SKU in the context) filtered by
filters
. - PRODUCTDATA - Enum constant in enum class ChartType
- productExtension(String) - Method in interface PublicGroovyAPI
-
Retrieves a list of rows from a Product Extension (PX) table named
extensionName
for the SKU being calculated (SKU in the context). - productExtension(String, Filter...) - Method in interface PublicGroovyAPI
-
Retrieves a list of rows from a Product Extension (PX) table named
extensionName
for the SKU being calculated (SKU in the context) additionally filtered byfilters
. - ProductGroup - Class in net.pricefx.domain
-
ProductGroup
- ProductGroup() - Constructor for class ProductGroup
- PRODUCTGROUP - Enum constant in enum class InputType
- productGroupEntry(String...) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createProductGroupEntry(String)
instead. - productGroupEntry(String, String, Object) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createProductGroupEntry(String)
instead. - ProductInputBuilder - Class in net.pricefx.formulaengine.scripting.inputbuilder
-
Builder class for input type Product
InputType.PRODUCT
. - ProductInputBuilder(InputBuilderContext, String) - Constructor for class ProductInputBuilder
- 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 results to objects of the related type that have a link to the given product.
- productToRelatedObjectsFilter(String, ProductGroup) - Method in interface PublicGroovyAPI
-
Creates a filter to be applied to a search on a related object type, limiting the results to objects of the related type that have a link to the given product picker.
- 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
. - Public Groovy API - Search tag in Overview
- Section
- PublicGroovyAPI.ResultIterator - Interface in net.pricefx.formulaengine.scripting
-
Type returned by the stream(...) methods.
- putGlobal(Map<String, Object>) - Method in interface PublicGroovyAPI
-
Puts an entire map of variables into the global cache.
Q
- QC_DETAILS_PAGE - Static variable in interface AppPages
-
QuoteConfigurator module -
targetPageState
optionaltypedId
for specific Quote details - QC_NEW_QUOTE - Static variable in interface AppPages
-
QuoteConfigurator module -
targetPageState
JSON map with parameters: quoteType (mandatory) and customerId (optional) - QC_TYPES_PAGE - Static variable in interface AppPages
-
QuoteConfigurator module
- QUANTITY - Enum constant in enum class FieldType
- 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.
- QUARTER - Enum constant in enum class CalendarUtil.TimeUnit
- queryApi() - Method in interface PublicGroovyAPI
- queryBuilderState - Variable in class AbstractChartBuilder
- QUOTE - Enum constant in enum class CalculationResultType
- QuoteBuilder - Class in net.pricefx.common.apibuilder.quote
-
QuoteBuilder is the starting point of an interface that allows you to manipulate a quote object in a quote header calculation logic.
The header calculation is executed twice: Once before the calculation of the individual line items (= pre phase) and once after that (=post phase).
Usually code should only apply in one phase. - 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
- QuoteLineItem - Class in net.pricefx.domain
- QuoteLineItem() - Constructor for class QuoteLineItem
- QuoteLineItem(Product) - Constructor for class QuoteLineItem
- QuoteStructure - Class in net.pricefx.common.apibuilder.quote
-
This is a helper object that is used to build up the 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.
- QUOTETYPE - Enum constant in enum class InputType
R
- RABuilder(RATBuilder) - Constructor for class RATBuilder.RABuilder
- RADIO - Enum constant in enum class InputType
- random() - Method in interface PublicGroovyAPI
-
Provides access to the standard
java.util.Random
generator instance created for the duration of the calculation task (= not get re-created for each logic element evaluation). - RANGE - Enum constant in enum class LookupTable.LookupTableType
- RANGE - Enum constant in enum class Matrix2D.BucketNaming
- RANGE_PCT - Enum constant in enum class Matrix2D.BucketNaming
- RANGED - Enum constant in enum class ColorAxisType
- 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
- rContext() - Method in interface ModelFormulaContextReadOnly
- RContext - Interface in net.pricefx.formulaengine.scripting
- readSingleValue(String) - Method in class WorkflowDTO.StepDTO
- READY - Enum constant in enum class CalculationStatus
-
Computed.
- REAL - Enum constant in enum class LookupTable.LookupTableValueType
- reasons - Variable in class WorkflowInfo.WorkflowStepInfo
- REBATEAGREEMENT - Enum constant in enum class CalculationResultType
- REBATEAGREEMENT - Enum constant in enum class InputType
- RebateAgreementBuilder - Class in net.pricefx.common.apibuilder.rebateagreement
-
IMPORTANT: Please read super class notes on sequence of execution!
- RebateAgreementHelper - Class in net.pricefx.common.apibuilder.rebateagreement
- RebateAgreementHelper(Map<String, Object>) - Constructor for class RebateAgreementHelper
- RebateAgreementLineItem - Class in net.pricefx.domain
- RebateAgreementLineItem() - Constructor for class RebateAgreementLineItem
- RebateAgreementLineItem(RebateType) - Constructor for class RebateAgreementLineItem
- RebateAgreementStatus - Enum Class in net.pricefx.common.api
- RebateAgreementStructure - Class in net.pricefx.common.apibuilder.rebateagreement
-
This is a helper object that is used to build up code-generated content of a Rebate Agreement.
- RebateAgreementStructure() - Constructor for class RebateAgreementStructure
- rebateAgreementUserEntry(String, String) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createRebateAgreement(String)
instead. - REBATERECORD - Enum constant in enum class CalculationResultType
- RebateRecordAction<T> - Class in net.pricefx.common.apibuilder.calculationflowaction
-
This action starts calculation of selected rebate record set records.
- RebateRecordAction(T, Invocations<MethodInvocationRecord>, String) - Constructor for class RebateRecordAction
- RebateRecordSet - Class in net.pricefx.domain
- RebateRecordSet() - Constructor for class RebateRecordSet
- RebateRecordSet(String, Partition) - Constructor for class RebateRecordSet
- RebateRecordStatus - Enum Class in net.pricefx.common.api
- RecalculateApi(FormulaEngineContext, Long, CustomFormService, CustomFormServiceProperties) - Constructor for class CustomFormApi.RecalculateApi
- recalculatePriceGridItems(Long, String...) - Method in interface PublicGroovyAPI
-
Initiates the PriceGridItems / MatrixPriceGridItems recalculation for the specified productIds without creating a background job.
- recalculation() - Method in class CustomFormApi.OperationsApi
-
Initiates a recalculation operation.
- reconstructFromMap(Map<String, ?>) - Static method in class Filter
- RED - Enum constant in enum class AuxLineColor
- 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 results to customers that are linked to the given related object (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 (defined by its typedId).
- Release Notes - Search tag in Overview
- Section
- remove(Filter) - Method in class Filter
-
Used with OP_OR and OP_AND filters.
- removeInputWithTrackedContent(String) - Method in class ConfiguratorEntry
-
Methods support removal of input from ConfiguratorsEntry (including all hidden inputs supporting value tracking) Input must exist and value tracking turn on.
- removeKV(String, Map<String, Object>) - Method in interface PublicGroovyAPI
-
Removes a single value ('payload') based on the primary key match.
- removeManualOverride(String) - Method in interface PublicGroovyAPI
-
Removes a user entered value that overrides the calculated result of a logic element.
- removeManualOverrideValueOptions() - Method in class AttributedResult
-
In case the result element is overridable, this method clears a set (list) of values defined with above withManualOverrideValueOptions method IMPORTANT NOTE: This is implemented only for Pricelists, PriceGrids and CalculationGrids.
- removePricegridCalculationOutput(Long, String) - Method in interface PublicGroovyAPI
-
Removes the PG calculation output.
- removePricegridInputAttribute(Long) - Method in interface PublicGroovyAPI
-
Deletes a price grid input attribute.
- removePricelistCalculationOutput(Long, String) - Method in interface PublicGroovyAPI
-
Removes the PL calculation output.
- removePricelistInputAttribute(Long) - Method in interface PublicGroovyAPI
-
Deletes a price list input attribute.
- removeSharedCache(String) - Method in interface PublicGroovyAPI
-
Deletes a key from the shared cache.
- removeStep(String) - Method in class WorkflowDTO
-
Removes a workflow step with given unique name (if it exists).
- removeValue(String) - Method in class Customer
- 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).
- renameSoftDeleted(PersistedObjectService) - Method in class User
- 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.
- reset() - Method in interface DatamartRowSet
-
Resets the current row index of this
DatamartRowSet
. - RESET - Enum constant in enum class InputButtonAction
- resetCurrentItemFields(String...) - Method in interface PublicGroovyAPI
-
Resets specified fields on the currentItem object to null.
- resetCurrentStepTo(int) - Method in class CreationWorkflowDefinition
-
Switches the Creation Workflow to the specified step, ignores what the user clicked in the user interface.
- resetSKUContextSwitch() - Method in interface PublicGroovyAPI
-
Resets an SKU context switch to the originally specified SKU.
- resetWorkflow(PersistedObjectService) - Method in class Pricelist
- resizingEnabled - Variable in class AbstractChartBuilder
- resolveExpression(String, String, String, String) - Static method in class DMField
- resolveFieldName(AbstractCalculableObjectItem, String, String, PersistedObjectService) - Method in class ItemSummaryQuery
- restrictToSkus(List<String>) - Method in class LivePriceGridAction
-
Restricts LPG calculation to a list of specified SKUs.
- RESULT - Enum constant in enum class WaterfallColumnType
- 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.
- ResultHighchart.OnPointClick - Interface in net.pricefx.server.dto.calculation
- ResultHighchart.TriggerEvent - Interface in net.pricefx.server.dto.calculation
- 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
-
Deprecated.Please import
ResultMatrix
- ResultMatrix - Interface in net.pricefx.formulaengine.scripting.portlets
-
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
-
Deprecated.better use the shorter
PublicGroovyAPI.newMatrix()
- ResultMatrix(String...) - Constructor for class ResultMatrix
-
Deprecated.better use the shorter
PublicGroovyAPI.newMatrix(String...)
- ResultMatrix(Collection<String>) - Constructor for class ResultMatrix
-
Deprecated.better use the shorter
PublicGroovyAPI.newMatrix(Collection)
- ResultMatrix(Map<?, ?>) - Constructor for class ResultMatrix
-
Deprecated.better use the shorter
PublicGroovyAPI.newMatrix()
- ResultMatrix(ResultMatrix) - Constructor for class ResultMatrix
-
Deprecated.
- RESULTMATRIX_MAXROWS - Static variable in interface DatamartRowSet
- ResultMatrix.AbstractResultMatrixCell - Class in net.pricefx.server.dto.calculation
-
Deprecated.better use the shorter
ResultMatrix.Cell
- ResultMatrix.BackEndAction - Interface in net.pricefx.formulaengine.scripting.portlets
-
Object representing a button that handles multi-row actions.
- ResultMatrix.BackEndAction - Interface in net.pricefx.server.dto.calculation
-
Deprecated.
- ResultMatrix.BackEndCell - Interface in net.pricefx.formulaengine.scripting.portlets
-
Create a link/button that should do some desired action to pricefx backend (unity only) [url:"pricelistmanager.revoke..../...", payload: [... : ...], successMessage: "hey, it is ok!"
- ResultMatrix.BackEndCell - Interface in net.pricefx.server.dto.calculation
-
Deprecated.
- ResultMatrix.Cell - Interface in net.pricefx.formulaengine.scripting.portlets
- ResultMatrix.Cell - Interface in net.pricefx.server.dto.calculation
-
Deprecated.
- ResultMatrix.Cells - Interface in net.pricefx.formulaengine.scripting.portlets
-
List of other cells (to be shown as dropdown inline)
- ResultMatrix.Cells - Interface in net.pricefx.server.dto.calculation
-
Deprecated.
- ResultMatrix.DownloadCell - Interface in net.pricefx.formulaengine.scripting.portlets
-
Create a link/button that should do initiate download from pricefx backend (unity only) [url:"pricelistmanager.fetchpdf..../...", payload: [... : ...]]
- ResultMatrix.DownloadCell - Interface in net.pricefx.server.dto.calculation
-
Deprecated.
- ResultMatrix.ImageCell - Interface in net.pricefx.formulaengine.scripting.portlets
- ResultMatrix.ImageCell - Interface in net.pricefx.server.dto.calculation
-
Deprecated.
- ResultMatrix.LinkButtonCell - Interface in net.pricefx.formulaengine.scripting.portlets
- ResultMatrix.LinkCell - Interface in net.pricefx.formulaengine.scripting.portlets
- ResultMatrix.LinkCell - Interface in net.pricefx.server.dto.calculation
-
Deprecated.
- ResultMatrix.OnRowSelection - Interface in net.pricefx.formulaengine.scripting.portlets
- ResultMatrix.OnRowSelection - Interface in net.pricefx.server.dto.calculation
-
Deprecated.
- ResultMatrix.OnRowSelection.TriggerEvent - Interface in net.pricefx.formulaengine.scripting.portlets
- ResultMatrix.ResultMatrixBackEndAction - Class in net.pricefx.server.dto.calculation
-
Deprecated.better use the shorter
ResultMatrix.BackEndAction
- ResultMatrix.ResultMatrixBackEndCell - Class in net.pricefx.server.dto.calculation
-
Deprecated.better use the shorter
ResultMatrix.BackEndCell
- ResultMatrix.ResultMatrixCells - Class in net.pricefx.server.dto.calculation
-
Deprecated.better use the shorter
ResultMatrix.Cells
- ResultMatrix.ResultMatrixDownloadCell - Class in net.pricefx.server.dto.calculation
-
Deprecated.better use the shorter
ResultMatrix.DownloadCell
- ResultMatrix.ResultMatrixImageCell - Class in net.pricefx.server.dto.calculation
-
Deprecated.better use the shorter
ResultMatrix.ImageCell
- ResultMatrix.ResultMatrixLinkCell - Class in net.pricefx.server.dto.calculation
-
Deprecated.better use the shorter
ResultMatrix.LinkCell
- ResultMatrix.ResultMatrixOnRowSelection - Class in net.pricefx.server.dto.calculation
-
Deprecated.better use the shorter
ResultMatrix.OnRowSelection
- ResultMatrix.ResultMatrixOnRowSelection.ResultMatrixTriggerEvent - Class in net.pricefx.server.dto.calculation
-
Deprecated.
- ResultMatrix.ResultMatrixStyledCell - Class in net.pricefx.server.dto.calculation
-
Deprecated.better use the shorter
ResultMatrix.StyledCell
- ResultMatrix.StyledCell - Interface in net.pricefx.formulaengine.scripting.portlets
- ResultMatrix.StyledCell - Interface in net.pricefx.server.dto.calculation
-
Deprecated.
- ResultMatrixBackEndCell() - Constructor for class ResultMatrix.ResultMatrixBackEndCell
-
Deprecated.
- ResultMatrixCells() - Constructor for class ResultMatrix.ResultMatrixCells
-
Deprecated.
- ResultMatrixDownloadCell() - Constructor for class ResultMatrix.ResultMatrixDownloadCell
-
Deprecated.
- RESULTMATRIXFILTER - Enum constant in enum class InputType
- ResultMatrixFilterBuilder - Class in net.pricefx.formulaengine.scripting.inputbuilder
- ResultMatrixFilterBuilder(InputBuilderContext, String, ResultMatrix) - Constructor for class ResultMatrixFilterBuilder
- ResultMatrixImageCell() - Constructor for class ResultMatrix.ResultMatrixImageCell
-
Deprecated.
- ResultMatrixLinkCell() - Constructor for class ResultMatrix.ResultMatrixLinkCell
-
Deprecated.
- ResultMatrixLinkCell(Object, String, Object) - Constructor for class ResultMatrix.ResultMatrixLinkCell
-
Deprecated.
- ResultMatrixOnRowSelection() - Constructor for class ResultMatrix.ResultMatrixOnRowSelection
-
Deprecated.
- ResultMatrixStyledCell() - Constructor for class ResultMatrix.ResultMatrixStyledCell
-
Deprecated.
- ResultMatrixTriggerEvent(HashMap<String, String>) - Constructor for class ResultMatrix.ResultMatrixOnRowSelection.ResultMatrixTriggerEvent
-
Deprecated.
- RESULTS - Static variable in class ModelEvaluator
- revoke() - Method in class CustomFormApi.DocumentActionApi
-
Finishes the revoke operation.
- REVOKED - Enum constant in enum class RebateAgreementStatus
- REVOKED - Enum constant in enum class RebateRecordStatus
- REVOKED - Enum constant in enum class AttachedDocument.DocumentStatus
- RM_DETAILS_PAGE - Static variable in interface AppPages
-
RebateManager module -
targetPageState
optionaltypedId
for specific RebateAgreement details - RM_MAIN_PAGE - Static variable in interface AppPages
-
RebateManager module
- RM_NEW_REBATE_AGREEMENT - Static variable in interface AppPages
-
RebateManager module -
targetPageState
- RM_RECORDS_PAGE - Static variable in interface AppPages
-
RebateManager module -
targetPageState
optionaltypedId
for specific RebateRecord details - RM_TEMPLATES_PAGE - Static variable in interface AppPages
-
RebateManager module
- roles() - Method in interface PublicGroovyAPI
-
Lists all roles available in the application.
- root - Variable in class LineItemHelper
- ROOT_ENTITY - Static variable in class Filter
-
Property string representing the root entity of the search.
- ROOT_LINE_ID - Static variable in class CalculableLineItemCollectionBuilder
- ROW - Enum constant in enum class LimitType
- ROW - Enum constant in enum class InputType
- RowClickTriggerEvent(String) - Constructor for class ChartEvents.OnRowClick.RowClickTriggerEvent
- RowInputBuilder<T> - Class in net.pricefx.formulaengine.scripting.inputbuilder
- RowInputBuilder(InputBuilderContext, String) - Constructor for class RowInputBuilder
- rowSelectionBackEndAction(String) - Method in interface ResultMatrix
-
Allows UI users to select multiple rows and adds an action button next to the ResultMatrix.
- rowSelectionBackEndAction(String) - Method in class ResultMatrix
-
Deprecated.
- 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
- saveBigDecimalValue(String, BigDecimal) - Method in class Customer
- saveDateTimeValue(String, DateTime) - Method in class Customer
- saveDateValue(String, Date) - Method in class Customer
- saveIntegerValue(String, Integer) - Method in class Customer
- saveStringValue(String, String) - Method in class Customer
- SC_ACCRUAL_RECORDS_PAGE - Static variable in interface AppPages
-
Accrual Records page
- SC_CALCULATIONS_PAGE - Static variable in interface AppPages
-
Calculations page
- SC_COMPENSATION_RECORDS_PAGE - Static variable in interface AppPages
-
Compensation Records page
- SC_COMPENSATION_TYPES_PAGE - Static variable in interface AppPages
-
Compensation Types page
- SC_CONDITION_TYPES_PAGE - Static variable in interface AppPages
-
Compensation Types page
- SC_NEW_PLAN - Static variable in interface AppPages
-
Sales compensation module -
targetPageState
- SC_PLANS_PAGE - Static variable in interface AppPages
-
Compensation Plans page
- SCATTER - Enum constant in enum class ChartType
- SCATTER - Enum constant in enum class SeriesType
- 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 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
- schedule(String) - Method in interface ModelSchedulesContextReadOnly
- SCHEDULED - Enum constant in enum class CalculationStatus
-
Scheduled for the execution e.g., computation is wrapped in the task and is handed to the system for the future execution in background process.
- SCHEDULED_DIRTY - Enum constant in enum class CalculationStatus
-
Scheduled for a 2nd pass to calculate dirty items.
- schedules() - Method in interface ModelSchedulesContextReadOnly
- schedulesContext() - Method in interface ModelFormulaContextReadOnly
- schedulesContext() - Method in interface ModelFormulaContextReadWrite
- ScheduleSettings<T> - 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(T, 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(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 interface DatamartContext.Query
-
Adds a projection to the query.
- select(String) - Method in class TableContext
-
Deprecated.
- select(String, String) - Method in interface DatamartContext.Query
-
Adds a projection to the query.
- select(String, String, String...) - Method in interface DatamartContext.Query
- selectAll() - Method in interface DatamartContext.Query
-
Returns all columns.
Note: If the rollup is set to true (see theDatamartContext.newQuery(Table)
), then only columns matching the rollup aggregation will be returned. - selectAll(boolean) - Method in interface DatamartContext.Query
- 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.
- 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.
- 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.
- selectId(String) - Method in interface DatamartContext.Query
-
Projects the internal id of a row.
- 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[]) - 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, 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.
- self() - Method in class AbstractInputBuilder
- seller(String) - Method in interface PublicGroovyAPI
-
Retrieves the given attribute value from the Sellers table for the seller selected by the user in the input parameter "Seller".
- seller(String, String) - Method in interface PublicGroovyAPI
-
Retrieves the given attribute value from the Sellers table for the given seller.
- seller(String, String, String, Object) - Method in interface PublicGroovyAPI
-
Retrieves the given attribute value from the seller table for a given sellerId.
- SELLER - Enum constant in enum class InputType
- SELLER_EXTENSIONS_PAGE - Static variable in interface AppPages
-
Seller Extensions page
- SellerGroup - Class in net.pricefx.domain
-
SellerGroup
- SellerGroup() - Constructor for class SellerGroup
- SELLERGROUP - Enum constant in enum class InputType
- sellerGroupEntry(String...) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createSellerGroupEntry(String)
instead. - sellerGroupEntry(String, String, Object) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createSellerGroupEntry(String)
instead. - SellerInputBuilder - Class in net.pricefx.formulaengine.scripting.inputbuilder
-
Builder class for input type Seller
InputType.SELLER
. - SellerInputBuilder(InputBuilderContext, String) - Constructor for class SellerInputBuilder
- SELLERS_PAGE - Static variable in interface AppPages
-
Sellers page
- sellerToRelatedObjectsFilter(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 has a link to the given seller.
- send() - Method in interface NotificationApi
-
Validates currently configured Notification and sends it to Notification center if valid.
- sendEmail(String, String, String) - Method in interface PublicGroovyAPI
-
Sends an email.
- sendEmail(String, String, String, String, String, String, String, String, Boolean) - Method in interface PublicGroovyAPI
-
Sends an email.
- sendPlatformNotification(String, String) - Method in interface PublicGroovyAPI
-
Sends a notification to Platform for further message routing.
- serialize(Object) - Method in enum class DataType
- SeriesType - Enum Class in net.pricefx.common.api.chart
- set(String, String, Map<?, ?>...) - Method in interface IRebateRecordManager
-
Sets fields of the Rebate Record (RR) / Compensation Record (COR) in the specified Rebate Record Set.
- set(String, Map<?, ?>...) - Method in interface IRebateRecordManager
-
Sets fields of the Rebate Record (RR) / Compensation Record (COR) with the specified name.
- set(Map<?, ?>...) - Method in interface IRebateRecordManager
-
Sets fields of the Rebate Record (RR) / Compensation Record (COR) with the default name.
- set(Map<String, ?>) - Method in interface IRebateRecordGroupManager
-
Allows you to set the value of attribute 1..100, or attributeExtension fields for the current
RebateRecordGroup
object. - setAccessCode(String) - Method in class AbstractInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- setAction(String) - Method in interface ModelSchedulesContextReadWrite.NewScheduleBuilder
-
Sets the model action to be executed once at the beginning of each period.
- setActivated(Boolean) - Method in class User
- setAdditionalConfig(Map<String, String>) - Method in class ConfiguratorEntry
-
Sets all the additional configurations at once
- setAdditionalInfo1(BigDecimal) - Method in class CustomerAssignment
- setAdditionalInfo1(BigDecimal) - Method in class User
- setAdditionalInfo1(BigDecimal) - Method in class UserGroup
- setAdditionalInfo2(BigDecimal) - Method in class CustomerAssignment
- setAdditionalInfo2(BigDecimal) - Method in class User
- setAdditionalInfo2(BigDecimal) - Method in class UserGroup
- setAdditionalInfo3(String) - Method in class CustomerAssignment
- setAdditionalInfo3(String) - Method in class User
- setAdditionalInfo3(String) - Method in class UserGroup
- setAdditionalInfo4(String) - Method in class CustomerAssignment
- setAdditionalInfo4(String) - Method in class User
- setAdditionalInfo4(String) - Method in class UserGroup
- 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.
- setAlias(String) - Method in interface DatamartContext.Query
- setAlign(String) - Method in class AbstractInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- setAllowUnknownFunctions(boolean) - Method in interface DatamartContext.SqlQuery
-
Allow to use SQL functions that are not recognized by the validation.
- setAllValueTypesTracking() - Method in class AbstractInputBuilder
-
Enables all types value tracking for a specified
ContextParameter
. - setAlwaysEditable(Boolean) - Method in class AbstractInputBuilder
-
Sets the input field as always editable.
Always editable input fields are supported in Unity UI only (not supported in Classic UI).
Enables a user to update the input field after the Quote, Contract, or Rebate Agreement have been submitted. - setAlwaysEditable(Boolean) - Method in class ContextParameter
- setAppearance(String) - Method in class AbstractInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- setApprovalDate(LocalDateTime) - Method in class Pricelist
- setApprovalDate(Date) - Method in class SummaryCalculableObjectItem
- setApprovalState(Number) - Method in class SummaryCalculableObjectItem
- setApprovalState(ApprovalState) - Method in class PriceGrid
- setApprovalState(ApprovalState) - Method in class Pricelist
- setApprovedByName(String) - Method in class AttachedDocument
- setApprovedByName(String) - Method in class Pricelist
- setAssignedTo(Long) - Method in class ActionItemApi.ActionItemBuilder
-
Assigns the Action Item to the user (specified by Id).
- setAssignment(String) - Method in class CustomerAssignment
- setAssignmentId(Long) - Method in class CustomerAssignment
- setAssignmentType(String) - Method in class CustomerAssignment
- setAttached(boolean) - Method in class AttachedDocument
- setAttribute(String, Object) - Method in class AttributedResult
- setAttributeExtension(Map<String, Object>) - Method in class ActionItemApi.ActionItemBuilder
-
Adds a custom
attributeExtension___key:value
field to the ActionItem or replaces an existing one – performs a full replacement of theattributeExtension
map (does not update specific keys or values). - setAttributeExtension(Map<String, Object>) - Method in class CustomFormApi.CustomFormBuilder
-
Adds a custom
attributeExtension___key:value
field to the CustomForm. - setAttributeExtension(Map<String, Object>) - Method in class CustomFormApi.UpdateApi
-
Adds a custom
attributeExtension___key:value
field to the CustomForm or replaces an existing one – performs a full replacement of theattributeExtension
map (does not update specific keys or values). - setAttributeExtensionValue(String, Object) - Method in class ActionItemApi.ActionItemBuilder
-
Updates the value of an existing
attributeExtension___key:value
field or creates a new one. - setAttributeExtensionValue(String, Object) - Method in class CustomFormApi.CustomFormBuilder
-
Updates the value of an existing
attributeExtension___key:value
field or creates a new one. - setAttributeExtensionValue(String, Object) - Method in class CustomFormApi.UpdateApi
-
Updates the value of an existing
attributeExtension___key:value
field or creates a new one. - setAttributeName(String) - Method in class AbstractProductAndCustomerInputBuilder
-
Sets the attribute name.
- setAttributeName(String) - Method in class VLookupBuilder
-
Sets a new attribute for the VLookupBuilder instance.
- setAttributeNames(List<String>) - Method in class VLookupBuilder
-
Sets new list of the attributes for the VLookupBuilder instance.
- setAttributeValue(String, Object) - Method in class ActionItemApi.ActionItemBuilder
-
Sets the value of the specified 'attributeXX' column of the ActionItem class.
Example: - setAttributeValue(String, Object) - Method in class CustomFormApi.CustomFormBuilder
-
Sets the value of the specified 'attributeXX' column of the CustomForm class.
Example: - setAttributeValue(String, Object) - Method in class CustomFormApi.UpdateApi
-
Updates the value of the specified 'attributeXX' column of the CustomForm class.
Example: - setAutoComplete(boolean) - Method in class AbstractInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- setAutoFocus(boolean) - Method in class AbstractInputBuilder
-
If this is set to true, browser scrolls to the element when the page is loaded and automatically focuses it (places a cursor into the input field).
On the given page the autofocus should be placed in only one input. - 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
- setBaseCO(String) - Method in class Simulation
- setBaseCOType(MatrixableCalculableObject.ListType) - Method in class Simulation
- setBasePriceGridId(Long) - Method in class Simulation
- setBasePricelistId(Long) - Method in class Simulation
- 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
- setBusinessRoles(List<BusinessRole>) - Method in class User
- 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 ModelCalculationAction
-
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.
- setCalculatedBaseTypedId(String) - Method in class Simulation
- setCalculatedFieldSetConfiguration(CalculatedFieldSetConfiguration) - Method in class CalculatedFieldSet
- setCanModifyRows(boolean) - Method in class InputMatrixInputBuilder
-
When set to
false
a user will not be able to add or remove rows in the input matrix table. - setCaption(String) - Method in class AbstractInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- setCastCallback(ItemSummaryQuery.QueryGeneratorCallback) - Method in class ItemSummaryQuery
- setCategories(String) - Method in class PieChart.PieSeries
- setCcyField(String) - Method in class DMField
- setClearMissingInDM(boolean) - Method in class DMFieldInputBuilder
-
Sets the property that clears an unavailable value from the
DMField
user input (a drop-down menu). - setCollapsed(Boolean) - Method in class CollapseInputBuilder
-
Specifies whether the collapse element in the UI will be shown closed (collapsed).
- 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
- setColumnar(Boolean) - Method in class DMTable
- setColumnFormat(String, FieldFormatType) - Method in interface ResultMatrix
-
Sets a column format for a specified column.
- setColumns(List<?>) - Method in class InputMatrixInputBuilder
- setColumns(List<Map>) - Method in class ConfiguratorTableInputBuilder
-
Adds specified columns to the Configurator table.
- setColumnTooltip(String, String) - Method in interface ResultMatrix
-
Adds a tooltip to a column
- setColumnValueOptions(Map) - Method in class InputMatrixInputBuilder
-
Sets column value options.
- setComments(String) - Method in class SummaryCalculableObjectItem
- 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
- setComparisonType(ComparisonType) - Method in class DetailedTimeSeriesChart.DetailedTimeSeriesOptions
- setConfigParameter(String, Object) - Method in class ContextParameter
-
Adds an additional configuration parameter/option to the input – a
parameterConfig
property. - setConfiguration(String) - Method in class CalculatedFieldSet
- setConfiguration(String) - Method in class Pricelist
- setConfigurationString(String) - Method in class PriceGrid
- setConfigValues(List<String>) - Method in class AbstractInputBuilder
-
Adds values to the input field (parameter).
- setContext(FormulaEngineContext) - Method in class ConfiguratorEntry
-
Sets the FormulaEngineContext.
- setCreatedByName(String) - Method in class AttachedDocument
- setCreatedByName(String) - Method in class CustomerAssignment
- setCreatedByName(String) - Method in class LookupTable
- setCreatedByName(String) - Method in class ManualPricelist
- setCreatedByName(String) - Method in class PriceGrid
- setCreatedByName(String) - Method in class Pricelist
- setCurrency(String) - Method in class AbstractChartSeries
- setCustomAttributeName(String) - Method in class AbstractInputBuilder
-
Creates the custom name data attribute in the form's HTML.
Must be used together withAbstractInputBuilder.setCustomAttributeValue(String)
. - setCustomAttributeValue(String) - Method in class AbstractInputBuilder
-
Creates the custom value data attribute in the form's HTML.
Must be used together withAbstractInputBuilder.setCustomAttributeName(String)
. - setCustomerFieldLabel(String) - Method in class CustomerGroup
-
Sets a field label value of the CustomerGroup object.
Example: - setCustomerFieldName(String) - Method in class CustomerGroup
-
Sets a field name value of the CustomerGroup object.
Example: - setCustomerFieldValue(String) - Method in class CustomerGroup
-
Sets a field value of the CustomerGroup object.
Example: - setCustomerFilterCriteria(String) - Method in class User
- setCustomerFilterCriteria(Map<String, Object>) - Method in class CustomerGroup
-
Sets the filter criteria from a map of filters for the CustomerGroup.
Example: - setCustomerFilterCriteriaJson(String) - Method in class CustomerGroup
-
Sets the filter criteria from a JSON filter for the CustomerGroup.
Example: - setCustomerGroup(CustomerGroup) - Method in class CustomerAssignment
- setCustomerId(String) - Method in class Customer
- setDataHeaders(String...) - Method in class ResultHighchart
-
To override the default column headers of the data tab table.
- setDatamart(String) - Method in class AbstractChartSeries
- setDataType(String) - Method in class SimpleInputBuilder
-
Sets the data type of the input field.
Possible values: text, float, integer, date, time, datetime, product, customer - setDateFieldName(String) - Method in class DMDataSlice
- setDbColumn(String) - Method in class DMField
- setDbTable(String) - Method in class DMField
- setDebugRow(Map<String, Object>) - Method in interface ClaimContext
-
Set row for formula testdrive
- setDecimalPlaces(String) - Method in class SimpleInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- setDefaultFormat(FieldFormatType) - Method in interface ResultMatrix
-
Sets a default column format
- setDefaultFromParent(Boolean) - Method in class CustomerInputBuilder
-
Sets default from the parent flag of the CustomerInputBuilder.
- setDefaultFromParent(Boolean) - Method in class SellerInputBuilder
-
Sets default from the parent flag of the SellerInputBuilder.
- setDefaultHeight(int) - Method in class ConfiguratorTableInputBuilder
-
Sets the maximum table height.
- setDefaultHeight(int) - Method in class InputMatrixInputBuilder
-
Sets the maximum input matrix table height.
- setDefaultUserGroupEdit(String) - Method in class User
- setDefaultUserGroupViewDetails(String) - Method in class User
- setDefaultValue(Object) - Method in class DMField
- setDefaultValue(BigDecimal) - Method in class Expression
- setDefaultValues(Map<String, Object>) - Method in interface DatamartRowSet
-
Set default values to be used when creating new rows.
- setDefaultValueTracking(boolean) - Method in class AbstractInputBuilder
-
Enables or disables tracking of the default value for a specified
ContextParameter
within the ConfiguratorEntry.
Default value tracking allows you to detect whether an input retains its original default value or if it has been changed by the user or programmatically. - setDefaultWidth(AbstractInputBuilder.InputWidth) - Method in class AbstractInputBuilder
-
Sets the default width of the widget.
- setDeniedByName(String) - Method in class AttachedDocument
- setDeniedByName(String) - Method in class Pricelist
- setDependencies(String) - Method in class DMField
- setDescription(String) - Method in class Expression
- setDescription(String) - Method in class PriceGrid
- setDescription(String) - Method in class Pricelist
- setDescription(String) - Method in class ActionItemApi.ActionItemBuilder
-
Sets the description of the Action Item (AI).
- setDimensions(String, String) - Method in class ConfiguratorInputBuilder
-
Sets particular dimensions for the Configurator (value options table)
- setDimensions(String, String) - Method in class ConfiguratorTableInputBuilder
-
Sets particular dimensions of the modal dialog (Configurator) that is opened when a user clicks the Add button below the ConfiguratorTable.
- setDisabled(boolean) - Method in class AbstractInputBuilder
-
Hides the input from the user interface.
- 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
- setDisableGridDiscretization(boolean) - Method in class ScatterChart.ScatterOptions
- setDisablePreferences(boolean) - Method in interface ResultMatrix
-
Allows to disable saving preferences of the matrix grid (columns, sorting, filtering).
- setDisableRowSelection(boolean) - Method in class InputMatrixInputBuilder
-
Manage the row selection visibility
- setDisableSorting(boolean) - Method in interface 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
- setDiscretization(boolean) - Method in class ScatterChart.ScatterOptions
- setDisplayMode(String) - Method in class AbstractInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- 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.
- setDmSourceName(String) - Method in class DMFieldInputBuilder
-
Configure DataSource (DS) or Datamart (DM) name.
- setDmSourceName(String) - Method in class DmFilterBuilder
-
Configure DataSource (DS) or Datamart (DM) name.
- setDoCount(boolean) - Method in class ItemSummaryQuery
- setDrilldownResultMatrixTabs(String, ResultMatrix...) - Method in class ResultHighchart
-
At least one ResultMatrix is expected for each drilldown series in a chart.
- setDueDate(Date) - Method in class ActionItemApi.ActionItemBuilder
-
Sets the due date of the Action Item (AI).
- setEmail(String) - Method in class User
- setEmailLocale(String) - Method in class User
- setEnableAdvancedFilter(boolean) - Method in class ConfiguratorTableInputBuilder
-
Allows you to enable or disable the advanced filter functionality.
- setEnableAdvancedFilter(boolean) - Method in class InputMatrixInputBuilder
-
Enabling the advanced filter functionality.
- setEnableClientFilter(boolean) - Method in class ConfiguratorTableInputBuilder
-
Allows a user to filter the table by row values.
Default =true
(the filtering is enabled). - setEnableClientFilter(boolean) - Method in class InputMatrixInputBuilder
-
Allows a user to filter the table by row values.
Default =true
(the filtering is enabled). - setEnableClientFilter(boolean) - Method in interface ResultMatrix
- setEntity(DMEntityMap.DMEntity) - Method in class DMField
- setEntries(List<ConfiguratorEntry>) - Method in class ConfiguratorEntryArray
- setErrorMessage(String) - Method in class AbstractInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- setErrorMode(Pricelist.PricelistErrorModeType) - Method in class Pricelist
- setEscapeHTML(boolean) - Method in interface ResultMatrix
-
Set HTML escaping flag.
- setExecuteOnError(boolean) - Method in class ChainedJobInfo
-
Should this job be executed even if the previous job failed?
- setExistAsTmpOnly(boolean) - Method in class QuoteLineItem
- setExpiryDate(LocalDateTime) - Method in class ManualPricelist
- setExpiryDate(LocalDateTime) - Method in class Pricelist
- setExpiryDate(Date) - Method in class SummaryCalculableObjectItem
- setExportable(boolean) - Method in class AbstractInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- setExportDate(LocalDateTime) - Method in class Pricelist
- setExpression(String) - Method in class Expression
- setExpression(String) - Method in class DMField
- setExtendedData(Map<String, Object>) - Method in class User
- setFieldKinds(Collection<DMFieldInputBuilder.FieldKind>) - Method in class DMFieldInputBuilder
-
Sets the kind of fields to be displayed in the drop-down list.
- setFieldKinds(DMFieldInputBuilder.FieldKind...) - Method in class DMFieldInputBuilder
- setFieldTypes(Collection<FieldType>) - Method in class DMFieldInputBuilder
-
Sets the types of fields to be displayed in the drop-down list.
- setFieldTypes(FieldType...) - Method in class DMFieldInputBuilder
- setFilter(Filter) - Method in class DashboardPopupInputBuilder
- setFilter(Object) - Method in class ObjRefAction
- setFilter(Map<String, Object>) - Method in class ContextParameter
- setFilterFormulaName(String) - Method in class AbstractProductAndCustomerInputBuilder
-
Sets a filter logic.
Specifies which filter logic should be used to filter customers, products, or sellers by. - setFilterFormulaParam(String) - Method in class AbstractProductAndCustomerInputBuilder
-
Sets a filter logic parameter.
- setFilters(Filter...) - Method in class ContextParameter
- setFilters(Object...) - Method in class DmFilterBuilder
-
Set
DmFilterBuilder
filters Example: - setFinal(boolean) - Method in class AttachedDocument
- setFirstName(String) - Method in class User
- setFirstRunTracking(boolean) - Method in class AbstractInputBuilder
-
Enables or disables tracking of the input's first run for a specified
ContextParameter
within the ConfiguratorEntry.
First run tracking allows to detect whether an input was initialized (run for the first time). - setFitFieldWidths(boolean) - Method in class ConfiguratorTableInputBuilder
-
Sets whether fields (table cells) should autofit widths to title texts or the content.
- setFitFieldWidths(boolean) - Method in class InputMatrixInputBuilder
-
Sets whether fields (table cells) should autofit widths to title texts or the content.
- setFixTableHeight(boolean) - Method in class ConfiguratorTableInputBuilder
-
Allows setting the table height using the
ConfiguratorTableInputBuilder.setDefaultHeight(int)
method.
Default =false
- setFixTableHeight(boolean) - Method in class InputMatrixInputBuilder
-
Set to
true
to limit the input matrix table height by the DefaultHeight. - setFlex(int) - Method in class AbstractInputBuilder
-
When more input fields are placed side by side (using the row layout, via RowInputBuilder), the "flex" value sets how much space should this input field occupy (proportionally) with respect to the other inputs on the same row.
- setFlexChart(Object) - Method in class ResultFlexChart
- setFormat(String) - Method in class DMField
- setFormattingOption(String, Object) - Method in class ContextParameter
-
Sets (adds or updates) a formatting option (how the input field is displayed) within the formattingOptions map.
- setFormattingOptions(Map<String, Object>) - Method in class ContextParameter
-
Allows you to set desired formatting options of the input field as a map.
- setFormatType(String) - Method in class SimpleInputBuilder
-
Sets the format type of the input field.
Possible values: COMPLEX, DATE, DATETIME, INTEGER, LINK, MONEY, MONEY_CHF, MONEY_EUR, MONEY_GBP, MONEY_JPY, MONEY_PLN, MONEY_USD, NUMERIC, NUMERIC_LONG, PERCENT, SPARKLINE, TEXT
Example: - setFormatType(FieldFormatType) - Method in class LookupTable
- setFormula() - Method in class AbstractChartSeries
- setFormulaElement(String) - Method in class DMField
- setFormulaName(String) - Method in class Formula
- setFrom(Float) - Method in class SimpleInputBuilder
-
Sets the minimum allowed value for the input field.
- setFrom(String) - Method in class DateRangeInputBuilder
-
Sets the from value of the date range input field.
- setFrom(BigDecimal) - Method in class SliderInputBuilder
-
Sets the lower bound of the slider range.
- setFrom(Date) - Method in class SimpleInputBuilder
-
Sets the minimum allowed date value for the input field.
- setFromDate(Date) - Method in class TimeSeriesChart.TimeSeriesSeries
- setFunction(DMExpression.DMFunction) - Method in class DMField
- setFunctionalType(FieldFunction) - Method in class DMField
- setGeneratedQueryDto(String) - Method in class AbstractChartSeries
- setGroup(String, String) - Method in interface IRebateRecordManager
-
Assigns the rebate record specified by rebateRecordName to the rebate record group specified by groupName.
- setGroup(String, String, String) - Method in interface IRebateRecordManager
-
Assigns the rebate record specified by rebateRecordName and recordSetLabel to the rebate record group specified by groupName.
- setGroups(List<UserGroup>) - Method in class User
- setHasCriticalAlert(Boolean) - Method in class Pricelist
- setHeaderType(PriceListTypeOnly) - Method in class Pricelist
- setHeaderTypeUniqueName(String) - Method in class PriceGrid
- setHelpLink(String) - Method in class AbstractInputBuilder
-
Displays a question mark icon next to the field label and displays the "Learn more" link when a user hovers the mouse over the icon.
- setHelpText(String) - Method in class AbstractInputBuilder
-
Displays a question mark icon next to the input field label and displays the specified
helpText
when a user hovers the mouse over this icon. - setHiddenActions(InputButtonAction...) - Method in class ConfiguratorEntry
-
Hides all or specified buttons from the pop-up Configurator.
- setHiddenColumns(List<String>) - Method in class InputMatrixInputBuilder
-
Allow for particular columns to be hidden in the input matrix table.
- setHideAddButton(boolean) - Method in class InputMatrixInputBuilder
-
Hides the "Add" button.
- 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
- setHideDeleteButton(boolean) - Method in class InputMatrixInputBuilder
-
Deprecated.Use
InputMatrixInputBuilder.setHideRemoveButton(boolean)
instead. - setHideLegend(Boolean) - Method in class AbstractChartOptions
- setHideLegend(Boolean) - Method in class ChartOptions.Basic
- setHideOther(Boolean) - Method in class AbstractChartSeries
- setHideOther(Boolean) - Method in class BarLineChart.BarLineSeries
- setHideOther(Boolean) - Method in class BubbleChart.BubbleSeries
- setHideOther(Boolean) - Method in class PieChart.PieSeries
- setHideRemoveButton(boolean) - Method in class InputMatrixInputBuilder
-
Hides the "Remove" button.
- setHideTooltips(Boolean) - Method in class AbstractChartOptions
- setHideTooltips(Boolean) - Method in class ChartOptions.Basic
- setHideWarnings(Boolean) - Method in class LookupTable
- setIcon(String) - Method in class AbstractInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- setIconPosition(String) - Method in class AbstractInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- setId(int) - Method in class AbstractChartMeasures
- setId(Number) - Method in class SummaryCalculableObjectItem
- setId(String) - Method in class ItemRecommendation
- setIfNotNull(ContextParameter) - Method in class ContextParameter
-
Copy attributes from the original
ContextParameter
apart from:ContextParameter.name
,ContextParameter.lookupTableId
,ContextParameter.type
,ContextParameter.inputs
andContextParameter.valueHint
- setIgnoreSecKeyFiltering(Boolean) - Method in class Simulation
- setImportable(boolean) - Method in class AbstractInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- setInitialDataGrouping(Boolean) - Method in class DataTableChart.DataTableOptions
- setInputs(List<ContextParameter>) - Method in class ConfiguratorEntry
-
Sets the list of context parameters.
- setInputType(String) - Method in class SimpleInputBuilder
-
Sets the input type of the field.
Example: - setInputValue(String, Object) - Method in class CustomFormApi.UpdateApi
-
Sets the value for an input.
- setIntegrationStatus(String) - Method in class ManualPricelist
- setIntegrationStatus(String) - Method in class PriceGrid
- setIntegrationStatus(String) - Method in class Pricelist
- setInternalExpr(String) - Method in class DMField
- setIsAggregation(boolean) - Method in class DMField
- setIsAuxiliary(Boolean) - Method in class DMField
- setIsCalculated(boolean) - Method in class DMField
- setIsDeployed(Boolean) - Method in class DMField
- setIsDimension(boolean) - Method in class DMField
- setIsDistributionKey(boolean) - Method in class DMField
- setIsKey(boolean) - Method in class DMField
- setIsPartitioningKey(boolean) - Method in class DMField
- setIsPersisted(Boolean) - Method in class DMField
- setIsQueryable(Boolean) - Method in class DMField
- setIsView(boolean) - Method in class Table
- setItemApprovalReason(Map<String, String>) - Method in class Pricelist
- 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
- setJstId(Long) - Method in class Pricelist
- setKey2(String) - Method in class SummaryCalculableObjectItem
- setKeys(Map) - Method in class VLookupBuilder
-
Set Map of keys for the VLookupBuilder instance.
- setLabel(String) - Method in class AbstractChartSeries
- setLabel(String) - Method in class AuxLine
- setLabel(String) - Method in class TrendLine
- setLabel(String) - Method in class CustomerGroup
-
Sets the Customer Group input label.
Example: - setLabel(String) - Method in class DMField
- setLabel(String) - Method in class ProductGroup
-
Sets the new Product Group input label.
Example: - setLabel(String) - Method in class SellerGroup
-
Sets the new Seller Group input label.
Example: - setLabel(String) - Method in class AbstractInputBuilder
-
Sets the specified text as a label of the input field.
- setLabel(String) - Method in class ContextParameter
-
Sets the label of the input parameter to the given text.
- setLabel(String) - Method in class CustomFormApi.CustomFormBuilder
-
Sets the Custom Form label.
Example: - setLabel(String) - Method in class CustomFormApi.UpdateApi
- setLabel(String) - Method in class ProductReferenceRecord
- setLabel(Msg, Object...) - Method in class DMField
- setLabelPlacement(String) - Method in class AbstractInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- setLabels(Map<String, Object>) - Method in class OptionInputBuilder
-
Sets labels of the OptionInputBuilder instance.
- setLabelStyle(String) - Method in class AbstractInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- setLabelTranslations(String) - Method in class ContextParameter
- setLabelTranslations(Map<String, String>) - Method in class DMField
-
A map, with locale (String) as key and translated label (String) as value.
- setLabelTranslations(Map<String, String>) - Method in class AbstractInputBuilder
-
Sets the translation of the label.
- setLabelTranslationsFromMap(Map<String, String>) - Method in class ContextParameter
- setLastLogin(LocalDateTime) - Method in class User
- setLastName(String) - Method in class User
- setLastTermsOfUseAgreedDate(LocalDateTime) - Method in class User
- setLastTermsOfUseVersionAgreed(String) - Method in class User
- setLastUpdateByName(String) - Method in class AttachedDocument
- setLastUpdateByName(String) - Method in class CustomerAssignment
- setLastUpdateByName(String) - Method in class LookupTable
- setLastUpdateByName(String) - Method in class ManualPricelist
- setLastUpdateByName(String) - Method in class PriceGrid
- setLastUpdateByName(String) - Method in class Pricelist
- setLayoutGridName(String) - Method in class AbstractInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- 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 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
- setLinkedCFStypedId(String) - Method in class ManualPricelist
- setList(List) - Method in class SimpleInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- setListId(Number) - Method in class SummaryCalculableObjectItem
- setListId(Object) - Method in class ProductReferenceRecord
- setListLabel(String) - Method in class ProductReferenceRecord
- setListLabel(String) - Method in class SummaryCalculableObjectItem
- setLoginName(String) - Method in class User
- setLookupTableIdShouldBeIgnored(Long) - Method in class LookupTable
- setManualResultPrice(BigDecimal) - Method in class SummaryCalculableObjectItem
- setMapping(Map<String, String>) - Method in interface DatamartContext.DataLoader
-
When calling
DatamartContext.DataLoader.addRow(Map)
, maps the value for the given source fields to the corresponding target fields (the latter being the fields in the target FC being populated). - 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(Integer) - Method in class SimpleInputBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 7.7.0, use instead
setTo
- setMax(BigDecimal) - Method in class ResultGauge
-
The maximum dial value.
- setMax(Date) - Method in class SimpleInputBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 7.7.0, use instead
setTo
- 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
- setMaximumDepth(int) - Method in class DashboardInputsInputBuilder
-
If the Dashboard features Embedded Dashboard portlets, the FE will find out about all inputs recursively.
- setMaxLength(Integer) - Method in class SimpleInputBuilder
-
Sets the maximum amount of alphanumerics to be accepted by
TextUserEntry
. - setMaxLength(Integer) - Method in class StringInputBuilder
-
Sets the maximum amount of alphanumerics to be accepted by
StringUserEntry
. - setMaxRows(Integer) - Method in interface DatamartContext.Query
-
Limits the number of rows returned in the query result.
- setMaxRows(Integer) - Method in interface DatamartContext.SqlQuery
-
Sets the max rows to be returned when executing the SQL query.
- setMeasure(String) - Method in class AbstractChartMeasures
- setMeasure(String) - Method in class LimitToMeasure
- setMeasureType(MeasureType) - Method in class DMField
- setMessage(String) - Method in class ConfiguratorEntry
-
Sets a message that will appear on top of the configuration entry.
- setMin(Integer) - Method in class SimpleInputBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 7.7.0, use instead
setFrom
- setMin(BigDecimal) - Method in class ResultGauge
-
The minimum dial value.
- setMin(Date) - Method in class SimpleInputBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 7.7.0, use instead
setFrom
- setMinLength(Integer) - Method in class SimpleInputBuilder
-
Sets the minimum amount of alphanumerics to be accepted by
TextUserEntry
. - setMinLength(Integer) - Method in class StringInputBuilder
-
Sets the minimum amount of alphanumerics to be accepted by
StringUserEntry
. - setName(String) - Method in class Customer
- setName(String) - Method in class DMField
- setName(String) - Method in class CustomFormApi.CustomFormBuilder
-
Sets the Custom Form name.
- 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.
- setNextJobs(List<ChainedJobInfo>) - Method in class CFSAction
-
Defines subsequent follow-on jobs
- setNextJobs(List<ChainedJobInfo>) - Method in class DataLoadAction
-
Defines subsequent follow-on jobs
- setNextJobs(List<ChainedJobInfo>) - Method in class LivePriceGridAction
-
Defines subsequent follow-on jobs
- setNextJobs(List<ChainedJobInfo>) - Method in class PricelistAction
-
Defines subsequent follow-on jobs
- setNextJobs(List<ChainedJobInfo>) - Method in class SimulationAction
-
Defines subsequent follow-on jobs
- setNextJobs(List<ChainedJobInfo>) - Method in class ChainedJobInfo
-
Sets a list of jobs that are then executed after this one.
- setNoCellRefresh(boolean) - Method in class InputMatrixInputBuilder
-
Set to
true
to display the Apply button within the input matrix. - setNodeId(Number) - Method in class LookupTable
- setNodeId(Number) - Method in class ManualPricelist
- setNodeId(Number) - Method in class PriceGrid
- setNodeId(Number) - Method in class Pricelist
- setNoRefresh(boolean) - Method in class AbstractInputBuilder
-
Prevents the Configurator refresh when the value of the field is changed.
By default, the Configurator form will refresh every time when some input value is changed by the user, i.e. the Configurator logic will be executed again and the content of the form will be refreshed. - setNoSession(Boolean) - Method in class User
- setNumberOfFailedItems(Integer) - Method in class CalculatedFieldSet
- 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(List<String>) - Method in class OptionInputBuilder
-
Adds options to the OptionInputBuilder instance.
- 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.
- setOriginatorTypedId(String) - Method in class ActionItemApi.ActionItemBuilder
-
Sets the
OriginatorTypedId
(link to the originator document) of the Action Item. - setOwner(String) - Method in class DMTable
- setOwner(String) - Method in class LookupTable
- setOwningFC(String) - Method in class DMField
- setOwningFC(DMFieldCollection) - Method in class DMField
- setParam(String, Object) - Method in interface DashboardApi
-
The main dashboard can provide input parameters to the embedded dashboard via
- setParam(String, Object, boolean...) - Method in interface ModelFormulaContext
-
Adds a new parameter, or overwrites an existing parameter value, being an entry in the 'Model Params <model.uniqueName>' PP.
- setParameterConfig(Map<String, Object>) - Method in class ContextParameter
-
Sets the behavior of the input field.
- setParameterGroup(String) - Method in class AbstractInputBuilder
-
Creates collapsible sections to organize input fields in the UI.
- setParameterGroup(String) - Method in class ContextParameter
-
Allows you to create collapsible sections that organize inputs in the UI.
- setParameters(Map<String, Object>) - Method in class ChainedJobInfo
-
Sets the additional init parameters of this next job.
- setParams(Map<String, Object>) - Method in interface DashboardApi
-
Convenience method to set a number of parameters at once.
- setParent(Boolean) - Method in class Customer
- setParentId(Long) - Method in class Customer
- setParentTabName(String) - Method in class ActionItemApi.ActionItemBuilder
-
Sets the dynamicTab where the Action Item is displayed.
- setParentTypedId(String) - Method in class ActionItemApi.ActionItemBuilder
-
Sets the parent object (specified by
typedId
) of the action item. - setPartialCalculationDate(LocalDateTime) - Method in class PriceGrid
- setPartition(String) - Method in class ObjRefAction
- setPaSearchable(Boolean) - Method in class PCGroupInputBuilder
-
Sets the 'paSearchable' property for ProductGroup, CustomerGroup or SellerGroup inputs created via
api.inputBuilderFactory
. - setPassword(String) - Method in class User
-
This convenience method accepts a clear-text password The password will be hashed using the password service
- setPasswordExpiry(LocalDateTime) - Method in class User
- setPasswordHash(String) - Method in class User
- setPasswordSalt(String) - Method in class User
- setPeriod(int, ModelSchedulesContextReadOnly.PeriodUnit) - Method in interface ModelSchedulesContextReadWrite.NewScheduleBuilder
-
Sets the period of the model action execution.
- setPlaceholderText(String) - Method in class AbstractInputBuilder
-
Places the specified text to the input field as a placeholder.
- setPlasma(Boolean) - Method in class LookupTable
- setPlatformManaged(Boolean) - Method in class User
- setPortlet(String) - Method in interface DashboardApi
-
Instead of embedding a whole dashboard, only the one requested portlet will be displayed.
- setPortletPath(String...) - Method in class DashboardInputsInputBuilder
-
If the Dashboard features Embedded Dashboard portlets, the FE will find out about all inputs recursively.
- setPostStepLogicFailed(boolean) - Method in class InsertWorkflowStepsDTO
- setPreferenceName(String) - Method in interface ResultMatrix
-
Sets the so-called preference name.
- setPrefix(String) - Method in class ResultGauge
-
Set the label prefix.
- setPreviousPrice(BigDecimal) - Method in class SummaryCalculableObjectItem
- setPreviousPricelistId(Long) - Method in class Pricelist
- setPreviousValueTracking(boolean) - Method in class AbstractInputBuilder
-
Enables or disables the tracking of the previous value for a specified
ContextParameter
within the ConfiguratorEntry. - setPriceChange(BigDecimal) - Method in class SummaryCalculableObjectItem
- setPriceChangePct(BigDecimal) - Method in class SummaryCalculableObjectItem
- setPricegridCalculationChart(Map<String, ?>, Long) - Method in interface PublicGroovyAPI
-
Chart definition that will be used to construct and display a Highchart in the header section.
- setPricegridCalculationOutput(Long, String, String, String, String) - Method in interface PublicGroovyAPI
-
Sets the PG calculation output that will be shown in the header section after the PG calculation.
- setPriceGridConfiguration(PriceGridConfiguration) - Method in class PriceGrid
- setPriceGridIdShouldBeIgnored(Long) - Method in class PriceGrid
- setPriceGridType(MatrixableCalculableObject.ListType) - Method in class PriceGrid
- setPricelistCalculationChart(Map<String, ?>, Long) - Method in interface PublicGroovyAPI
-
Chart definition that will be used to construct and display a Highchart in the header section.
- setPricelistCalculationOutput(Long, String, String, String, String) - Method in interface PublicGroovyAPI
-
Sets the PL calculation output that will be shown in the header section after the PL calculation.
- setPricelistConfiguration(PricelistConfiguration) - Method in class Pricelist
- setPricelistId(Long) - Method in class Pricelist
- setPricelistPricegridTypeUniqueName(String) - Method in class Pricelist
- setPricelistType(MatrixableCalculableObject.ListType) - Method in class Pricelist
- 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.
- setPriority(int) - Method in class CustomerAssignment
- setProcessingMode(Pricelist.ProcessingMode) - Method in class Pricelist
- setProductFieldLabel(String) - Method in class ProductGroup
-
Sets a field label value of the ProductGroup object.
Example: - setProductFieldName(String) - Method in class ProductGroup
-
Sets a field name value of the ProductGroup object.
Example: - setProductFieldValue(String) - Method in class ProductGroup
-
Sets a field value of the ProductGroup object.
Example: - setProductFilter(Filter) - Method in class ItemSummaryQuery
- setProductFilterCriteria(String) - Method in class User
- setProductFilterCriteria(Map<String, Object>) - Method in class ProductGroup
-
Sets the filter criteria from a map of filters for the ProductGroup.
Example: - setProductFilterCriteriaJson(String) - Method in class ProductGroup
-
Sets the filter criteria from a JSON filter for the ProductGroup.
Example: - setProductGroupBy(String) - Method in class ItemSummaryQuery
- setProjections(List<ItemSummaryQuery.Projection>) - Method in class ItemSummaryQuery
- setProperty(String) - Method in class Filter
- setQuery(String, Object...) - Method in interface DatamartContext.SqlQuery
-
Sets the main SQL SELECT clause of this query, where every "?"
- setRank(int) - Method in class DMField
- setRank(int) - Method in interface IRebateRecordManager
-
Sets the rank on the default RR/COR.
- setRank(String, int) - Method in interface IRebateRecordManager
-
Sets the rank on the named RR/COR.
- setReadOnly(Boolean) - Method in class AbstractInputBuilder
-
Sets the input field as read-only.
- setReadOnly(Boolean) - Method in class ContextParameter
- setReadOnlyColumns(List<String>) - Method in class InputMatrixInputBuilder
-
Marks specified columns as read-only.
- setReason(String) - Method in class WorkflowDTO.ApprovalStepDTO
-
Deprecated.
- setReason(String) - Method in class WorkflowDTO.WatcherStepDTO
- setReason(List<String>) - Method in class WorkflowDTO.WatcherStepDTO
- setReceiveAdminEmail(Boolean) - Method in class User
- 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.
- setRelativeTargetDateDays(Integer) - Method in class CalculatedFieldSet
- setRelativeTargetDateDays(Integer) - Method in class PriceGrid
- setRenderInfo(String, String, Object) - Method in class CalculableLineItemCollectionBuilder
-
Sets (adds or updates) rendering information for particular header fields and buttons.
- setRequired(Boolean) - Method in class AbstractInputBuilder
-
Sets the input field as mandatory.
- setRequired(Boolean) - Method in class ContextParameter
-
Sets, if it's mandatory for the input parameter to have a value.
- setRequiredColumns(List<String>) - Method in class InputMatrixInputBuilder
-
Sets columns as required.
- setRequireTFA(Boolean) - Method in class User
- setResultMatrix(ResultMatrix) - Method in class ResultMatrixFilterBuilder
-
Use resultMatrix provided as input parameter to generate filter input.
- setResultMatrixTabs(ResultMatrix...) - Method in class ResultHighchart
-
The automatically filled data tab can be replaced by customized ResultMatrix data.
- setResultPrice(BigDecimal) - Method in class SummaryCalculableObjectItem
- setRichTextEditor(boolean) - Method in class SimpleInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- setRoles(List<Role>) - Method in class User
- setRounding(boolean) - Method in class SimpleInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- 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.
- setScore(Double) - Method in class ItemRecommendation
- setSellerFieldLabel(String) - Method in class SellerGroup
-
Sets a field label value of the SellerGroup object.
Example: - setSellerFieldName(String) - Method in class SellerGroup
-
Sets a field name value of the SellerGroup object.
Example: - setSellerFieldValue(String) - Method in class SellerGroup
-
Sets a field value of the SellerGroup object.
Example: - setSellerFilterCriteria(String) - Method in class User
- setSellerFilterCriteria(Map<String, Object>) - Method in class SellerGroup
-
Sets the filter criteria from a map of filters for the SellerGroup.
Example: - setSellerFilterCriteriaJson(String) - Method in class SellerGroup
-
Sets the filter criteria from a JSON filter for the SellerGroup.
Example: - setSharedCache(String, String) - Method in interface PublicGroovyAPI
-
Stores a string value in the shared cache with the given key.
- setShotgunModeEnabled(Boolean) - Method in class Simulation
- 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
- setShowInline(boolean) - Method in class AbstractInputBuilder
- setShowInline(boolean) - Method in class FilterBuilderInputBuilder
-
By default, the input is rendered as a clickable text that opens a modal dialog.
- setShowZAxis(Boolean) - Method in class AbstractChartOptions
- setShowZAxis(Boolean) - Method in class ChartOptions.ZAxis
- setSimulationSet(String) - Method in class ManualPricelistAction
-
Sets simulation set.
- setSimulationSet(String) - Method in class Simulation
- setSize(String) - Method in class PieChart.PieSeries
- setSize(String) - Method in class AbstractInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- setSku(String) - Method in class QuoteLineItem
- setSku(String) - Method in class ProductReferenceRecord
- setSku(String) - Method in class SummaryCalculableObjectItem
- setSortType(TieredValueSortType) - Method in class MultiTierInputBuilder
-
Sets tiered value sort type.
- setSource(String) - Method in class DMField
- setSource(DMFieldCollection) - Method in class DMField
- setSource(DMQuery) - Method in class DMField
- setSourceContext(String) - Method in class ActionItemApi.ActionItemBuilder
-
Inserts the specified JSON to the sourceContext field.
- setSourceField(String) - Method in class DMField
- setSourceQuery(DatamartContext.Query) - Method in interface ModelFormulaContext
- setSsoOnly(Boolean) - Method in class User
- setStartDate(DateTime) - Method in interface ModelSchedulesContextReadWrite.NewScheduleBuilder
-
Sets the start date and time of the model schedule.
- setStatus(String) - Method in class ActionItemApi.ActionItemBuilder
-
Sets the Status of the Action Item (AI).
- setStatus(AttachedDocument.DocumentStatus) - Method in class AttachedDocument
- setSteepness(String) - Method in class AuxLine.Line
- setStep(BigDecimal) - Method in class SliderInputBuilder
-
Sets the slider step.
- setSubLabels(String, String) - Method in class SliderInputBuilder
-
Sets the sub labels displayed respectively on the left and the right of the slider.
- setSubmitDate(LocalDateTime) - Method in class Pricelist
- setSubmitReason(String) - Method in class WorkflowDTO
-
Overrides reason entered by submitter
- setSubmittedByName(String) - Method in class AttachedDocument
- setSubtitle(String) - Method in class AbstractChartOptions
- setSubtitle(String) - Method in class ChartOptions.Basic
- setSuccessMessage(String) - Method in class AbstractInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- setSuffix(String) - Method in class ResultGauge
-
The label suffix.
- setSummary(String) - Method in class ActionItemApi.ActionItemBuilder
-
Sets the Summary field (a title) of the Action Item (AI).
- setTargetContext(String) - Method in class ActionItemApi.ActionItemBuilder
-
Inserts the specified JSON to the targetContext field.
- setTargetDate(LocalDateTime) - Method in class ManualPricelist
- setTargetDate(Date) - Method in class Formula
- setTargetDate(Date) - Method in class SummaryCalculableObjectItem
- setTargetObject(String) - Method in class ChainedJobInfo
-
Sets the target object of next job.
- setTargetObjectTypeCode(Object) - Method in class ProductReferenceRecord
- setTargetPage(String) - Method in class ButtonInputBuilder
-
Opens the target location (AppPage).
- setTargetPageComponent(String) - Method in class ButtonInputBuilder
-
Not available yet.
- setTargetPageState(String) - Method in class ButtonInputBuilder
-
Opens the particular object detail in the specified location.
- setTextMask(String) - Method in class StringInputBuilder
-
Sets text mask on ContextParameter, used in the dropdown input field.
- setTheme(String) - Method in class AbstractInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- setTimeUnit(CalendarUtil.TimeUnit) - Method in class DMCalendar.TimeDim
- setTitle(String) - Method in class AbstractChartOptions
- setTitle(String) - Method in class ChartOptions.Basic
- setTitle(String) - Method in class AbstractInputBuilder
-
Displays the specified text as a tooltip when a user hovers mouse over the input field label.
- setTitle(String) - Method in interface ResultMatrix
-
Sets the title that will be shown as window title of the result matrix in the client
- setTo(Float) - Method in class SimpleInputBuilder
-
Sets the maximum allowed value for the input field.
- setTo(String) - Method in class DateRangeInputBuilder
-
Set to value of the date range input field.
- setTo(BigDecimal) - Method in class SliderInputBuilder
-
Sets the upper bound of the slider range.
- setTo(Date) - Method in class SimpleInputBuilder
-
Sets the maximum allowed date value for the input field.
- setToDate(Date) - Method in class TimeSeriesChart.TimeSeriesSeries
- setTrackedValue(String, Object) - Method in class ConfiguratorEntry
-
Sets the
ContextParameter
value, enriched by the groovy logic value tracking feature. - setTrackedValue(VT) - Method in class AbstractInputBuilder
-
Method is design to set the value only for value tracking inputs.
NOTE:
the method needs to be used after the set tracking features, if notConfiguratorEntryException.ValueNotTrackedException
is thrown - setType(String) - Method in class ActionItemApi.ActionItemBuilder
-
Sets the Action Item Type (AIT) of the Action Item (AI).
- 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
- setType(DataType) - Method in class DMField
- setType(FieldType) - Method in class DMField
- setType(LookupTable.LookupTableType) - Method in class LookupTable
- setTypeCode(String) - Method in class ObjRefAction
- setTypeCode(String) - Method in class SummaryCalculableObjectItem
- setTypedId(String) - Method in class ContextParameter
- setTypeId(Long) - Method in class CustomFormApi.CustomFormBuilder
-
Sets the Custom Form Type id.
- setTypes(String...) - Method in class DMSourceInputBuilder
- setTypes(Collection<String>) - Method in class DMSourceInputBuilder
-
Defines the type codes of the sources that will be provided in the drop-down list selector.
- setTypeUniqueName(String) - Method in class AttachedDocument
- setUniqueLoginName(String) - Method in class User
- setUomField(String) - Method in class DMField
- setUpdateDate(LocalDateTime) - Method in class PriceGrid
- setUpdateDate(LocalDateTime) - Method in class Pricelist
- setUpdatedBy(Long) - Method in class PriceGrid
- setUpdatedBy(Long) - Method in class Pricelist
- setUrl(String) - Method in class ButtonInputBuilder
-
Opens the target URL in a new tab when a user clicks the button.
- setURL(String) - Method in class ContextParameter
- setUseCache(Boolean) - Method in interface DatamartContext.Query
-
Allows to disable node level PA query caching just for this query.
- setUsedSimulationFormulas(Set<Long>) - Method in class Simulation
- setUsedSimulationLookups(Set<Long>) - Method in class Simulation
- setUseFilterCriteria(Boolean) - Method in class Simulation
- setUseRefreshData(Boolean) - Method in class Table
- setUserGroupEdit(String) - Method in class AttachedDocument
- setUserGroupEdit(String) - Method in class CalculatedFieldSet
- setUserGroupEdit(String) - Method in class Customer
- setUserGroupEdit(String) - Method in class LookupTable
- setUserGroupEdit(String) - Method in class ManualPricelist
- setUserGroupEdit(String) - Method in class PriceGrid
- setUserGroupEdit(String) - Method in class Pricelist
- setUserGroupEdit(String) - Method in class RebateRecordSet
- setUserGroupEdit(String) - Method in class Simulation
- setUserGroupEdit(String) - Method in class AbstractInputBuilder
-
Sets the userGroupEdit property for the input.
NOTE
- each usage of the method on a single input, will override the value
Example: - setUserGroupEdit(String) - Method in class ContextParameter
- setUserGroupEdit(String) - Method in class CustomFormApi.CustomFormBuilder
-
Sets the Custom Form User Group Edit.
- setUserGroupEdit(String) - Method in class CustomFormApi.UpdateApi
-
Updates the value of
userGroupEdit
. - setUserGroupEdit(Collection<String>) - Method in class AbstractInputBuilder
-
Sets the userGroupEdit property for the input.
null
or emptyCollection
sets the property tonull
which means no restrictions.
NOTE
- if concatenation ofuserGroupNames
(with comma delimiter) exceeds theAbstractInputBuilder.DB_MAX_STRING_LENGTH
characters limit, the value is not set
- each usage of the method on a single input, will override the value
Example: - setUserGroupView(String) - Method in class AbstractInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- setUserGroupViewDetails(String) - Method in class AttachedDocument
- setUserGroupViewDetails(String) - Method in class CalculatedFieldSet
- setUserGroupViewDetails(String) - Method in class Customer
- setUserGroupViewDetails(String) - Method in class LookupTable
- setUserGroupViewDetails(String) - Method in class ManualPricelist
- setUserGroupViewDetails(String) - Method in class PriceGrid
- setUserGroupViewDetails(String) - Method in class Pricelist
- setUserGroupViewDetails(String) - Method in class RebateRecordSet
- setUserGroupViewDetails(String) - Method in class Simulation
- setUserGroupViewDetails(String) - Method in class CustomFormApi.CustomFormBuilder
-
Sets the Custom Form User Group View Details.
- setUserGroupViewDetails(String) - Method in class CustomFormApi.UpdateApi
-
Updates the value of
UserGroupViewDetails
. - setValidAfter(Date) - Method in class ManualPricelistAction
-
Informs the runtime to work with MPL that is valid after the specified date.
- setValidationType(TieredValueValidationType) - Method in class MultiTierInputBuilder
-
Sets tiered value validation type.
- setValue(Object) - Method in class Filter
- setValue(Object) - Method in class ContextParameter
-
Set initial/default value of the input parameter.
- setValue(Object, long, long) - Method in interface Matrix2D
-
Modifies the value at the given coordinates (row,col)
- setValue(BigDecimal) - Method in class ResultGauge
-
The current value on the dial.
- setValue(VT) - Method in class AbstractInputBuilder
-
Prefills the input field with the specified value.
For line item logics (on Quotes, Rebates, Price Lists,...) works in the input generation mode only and has no effect in the regular execution mode.
Warning: if used on headers or configurators the value prefilled by the setValue will overwrite a user-entered value when the user clicks the Recalculate button (Header), or jumps to another line/closes the dialog (Configurator). - setValueChangeTracking(boolean) - Method in class AbstractInputBuilder
-
Enables or disables tracking of value changes for a specified
ContextParameter
. - setValueHint(String) - Method in class AbstractInputBuilder
-
Adds the specified hint next to the input field.
- setValueHint(String) - Method in class ContextParameter
- setValueOptions(String[]) - Method in class ContextParameter
-
Sets list of options used in the dropdown input field.
- setValueOptions(List<String>) - Method in class ContextParameter
- setValueType(LookupTable.LookupTableValueType) - Method in class LookupTable
- setVersion(Number) - Method in class SummaryCalculableObjectItem
- setVerticalLayout(Boolean) - Method in class PieChart.PieOptions
- setVisibility(Integer) - Method in class DMField
- setWarningMessage(String) - Method in class AbstractInputBuilder
-
N/A - the method has not been implemented in the user interface yet.
- setWhisker(WhiskerType) - Method in class AbstractChartSeries
- setWhisker(WhiskerType) - Method in class ChartSeries.EmbeddedBoxplot
- setWidth(AbstractInputBuilder.InputWidth) - Method in class AbstractInputBuilder
-
Sets the width of the input field on the screen.
- setWizardDashboardName(String) - Method in class User
- setWorkflowEmailingActivated(Boolean) - Method in class User
- setWorkflowStatus(Workflow.WorkflowStatus) - Method in class AttachedDocument
-
Possible workflowStatus values: DRAFT, SUBMITTED, DENIED, APPROVED, NO_APPROVAL_REQUIRED, WITHDRAWN, INVALIDATED
- setWorkflowStatus(Workflow.WorkflowStatus) - Method in class Pricelist
-
Possible workflowStatus values: DRAFT, SUBMITTED, DENIED, APPROVED, NO_APPROVAL_REQUIRED, WITHDRAWN, INVALIDATED
- setXLabel(String) - Method in class AbstractChartOptions
- setXLabel(String) - Method in class ChartOptions.XYLabels
- setXLogarithmic(boolean) - Method in class AbstractChartOptions
- setXLogarithmic(boolean) - Method in class BubbleChart.BubbleOptions
- setXLogarithmic(boolean) - Method in class ScatterChart.ScatterOptions
- setXMax(BigDecimal) - Method in class AbstractChartOptions
- setXMax(BigDecimal) - Method in class ChartOptions.XYMinMax
- setXMax(Date) - Method in class AbstractChartOptions
- setXMax(Date) - Method in class DetailedTimeSeriesChart.DetailedTimeSeriesOptions
- setXMax(Date) - Method in class TimeSeriesScatterChart.TimeSeriesScatterOptions
- setXMin(BigDecimal) - Method in class AbstractChartOptions
- setXMin(BigDecimal) - Method in class ChartOptions.XYMinMax
- setXMin(Date) - Method in class AbstractChartOptions
- 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
- setYLogarithmic(boolean) - Method in class AbstractChartOptions
- setYLogarithmic(boolean) - Method in class BarLineChart.BarLineOptions
- setYLogarithmic(boolean) - Method in class BubbleChart.BubbleOptions
- setYLogarithmic(boolean) - Method in class DetailedTimeSeriesChart.DetailedTimeSeriesOptions
- setYLogarithmic(boolean) - Method in class ScatterChart.ScatterOptions
- setYLogarithmic(boolean) - Method in class TimeSeriesChart.TimeSeriesOptions
- setYLogarithmic(boolean) - Method in class TimeSeriesScatterChart.TimeSeriesScatterOptions
- 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
- setZLogarithmic(boolean) - Method in class AbstractChartOptions
- setZLogarithmic(boolean) - Method in class BarLineChart.BarLineOptions
- setZLogarithmic(boolean) - Method in class DetailedTimeSeriesChart.DetailedTimeSeriesOptions
- setZLogarithmic(boolean) - Method in class TimeSeriesChart.TimeSeriesOptions
- 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
-
Shows given dashboard as an embedded dashboard of another (main) dashboard.
- showInline() - Method in class FilterBuilderInputBuilder
-
By default, the input is rendered as a clickable text that opens a modal dialog.
- SIMPLE - Enum constant in enum class CalculationResultType
- SIMPLE - Enum constant in enum class LookupTable.LookupTableType
- SIMPLE_DATE_KEY - Enum constant in enum class LookupTable.LookupTableType
- SIMPLE_INT_KEY - Enum constant in enum class LookupTable.LookupTableType
- SIMPLE_REAL_KEY - Enum constant in enum class LookupTable.LookupTableType
- SIMPLEDATEFORMAT_PATTERN - Static variable in class CalendarUtil
- SimpleInputBuilder<VT> - Class in net.pricefx.formulaengine.scripting.inputbuilder
-
Builder class for basic input types.
- SimpleInputBuilder(InputBuilderContext, String, InputType, String) - Constructor for class SimpleInputBuilder
- Simulation - Class in net.pricefx.domain
- Simulation() - Constructor for class Simulation
- Simulation.SimulationType - Enum Class in net.pricefx.domain
- SimulationAction<T> - Class in net.pricefx.common.apibuilder.calculationflowaction
-
This action starts calculation of selected simulation.
- SimulationAction(T, Invocations<MethodInvocationRecord>, String) - Constructor for class SimulationAction
- size() - Method in interface DatamartRowSet
-
Returns the number of rows in this
DatamartRowSet
. - size() - Method in class TieredValue
- Size(PieChart.PieSeries, String) - Constructor for class PieChart.Size
- SKIP - Enum constant in enum class Pricelist.PricelistErrorModeType
- sku - Variable in class ProductReferenceRecord
-
The sku that reference is for
- SLIDER - Enum constant in enum class InputType
- SliderInputBuilder - Class in net.pricefx.formulaengine.scripting.inputbuilder
-
Builder class for input type Slider
InputType.SLIDER
. - SliderInputBuilder(InputBuilderContext, String) - Constructor for class SliderInputBuilder
- SMALL - Enum constant in enum class AbstractInputBuilder.InputWidth
- 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 Class in net.pricefx.common.api.chart
- sourceSelectionEntry(String, String...) - Method in interface DatamartContext
- SPARKLINE - Enum constant in enum class FieldFormatType
- SPLINE - Enum constant in enum class SeriesType
- STACKED - Enum constant in enum class ComparisonType
- STACKED_PERCENT - Enum constant in enum class ComparisonType
- startDate(Date) - Method in enum class CalendarUtil.TimeUnit
- startJobTriggerCalculation(String, String, String, String) - Method in interface ModelFormulaContextReadWrite
-
It is the responsibility of the caller to serialize
parameters
however they are required by the image. - STARTS_WITH - Enum constant in enum class FilterOperator
- status() - Method in interface ModelParallelCalculationFormulaSummaryContext.CalculationItem
- std() - Method in interface Matrix2D
- STEP - Enum constant in enum class AuxLineType
- 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>, 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, 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, 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 returns a result, so that one row at the time can be examined. - 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.
- streamSqlQuery(DatamartContext.SqlQuery) - Method in interface DatamartContext
-
Executes the given
DatamartContext.SqlQuery
and returns a result, so that one row at the time can be examined. - STRING - Enum constant in enum class DataType
- STRING - Enum constant in enum class LookupTable.LookupTableValueType
- StringInputBuilder<VT> - Class in net.pricefx.formulaengine.scripting.inputbuilder
-
Builder class for input type StringUserEntry
InputType.STRINGUSERENTRY
. - StringInputBuilder(InputBuilderContext, String) - Constructor for class StringInputBuilder
- stringUserEntry(String) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createStringUserEntry(String)
instead. - stringUserEntry(String, String) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createStringUserEntry(String)
instead. - stringUserEntry(String, String, String) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createStringUserEntry(String)
instead. - STRINGUSERENTRY - Enum constant in enum class InputType
- styledCell(Object) - Method in interface ResultMatrix
-
Creates a styled cell that can then be added as row value
- styledCell(Object) - Method in class ResultMatrix
-
Deprecated.
- styledCell(Object, String, String) - Method in interface ResultMatrix
-
Creates a styled cell that can then be added as row value
- styledCell(Object, String, String) - Method in class ResultMatrix
-
Deprecated.
- styledCell(Object, String, String, String) - Method in interface ResultMatrix
-
Creates a styled cell that can then be added as row value
- styledCell(Object, String, String, String) - Method in class ResultMatrix
-
Deprecated.
- styledCell(Object, String, String, String, String) - Method in interface ResultMatrix
-
Creates a styled cell that can then be added as row value
- styledCell(Object, String, String, String, String) - Method in class ResultMatrix
-
Deprecated.
- submit() - Method in class CustomFormApi.DocumentActionApi
-
Finishes the submit operation.
- submitAfterBuild() - Method in class RATBuilder.RABuilder
- submitDate() - Method in class Pricelist
- SUBMITTED - Enum constant in enum class RebateRecordStatus
- SUBTRACT - Enum constant in enum class WaterfallColumnType
- sum() - Method in interface Matrix2D
- SUM - Enum constant in enum class AggregationFormula
- SummaryCalculableObjectItem - Class in net.pricefx.server.dto
-
This class acts as a DTO for PricelistItems that are enriched by some price list header information.
- SummaryCalculableObjectItem() - Constructor for class SummaryCalculableObjectItem
- SUPERSEDED - Enum constant in enum class RebateAgreementStatus
- SUPERSEDED - Enum constant in enum class AttachedDocument.DocumentStatus
- switchSKUContext(String) - Method in interface PublicGroovyAPI
-
Temporarily switches the current SKU context to another SKU.
- SYSTEM - Static variable in class DMField
- SYSTEM_SUPPORT_USER_NAME - Static variable in class User
- SYSTEM_USER_NAME - Static variable in class User
- SystemPortlet - Interface in net.pricefx.formulaengine.scripting
-
SystemPortlet objects are intended as output of logic/formula elements to be rendered by the UI.
- SYSTEMPORTLET - Enum constant in enum class CalculationResultType
T
- table(String) - Method in interface ModelContext
- table(String) - Method in interface ModelFormulaContextReadOnly
- Table - Class in net.pricefx.server.util.metamodel.dm
-
Represents a table and its metadata description.
- Table(DMFieldCollection, Schema) - Constructor for class Table
- 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) - Constructor for class TableContext
- targetDate() - Method in interface PublicGroovyAPI
-
Returns an effective/target date of the document being calculated.
- targetObjectTypeCode - Variable in class ProductReferenceRecord
-
Type Code of target parent object.
- targetPage - Variable in class ResultMatrix.ResultMatrixLinkCell
-
Deprecated.
- targetPageState - Variable in class ResultMatrix.ResultMatrixLinkCell
-
Deprecated.
- targetRAUniqueName() - Method in class RATBuilder
- templateTypeId() - Method in class RATBuilder
- TEXT - Enum constant in enum class FieldFormatType
- TEXT - Enum constant in enum class FieldType
- textUserEntry(String) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createTextUserEntry(String)
instead. - textUserEntry(String, String) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createTextUserEntry(String)
instead. - TEXTUSERENTRY - Enum constant in enum class InputType
- throwException(String) - Method in interface PublicGroovyAPI
-
Throws a calculation exception with the specified message and aborts the calculation logic execution immediately.
- TieredValue - Class in net.pricefx.server.dto
- TieredValue() - Constructor for class TieredValue
- TieredValue.Tier - Class in net.pricefx.server.dto
- TieredValueSortType - Enum Class in net.pricefx.common.api.chart
- TieredValueValidationType - Enum Class in net.pricefx.common.api.chart
- time() - Static method in class CalendarUtil
- TIME - Enum constant in enum class DMFieldInputBuilder.FieldKind
- TimeDim(String, CalendarUtil.TimeUnit) - Constructor for class DMCalendar.TimeDim
- TimePeriod() - Constructor for class CalendarUtil.TimePeriod
- TimePeriod(String) - Constructor for class CalendarUtil.TimePeriod
- TimePeriod(Calendar, CalendarUtil.TimeUnit) - Constructor for class CalendarUtil.TimePeriod
- TimePeriod(Date, Date, CalendarUtil.TimeUnit) - Constructor for class CalendarUtil.TimePeriod
- TimePeriod(Date, CalendarUtil.TimeUnit) - Constructor for class CalendarUtil.TimePeriod
- TimePeriod(CalendarUtil.TimePeriod, CalendarUtil.TimePeriod, CalendarUtil.TimeUnit) - Constructor for class CalendarUtil.TimePeriod
- timePeriodAsFilter(CalendarUtil.TimePeriod, String) - Method in class DMCalendar
- 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]. - TIMESERIES - Enum constant in enum class ChartType
- TIMESERIES_DATETIME - Enum constant in enum class ChartType
- TIMESERIES_SCATTER - Enum constant in enum class ChartType
- 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 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 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
-
Deprecated.Use
InputBuilderFactory.createTimeUserEntry(String)
instead. - TIMEUSERENTRY - Enum constant in enum class InputType
- toDataType() - Method in enum class FieldType
- toDataType(Class<?>) - Static method in enum class DataType
- toDataType(Object, DataType) - Static method in enum class DataType
- today() - Method in class CalendarUtil
- toDBDataType(DataType) - Method in class TableContext
-
Converts a Pricefx datatype into a in-memory database datatype.
- toLastStep() - Method in class ModelCalculationAction
-
Sets the calculation range of steps of the specified model, ending with the last step (included).
- toMap() - Method in class WorkflowDTO.ApprovalStepDTO
- toMap() - Method in class WorkflowDTO.StepDTO
- toMap() - Method in class WorkflowDTO.WatcherStepDTO
- toMatrix2D() - Method in interface ResultMatrix
- toNumber(String, Locale) - Static method in enum class DataType
- tooltip - Variable in class ResultMatrix.ResultMatrixStyledCell
-
Deprecated.
- TOP - Enum constant in enum class LimitPosition
- toQueryString() - Method in class Filter
- toResultMatrix() - Method in interface DatamartRowSet
-
Converts the data to
ResultMatrix
Limited toDatamartRowSet.RESULTMATRIX_MAXROWS
rows. - toResultMatrix() - Method in interface Matrix2D
- toResultMatrix(boolean) - Method in interface Matrix2D
-
Converts this Matrix2D into ResultMatrix
- toResultMatrix(int) - Method in interface DatamartRowSet
-
Converts the data to
ResultMatrix
Limited to user defined number of rows which cannot exceedDatamartRowSet.RESULTMATRIX_MAXROWS
. - 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.
- toResultMatrix(Map<String, String>, boolean) - Method in interface Matrix2D
- toStep(String) - Method in class ModelCalculationAction
-
Sets the calculation range of steps of the specified model, ending with the specified step (included).
- 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 ModelCalculationAction
- toString() - Method in class ObjRefAction
- 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 CalendarUtil.TimePeriod
- toString() - Method in enum class CalendarUtil.TimeUnit
- toString() - Method in class AttachedDocument.CompositeKey
- toString() - Method in class AttachedDocument
- toString() - Method in class Customer
- toString() - Method in class CustomerGroup
- toString() - Method in class DMCalendar.TimeDim
- toString() - Method in class DMDataSlice
- toString() - Method in class DMField
- toString() - Method in class ProductGroup
- toString() - Method in class SellerGroup
- toString() - Method in class ModelFormulaContext.TreeNode
- toString() - Method in class TableContext
- toString() - Method in class ContextParameter
- toString() - Method in class ItemRecommendation
- toString() - Method in class ResultMatrix
-
Deprecated.
- toString() - Method in class SummaryCalculableObjectItem
- toString() - Method in class TieredValue.Tier
- toString() - Method in class TieredValue
- toStringExt() - Method in class DMField
- toTable() - Method in class AdaptiveHistogram
-
Return a table representing the data in this histogram.
- TOTAL_KEY - Static variable in class ItemSummaryQuery
- toTimeDim(String) - Static method in class DMCalendar.TimeDim
- toType(FieldFormatType) - Static method in enum class FieldType
- toType(DataType) - Static method in enum class FieldType
- toType(DataType) - Static method in class DMField
- trace(Object) - Method in interface PublicGroovyAPI
-
See
PublicGroovyAPI.trace(String, String, Object)
for a description. - trace(String, Object) - Method in interface PublicGroovyAPI
-
See
PublicGroovyAPI.trace(String, String, Object)
for a description. - trace(String, String, Object) - Method in interface PublicGroovyAPI
-
Generates a trace message that can be used during logic testing.
- transpose(String) - Method in interface ResultMatrix
-
Transpose the matrix.
- transpose(String, String) - Method in interface ResultMatrix
-
Transpose the matrix.
- tree(String) - Method in interface ModelFilterTreesContextReadOnly
- tree(String) - Method in interface ModelFilterTreesContextReadWrite
- TreeNode() - Constructor for class ModelFormulaContext.TreeNode
- TrendLine<S> - 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) - Method in class BarLineChart.BarLineOnChartClick
- triggerEvent(String) - Method in class BubbleChart.BubbleOnChartClick
- 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 interface ResultMatrix.OnRowSelection
- triggerEvent(String) - Method in interface ResultHighchart.OnPointClick
-
Define an event that will be triggered when the user click in the chart.
- triggerEvent(String) - Method in class ResultMatrix.ResultMatrixOnRowSelection
-
Deprecated.
- TriggerEvent(String) - Constructor for class AbstractChartEvent.TriggerEvent
- triggerPriceGridCalculation(Long, Map<String, Object>) - Method in interface PublicGroovyAPI
-
Creates a new background calculation job for the specified price grid.
The job can either perform a full calculation (parameters == null) or a partial calculation. - truncate() - Method in interface ModelLookupTablesContextReadWrite.MutableModelLookupTable
-
Truncate the content of this table
- truncateKV(String) - Method in interface PublicGroovyAPI
-
Removes all key values from the specified table.
- truncateTable(DatamartContext.Table) - Method in interface ModelCalcFormulaContext
-
Truncate the table.
- truncateTable(DatamartContext.Table) - Method in interface ModelFormulaContextReadWrite
- type - Variable in class ResultMatrix.AbstractResultMatrixCell
-
Deprecated.
- type - Variable in class ResultMatrix.ResultMatrixBackEndCell
-
Deprecated.
- type - Variable in class ResultMatrix.ResultMatrixCells
-
Deprecated.
- type - Variable in class ResultMatrix.ResultMatrixDownloadCell
-
Deprecated.
- Type(S, String) - Constructor for class ChartMeasures.Type
- TYPE_CHARTS - Static variable in interface SystemPortlet
-
String constant representing the home screen's Charts list
- TYPE_CLAIMS - Static variable in interface SystemPortlet
-
String constant representing the home screen's Claims list
- TYPE_CODE - Static variable in class PriceGrid
- TYPE_COMPENSATIONPLANS - Static variable in interface SystemPortlet
-
String constant representing the home screen's Compensation plans list
- TYPE_CONTRACTS - Static variable in interface SystemPortlet
-
String constant representing the home screen's Contracts list
- TYPE_DASHBOARDS - Static variable in interface SystemPortlet
-
String constant representing the home screen's Dashboards list
- TYPE_DOCUMENTSQUICKLINKS - Static variable in interface SystemPortlet
-
String constant representing the home screen's Documents Quick Links list
- TYPE_MYACTIONS - Static variable in interface SystemPortlet
-
String constant representing the home screen's My Actions list
- TYPE_MYDASHBOARDACTIONS - Static variable in interface SystemPortlet
-
String constant representing a dashboard's My Dashboard Actions list
Note: This portlet is not available in the home screen. - TYPE_PENDINGAPPROVALS - Static variable in interface SystemPortlet
-
String constant representing the home screen's Pending Approvals list
- TYPE_PENDINGCREATIONWFS - Static variable in interface SystemPortlet
-
String constant representing the home screen's Pending Creation Workflows list
- TYPE_PRICEGRIDS - Static variable in interface SystemPortlet
-
String constant representing the home screen's Price Grids list
- TYPE_PRICELISTS - Static variable in interface SystemPortlet
-
String constant representing the home screen's Price Lists list
- TYPE_QUICKSEARCH - Static variable in interface SystemPortlet
-
String constant representing the home screen's Product Quick Search panel
- TYPE_QUOTES - Static variable in interface SystemPortlet
-
String constant representing the home screen's Quotes list
- TYPE_REBATES - Static variable in interface SystemPortlet
-
String constant representing the home screen's Rebate Agreements list
- TYPE_TODOS - Static variable in interface SystemPortlet
-
String constant representing the home screen's To Do list
- typedId() - Method in interface ModelFormulaContextReadOnly
- typeName() - Method in class Pricelist
U
- uniqueName - Variable in class WorkflowDTO.StepDTO
- uniqueName - Variable in class WorkflowInfo.WorkflowStepInfo
-
The unique workflow step identifier
- uniqueName() - Method in interface ModelFormulaContextReadOnly
- uniqueName() - Method in interface ModelLookupTablesContextReadOnly.ModelLookupTable
-
The unique name is composed of the local name of the
LookupTable
in theModelObject
and the typedId of theModelObject
. - uniqueName(String, PartitionedObject) - Static method in class DMTable
- UNIT_GRID - Static variable in interface Portlet
-
The grid unit for 12 column layout system.
- UNIT_PX - Static variable in interface Portlet
-
The pixels unit.
- UNKNOWN - Enum constant in enum class DataType
- UNKNOWN - Enum constant in enum class AttachedDocument.DocumentStatus
- UNKNOWN_HASH - Static variable in class User
- UOM - Enum constant in enum class FieldType
- update(String, String, Map<?, ?>...) - Method in interface PayoutRecordManager
-
Updates the existing PayoutRecord or AccrualRecord (if any) specified by the given type and name.
- update(String, Map<String, Object>) - Method in interface PublicGroovyAPI
-
Updates an object in the collection of objects of the given type.
- update(DMField) - Method in class DMField
- update(DMTable) - Method in class DMTable
- 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.).
- updateData() - Method in class CustomFormApi.OperationsApi
-
Initiates an update operation.
- updateField(String, Object) - Method in class CalculableLineItemCollectionBuilder
-
Updates a header field value.
- updateField(String, String, Object) - Method in class CalculableLineItemCollectionBuilder
-
Updates a field on the line.
Note: Not supported for all objects, e.g. quotes. - updateFromFormulaInputDescriptor(FormulaInputDescriptor) - Method in class ContextParameter
- updateHeaderApprovalState(PersistedObjectService) - Method in class PriceGrid
- updateObjReferences(PersistedObjectService) - Method in class ContractLineItem
- updatePriceGridNumbers(PersistedObjectService) - Method in class PriceGrid
- updatePricelistHeader(PersistedObjectService) - Method in class Pricelist
- updateRow(Map<String, Object>) - Method in interface DatamartRowSet
-
Updates row values, only if a row already exists for the provided keys.
- 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. if a quote is worked on a while and passes a validity date border or an old quote is copied
- user() - Method in interface PublicGroovyAPI
-
Returns the entire master data object of the current user.
- user(String) - Method in interface PublicGroovyAPI
-
Returns a value from the current user's master data.
- User - Class in net.pricefx.domain
- User() - Constructor for class User
- User(Partition) - Constructor for class User
- User(Partition, String, String, String, String) - Constructor for class User
- USER - Enum constant in enum class InputType
- USER_ACTIONS_PAGE - Static variable in interface AppPages
-
Action page
- USER_NEW_ACTION_PAGE - Static variable in interface AppPages
-
New action page
- userApprovers - Variable in class WorkflowInfo.WorkflowStepInfo
-
A list of users that can approve
- userEntry(String) - Method in interface PublicGroovyAPI
-
Deprecated.Use
InputBuilderFactory.createUserEntry(String)
instead. - USERENTRY - Enum constant in enum class InputType
- UserGroup - Class in net.pricefx.domain
- UserGroup() - Constructor for class UserGroup
- userGroupApprovers - Variable in class WorkflowInfo.WorkflowStepInfo
-
A list of groups that can approve
- userGroupEditBulkloadFilter(PersistedObjectService, List<String>, List<Object>, User, Map<String, Object>) - Method in class Customer
- userGroupLabel - Variable in class WorkflowInfo.WorkflowStepInfo
-
Deprecated.
- uuid() - Method in interface PublicGroovyAPI
-
Generates a RFC4122, version 4 ID.
- 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.
V
- validate(DMExpression.DMExpressionContext, ValidationVisitor, boolean) - Method in class DMField
- validate(ValidationVisitor, boolean, PersistedObjectService) - Method in class DMTable
- validate(ValidationVisitor, PersistedObjectService) - Method in class CalculatedFieldSet
- validate(ValidationVisitor, PersistedObjectService) - Method in class Customer
- validate(ValidationVisitor, PersistedObjectService) - Method in class CustomerAssignment
- validate(ValidationVisitor, PersistedObjectService) - Method in class CustomerGroup
- validate(ValidationVisitor, PersistedObjectService) - Method in class LookupTable
- validate(ValidationVisitor, PersistedObjectService) - Method in class ManualPricelist
- validate(ValidationVisitor, PersistedObjectService) - Method in class PriceGrid
- validate(ValidationVisitor, PersistedObjectService) - Method in class Pricelist
- validate(ValidationVisitor, PersistedObjectService) - Method in class ProductGroup
- validate(ValidationVisitor, PersistedObjectService) - Method in class RebateRecordSet
- validate(ValidationVisitor, PersistedObjectService) - Method in class Simulation
- validate(ValidationVisitor, PersistedObjectService) - Method in class User
- validate(ValidationVisitor, PersistedObjectService) - Method in class UserGroup
- VALIDATE - Enum constant in enum class TieredValueValidationType
- validateForModelTablesContext(ValidationVisitor, PersistedObjectService) - Method in class DMTable
- value - Variable in class Filter
-
The value to compare the property with.
- value - Variable in class ResultMatrix.AbstractResultMatrixCell
-
Deprecated.
- value(int, String) - Method in class AbstractChartBuilder
- valueOf(String) - Static method in enum class CalculationResultType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class AggregationFormula
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class AuxLineColor
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class AuxLineType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class ChartType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class ColorAxisType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class ComparisonType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class FilterOperator
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class LimitPosition
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class LimitType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class SeriesType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class SortType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class TieredValueSortType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class TieredValueValidationType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class WaterfallColumnType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class WhiskerType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class EventType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class FieldFormatType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class InputButtonAction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class InputType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class DataType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class FieldType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class RebateAgreementStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class RebateRecordStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class CalendarUtil.TimeUnit
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class ApprovalState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class AttachedDocument.DocumentStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class CalculationStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class LookupTable.LookupTableType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class LookupTable.LookupTableValueType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class Pricelist.PricelistErrorModeType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class Pricelist.ProcessingMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class Simulation.SimulationType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class ModelParallelCalculationFormulaSummaryContext.CalculationItem.Status
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class ModelSchedulesContextReadOnly.PeriodUnit
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class AbstractInputBuilder.InputWidth
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class DMFieldInputBuilder.FieldKind
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class Matrix2D.BucketNaming
-
Returns the enum constant of this class with the specified name.
- values - Variable in class ResultMatrix.ResultMatrixBackEndCell
-
Deprecated.
- values - Variable in class ResultMatrix.ResultMatrixDownloadCell
-
Deprecated.
- values() - Static method in enum class CalculationResultType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class AggregationFormula
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class AuxLineColor
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class AuxLineType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class ChartType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class ColorAxisType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class ComparisonType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class FilterOperator
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class LimitPosition
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class LimitType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class SeriesType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class SortType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class TieredValueSortType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class TieredValueValidationType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class WaterfallColumnType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class WhiskerType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class EventType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class FieldFormatType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class InputButtonAction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class InputType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class DataType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class FieldType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class RebateAgreementStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class RebateRecordStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class CalendarUtil.TimeUnit
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class ApprovalState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class AttachedDocument.DocumentStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class CalculationStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class LookupTable.LookupTableType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class LookupTable.LookupTableValueType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class Pricelist.PricelistErrorModeType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class Pricelist.ProcessingMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class Simulation.SimulationType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class ModelParallelCalculationFormulaSummaryContext.CalculationItem.Status
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class ModelSchedulesContextReadOnly.PeriodUnit
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class AbstractInputBuilder.InputWidth
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class DMFieldInputBuilder.FieldKind
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class Matrix2D.BucketNaming
-
Returns an array containing the constants of this enum class, in the order they are declared.
- Versions - Search tag in Overview
- Section
- VERT - Enum constant in enum class AuxLineType
- VerticalLine(C, String, String) - Constructor for class AuxLine.VerticalLine
- vLookup(String) - Method in interface PublicGroovyAPI
-
Searches for a record in the Company Parameter / Price Parameter table named
parameterName
where the column 'name' matches the value entered by the user (in a drop-down input parameter) and returns the value from the column 'value'. - vLookup(String, Object) - Method in interface PublicGroovyAPI
-
Searches for a record in the Company Parameter / 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
-
Only relevant for MATRIX 1-key Company Parameter / Price Parameter tables (MLTV).
- vLookup(String, String, String, String) - Method in interface PublicGroovyAPI
-
Only relevant for MATRIX 2-key Company Parameter / Price Parameter tables (MLTV2).
- vLookup(String, String, String, String, String) - Method in interface PublicGroovyAPI
-
Only relevant for MATRIX 3-key Company Parameter / Price Parameter tables (MLTV3).
- vLookup(String, String, String, String, String, String) - Method in interface PublicGroovyAPI
-
Only relevant for MATRIX 4-key Company Parameter / Price Parameter tables (MLTV4).
- vLookup(String, String, String, String, String, String, String) - Method in interface PublicGroovyAPI
-
Only relevant for MATRIX 5-key Company Parameter / Price Parameter tables (MLTV5).
- vLookup(String, String, String, String, String, String, String, String) - Method in interface PublicGroovyAPI
-
Only relevant for MATRIX 6-key Company Parameter / Price Parameter tables (MLTV6).
- vLookup(String, String, Map) - Method in interface PublicGroovyAPI
-
This syntax can be applied to all MATRIX lookup types.
- vLookup(String, List<String>, Map) - Method in interface PublicGroovyAPI
-
This syntax can be applied to all MATRIX lookup types.
- VLookupBuilder - Class in net.pricefx.formulaengine.scripting.inputbuilder
-
Builder class for input type Lookup
InputType.LOOKUP
. - VLookupBuilder(InputBuilderContext, String) - Constructor for class VLookupBuilder
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
- WATERFALL - Enum constant in enum class ChartType
- WaterfallChart - Class in net.pricefx.common.apibuilder.chart
-
Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at 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 Class in net.pricefx.common.api.chart
- WATERFALLCOMPARISON - Enum constant in enum class ChartType
- WaterfallComparisonChart - Class in net.pricefx.common.apibuilder.chart
-
Methods of this class are mostly self-explanatory or equivalent to the Highcharts methods described at 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
- WEEK - Enum constant in enum class CalendarUtil.TimeUnit
- where(Filter...) - Method in interface DatamartContext.Query
-
Adds generic
Filter
s to the query's WHERE clause. - where(Object) - Method in interface DatamartContext.Query
-
Adds a condition to the query's WHERE clause.
- where(String...) - Method in interface DatamartContext.Query
-
Parses and ANDs one or more SQL-like conditions to the query's WHERE clause.
- 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(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(DatamartContext.DataSlice) - Method in interface DatamartContext.Query
-
Adds a condition to the query's WHERE clause.
- WhiskerType - Enum Class in net.pricefx.common.api.chart
- WILDCARD - Static variable in class DMField
- withActionLabel(String) - Method in interface NotificationApi
-
Sets the action label of notification.
- withAddStepRestrictedToWFAdmin() - Method in class WorkflowDTO
- withAddStepRestrictedToWFAdmin(boolean) - Method in class WorkflowDTO
- withAggregation(String) - Method in class AbstractChartMeasures
- withAggregation(String) - Method in class ChartMeasures.Basic
- withAggregation(AggregationFormula) - Method in class AbstractChartMeasures
- withAggregation(AggregationFormula) - Method in class ChartMeasures.Basic
- withAggregationByAsEventDataAttr() - Method in class BubbleChart.BubbleOnChartClick.BubbleTriggerEvent
-
The event attribute name will be 'aggregationBy'
- withAggregationByAsEventDataAttr() - Method in class ChartEvents.OnChartClick.ClickTriggerEvent
- withAggregationByAsEventDataAttr() - Method in class ScatterChart.ScatterOnChartClick.ScatterTriggerEvent
- withAlignment(String) - Method in interface ResultMatrix.StyledCell
-
Specify the alignment of the cell
- withAlignment(String) - Method in class ResultMatrix.ResultMatrixStyledCell
-
Deprecated.
- 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 - withAverage() - Method in class AbstractChartMeasures
- withAverage() - Method in class ChartMeasures.Basic
- withBackground(String) - Method in interface ResultMatrix.StyledCell
-
Set the background color of the cell
- withBackground(String) - Method in class ResultMatrix.ResultMatrixStyledCell
-
Deprecated.
- withBackgroundColor(String) - Method in class AttributedResult
-
Sets the background color.
- withBandByAsEventDataAttr() - Method in class BubbleChart.BubbleOnChartClick.BubbleTriggerEvent
-
The event attribute name will be 'bandBy'
- 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
- withButtonLabel(String) - Method in interface ResultMatrix.BackEndAction
- withButtonLabel(String) - Method in class ResultMatrix.ResultMatrixBackEndAction
-
Deprecated.
- withButtonTooltip(String) - Method in interface ResultMatrix.BackEndAction
- withButtonTooltip(String) - Method in class ResultMatrix.ResultMatrixBackEndAction
-
Deprecated.
- withCategoryAsEventDataAttr() - Method in interface ResultHighchart.TriggerEvent
-
Short for
withCustomEventDataAttr("category")
- withColor(String) - Method in interface ResultMatrix.StyledCell
-
Set the foreground color of the value font
- withColor(String) - Method in class ResultMatrix.ResultMatrixStyledCell
-
Deprecated.
- withColumn(String) - Method in interface ResultMatrix
-
Adds a column to the existing set of columns
- withColumn(String) - Method in class ResultMatrix
-
Deprecated.
- withColumn(String, String) - Method in interface ResultMatrix
-
Adds a column to the existing set of columns including a tooltip
- withColumn(String, String) - Method in class ResultMatrix
-
Deprecated.
- withColumnAggregation(String, Object) - Method in interface ResultMatrix
-
Aggregation strategy definition done by column name and aggregation value (ex. some constant
String
). - withColumnAggregation(String, Object) - Method in class ResultMatrix
-
Deprecated.
- withColumnAggregation(String, ResultMatrixGrouping.AggregateFunctionType) - Method in interface ResultMatrix
-
Aggregation strategy definition done by column-name-holding-numeric-values only (numericColumn) and aggregation type (aggregateFunctionType).
- withColumnAggregation(String, ResultMatrixGrouping.AggregateFunctionType) - Method in class ResultMatrix
-
Deprecated.
- withColumnAggregations(Map<String, Object>) - Method in interface ResultMatrix
-
Aggregation strategy definition done by Map with numeric columns' name and aggregation type or value.
- withColumnAggregations(Map<String, Object>) - Method in class ResultMatrix
-
Deprecated.
- withColumnFormat(String, FieldFormatType) - Method in interface ResultMatrix
-
Sets a column format for a specified column
- withColumnFormat(String, FieldFormatType) - Method in class ResultMatrix
-
Deprecated.
- withColumnFormats(Map<String, FieldFormatType>) - Method in interface ResultMatrix
-
Sets a column formats for multiple columns.
- withColumns(String...) - Method in interface ResultMatrix.BackEndAction
- withColumns(String...) - Method in class ResultMatrix.ResultMatrixBackEndAction
-
Deprecated.
- withColumns(Collection<String>) - Method in interface ResultMatrix
-
Adds columns to the existing set of columns
- withColumns(Collection<String>) - Method in class ResultMatrix
-
Deprecated.
- withColumnTooltip(String, String) - Method in interface ResultMatrix
-
Adds a tooltip to a column
- withColumnTooltip(String, String) - Method in class ResultMatrix
-
Deprecated.
- withColumnTranslation(String, Map<String, String>) - Method in interface ResultMatrix
-
Adds translated labels for the given column.
- withColumnTranslation(String, Map<String, String>) - Method in class ResultMatrix
-
Deprecated.
- withColValueAsEventDataAttr(String, String) - Method in interface ResultMatrix.OnRowSelection.TriggerEvent
- withColValueAsEventDataAttr(String, String) - Method in class ResultMatrix.ResultMatrixOnRowSelection.ResultMatrixTriggerEvent
-
Deprecated.
- withConditionRecordLogic(String) - Method in class WorkflowDTO.ApprovalStepDTO
-
Sets condition record logic name that should be run after final step is executed (i.e.
- withContextLink(String) - Method in interface NotificationApi
-
Sets the action type of the Notification to context link.
- withContextLink(String, Object) - Method in interface NotificationApi
-
Sets the action type of the Notification to context link.
- withContextLink(String, String) - Method in interface NotificationApi
-
Set action type of the Notification to context link.
- withContextLink(String, String, Object) - Method in interface NotificationApi
-
Sets the action type of the Notification to context link.
- withCSS(String) - Method in interface ResultMatrix.StyledCell
-
Apply any other valid CSS instructions to the cell
- withCSS(String) - Method in class ResultMatrix.ResultMatrixStyledCell
-
Deprecated.
- withCustomEventDataAttr(String) - Method in interface ResultHighchart.TriggerEvent
-
Pick one or more attributes of the Highchart data Point that should be included in the triggered event's payload.
- withDataMap(Map<String, Object>) - Method in class WorkflowDTO
-
Sets dataMap map, which is available then in email templates
- withDefaultConditionRecordLogic(String) - Method in class WorkflowDTO
-
Adds a logic that will be executed after the final approval step or after each approved contract recalculation.
- withDefaultFormat(FieldFormatType) - Method in interface ResultMatrix
-
Sets a default column format
- withDefaultFormat(FieldFormatType) - Method in class ResultMatrix
-
Deprecated.
- 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
-
Denial Reasons is a list of predefined text options, which will be presented to the approver, while denying the item.
- withDenialReasons(List<String>, boolean) - Method in class WorkflowDTO
- withDimensionAsEventDataAttr(String) - Method in class ChartEvents.OnCellClick.CellClickTriggerEvent
- withDimensionAsEventDataAttr(String) - Method in class ChartEvents.OnRowClick.RowClickTriggerEvent
- withDisablePreferences(boolean) - Method in interface ResultMatrix
-
Allows to disable saving preferences of the matrix grid (columns, sorting, filtering).
- withDisablePreferences(boolean) - Method in class ResultMatrix
-
Deprecated.
- withDisableSorting(boolean) - Method in interface ResultMatrix
-
Set sorting capability in UI grid
- withDisableSorting(boolean) - Method in class ResultMatrix
-
Deprecated.
- withDownloadAction(String) - Method in interface NotificationApi
-
Sets the action type of the Notification to DOWNLOAD.
- withDragDrop(boolean) - Method in class AbstractChartBuilder
- withDragDrop(boolean) - Method in interface Portlet
-
Enables or disables the drag&drop feature for portlets.
- withdraw() - Method in class CustomFormApi.DocumentActionApi
-
Finishes the withdrawal operation.
- 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 - withEmbeddedIconHidden() - Method in interface DashboardApi
-
Hides the icon which notifies users that a portlet is part of an embedded Dashboard.
- withEnableAddActions(boolean) - Method in class ConfiguratorTableInputBuilder
-
Allows you to disable adding new rows to a table within a Configurator – the 'Add' button will be hidden when
enableAddActions
is set tofalse
. - withEnableAdvancedFilter(boolean) - Method in class ConfiguratorTableInputBuilder
-
Allows you to enable or disable the advanced filter functionality.
- withEnableAdvancedFilter(boolean) - Method in class InputMatrixInputBuilder
-
Enabling the advanced filter functionality.
- withEnableClientFilter(boolean) - Method in class ConfiguratorTableInputBuilder
-
Allows a user to filter the table by row values.
Default =true
(the filtering is enabled). - withEnableClientFilter(boolean) - Method in class InputMatrixInputBuilder
-
Allows a user to filter the table by row values.
Default =true
(the filtering is enabled). - withEnableClientFilter(boolean) - Method in interface ResultMatrix
- withEnableClientFilter(boolean) - Method in class ResultMatrix
-
Deprecated.
- withEnableDeleteActions(boolean) - Method in class ConfiguratorTableInputBuilder
-
Allows a user to delete table rows.
Default =true
(deleting is enabled). - withEnableDuplicateActions(boolean) - Method in class ConfiguratorTableInputBuilder
-
Allows a user to duplicate table rows.
Default =true
(duplicating a row is enabled). - withEnableEditActions(boolean) - Method in class ConfiguratorTableInputBuilder
-
Allows a user to edit values in the table.
Default =true
(the editing is enabled). - withEnableGroupByControls(boolean) - Method in interface ResultMatrix
-
Enables or disables the "Group by" controls.
- withEnableGroupByControls(boolean) - Method in class ResultMatrix
-
Deprecated.
- withErrorStatus() - Method in interface NotificationApi
-
Sets the status of the Notification to ERROR.
- withEscapeHTML(boolean) - Method in interface ResultMatrix
-
Set HTML escaping flag.
- withEscapeHTML(boolean) - Method in class ResultMatrix
-
Deprecated.
- withEventDataAttr(String) - Method in interface DashboardApi
-
Allows to expose event payload - attribute of the specified name - as a parameter that can be read in the embedded dashboard.
- withExcludeSubmitter(boolean) - Method in class WorkflowDTO.ApprovalStepDTO
-
Set exclude submitter
- withExpandedGroups(Collection<String>) - Method in interface ResultMatrix
-
Definition of columns' names dedicated for expand level while grouping (same for each row, nested levels are not supported).
Columns passed in the collection need to be present inResultMatrix
groupBy's attribute.
If, at least one column, is not part of theResultMatrix
groupBy's attribute, theResultMatrixGroupingException.NotPartOfGroupByAttributeException
will be thrown.
If global expand data in grouping is off (ResultMatrix.isGroupByDataExpanded()
equals to false) thenResultMatrix.getExpandedGroups()
will be ignored. - withExpandedGroups(Collection<String>) - Method in class ResultMatrix
-
Deprecated.
- withExpression() - Method in class AbstractChartMeasures
- withExpression() - Method in class NonAggrFieldAxis
- withFailureMessage(String) - Method in interface ResultMatrix.BackEndAction
- withFailureMessage(String) - Method in class ResultMatrix.ResultMatrixBackEndAction
-
Deprecated.
- withField() - Method in class BoxplotChart.BoxplotAdditionalMeasure
- withField() - Method in class NonAggrFieldAxis
- withFontWeight(String) - Method in interface ResultMatrix.StyledCell
-
Set the font weight (in standard CSS terms) of the value text
- withFontWeight(String) - Method in class ResultMatrix.ResultMatrixStyledCell
-
Deprecated.
- withFormatting(String) - Method in interface ResultMatrix.StyledCell
-
Set the regular expression formatting of the cell.
- withFormatting(String) - Method in class ResultMatrix.ResultMatrixStyledCell
-
Deprecated.
- withFormula() - Method in class AbstractChartMeasures
- withFormula() - Method in class ChartMeasures.Basic
- withFormulaParameters(HashMap<String, Object>) - Method in class LivePriceGridAction
-
Allows you to add parameters entering to the calculation.
- withFrozenColumns(Collection<String>) - Method in interface ResultMatrix
-
Sets the specified columns as frozen.
- withFrozenColumns(Collection<String>) - Method in class ResultMatrix
-
Deprecated.
- withGroupBy(Collection<String>) - Method in interface ResultMatrix
-
Definition of columns' names dedicated for grouping.
- withGroupBy(Collection<String>) - Method in class ResultMatrix
-
Deprecated.
- withGroupByAsEventDataAttr() - Method in class ScatterChart.ScatterOnChartClick.ScatterTriggerEvent
-
Historical method name, prefer
ScatterChart.ScatterOnChartClick.ScatterTriggerEvent.withAggregationByAsEventDataAttr()
. - withGroupByColumnLabel(String) - Method in interface ResultMatrix
-
Sets a custom label for the Group column in the ResultMatrix table.
- withGroupByColumnLabel(String) - Method in class ResultMatrix
-
Deprecated.
- withGroupByDataExpanded(boolean) - Method in interface ResultMatrix
-
Definition of global group by data expand.
- withGroupByDataExpanded(boolean) - Method in class ResultMatrix
-
Deprecated.
- withHeight(int) - Method in class AbstractChartBuilder
- withHeight(int) - Method in interface Portlet
-
Builder style method for setting the height in pixels.
- withHeight(int, String) - Method in class AbstractChartBuilder
- withHeight(int, String) - Method in interface Portlet
-
Builder style method for setting the height in supported units.
- withId(Long) - Method in class ActionItemApi
-
Initiates an operation with an existing Action Item (specified by ID).
- withId(Long) - Method in class CustomFormApi
-
Initiates an operation with an existing Custom Form by id.
- withInfoStatus() - Method in interface NotificationApi
-
Sets the status of the Notification to INFO.
- withInputsHidden() - Method in interface DashboardApi
-
Optionally hides all embedded Dashboard input parameters from the Unity UI's inputs panel.
- withInputsHidden(boolean) - Method in interface DashboardApi
-
Optionally hides all embedded Dashboard input parameters from the Unity UI's inputs panel.
- withInterpolatedColorAxis() - Method in class HeatmapChart.HeatmapOptions
- withLabel(String) - Method in class CreationWorkflowStepDefinition
-
Sets the label of the Creation Workflow step (the
CreationWorkflowStepDefinition
object).
Example: - withLayout(int, int) - Method in class AbstractChartBuilder
- withLayout(int, int) - Method in interface Portlet
-
Builder style method for setting width and height in pixels.
- withLayout(int, int, String) - Method in class AbstractChartBuilder
- withLayout(int, int, String) - Method in interface Portlet
-
Builder style method for setting width and height in specified units.
- withLayout(int, int, String, String) - Method in class AbstractChartBuilder
- withLine() - Method in class AuxLine
- withLinkAction(String) - Method in interface NotificationApi
-
Sets the action type of the Notification to LINK.
- withLogicName(String) - Method in interface ResultMatrix.BackEndAction
-
Specifies the logic that is executed as a BackEndAction logic within
ResultMatrix.rowSelectionBackEndAction(String)
.
Note: This method refers to the generic nature of the logic. - withLogicName(String) - Method in class ResultMatrix.ResultMatrixBackEndAction
-
Deprecated.
- 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 that the user can pick from (vs. default free-style data entry) IMPORTANT NOTE: This is meant to list a few options only.
- withMessage(String) - Method in interface NotificationApi
-
Specifies the message of the Notification.
- withMessageLinkAction(String) - Method in interface NotificationApi
-
Sets the action type of the Notification to the message link.
- 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.
- withNameAsEventDataAttr() - Method in interface ResultHighchart.TriggerEvent
-
Short for
withCustomEventDataAttr("name")
- withNoAction() - Method in interface NotificationApi
-
Sets the action type of the Notification to INFO_MESSAGE.
- withNotificationOnlyToUsers(String...) - Method in class WorkflowDTO.ApprovalStepDTO
-
Subset of approvers that should receive the email notification
- withOptions(String, Map<String, Object>) - Method in interface ResultMatrix.BackEndAction
- withOptions(String, Map<String, Object>) - Method in class ResultMatrix.ResultMatrixBackEndAction
-
Deprecated.
- withParallelStepApprovalAllowed(boolean) - Method in class WorkflowDTO.ApprovalStepDTO
- 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.
- withPreferenceName(String) - Method in class ConfiguratorTableInputBuilder
-
Defines the preference name (whitespace and non-alphanumeric will be dropped).
- withPreferenceName(String) - Method in class InputMatrixInputBuilder
-
Defines the preference name (whitespace and non-alphanumeric will be dropped).
- withPreferenceName(String) - Method in interface ResultMatrix
-
Sets the so-called preference name.
- withPreferenceName(String) - Method in class ResultMatrix
-
Deprecated.
- withPreferences(Map<String, Object>) - Method in interface DashboardApi
-
Hides the preferences menu and use the provided properties map instead of loading any saved preferences.
- withRangedColorAxis() - Method in class HeatmapChart.HeatmapOptions
- withRawCSS(String) - Method in class AttributedResult
-
Adds any valid CSS style to the cell.
- withReason(String) - Method in class CustomFormApi.DocumentActionApi
-
To pass a String reason to submit() method for the WorkFlow logic.
- withReason(String) - Method in class CustomFormApi.WorkflowActionApi
-
Allow to include a reason / comment for the workflow action.
- withReasons(String...) - Method in class WorkflowDTO.ApprovalStepDTO
-
Sets explanation reasons for approvers of the approval step.
- withReasons(String...) - Method in class WorkflowDTO.WatcherStepDTO
-
Sets explanations for the watcher step.
- withRecalculateParentOnPopupConfirm(boolean) - Method in class CustomFormListPopupInputBuilder
-
Recalculates the parent document when a user confirms the pop-up dialog.
- withRecipient(Long) - Method in interface NotificationApi
-
Sets the recipient of the Notification.
- withRecipient(String) - Method in interface NotificationApi
-
Sets the recipient of the Notification.
- withRecipient(List<Long>) - Method in interface NotificationApi
-
Sets recipients of the notification.
- withRecipientLogin(List<String>) - Method in interface NotificationApi
-
Sets recipients of the notification.
- withResizing(boolean) - Method in class AbstractChartBuilder
- withResizing(boolean) - Method in interface Portlet
-
Enables or disables the resizing feature for portlets.
- withRow(List<Object>) - Method in interface ResultMatrix
-
Adds a data row.
- withRow(List<Object>) - Method in class ResultMatrix
-
Deprecated.
- withRows(List<Map<String, Object>>) - Method in interface ResultMatrix
-
Adds multiple data rows.
- withRows(List<Map<String, Object>>) - Method in class ResultMatrix
-
Deprecated.
- withRowTypes(List<Object>) - Method in class ConfiguratorTableInputBuilder
-
Specifies row types that can be added to the ConfiguratorTable when a user clicks the 'Add' button to add a row.
Row types are specified by a list of maps, where each map contains thelabel
andurl
parameters. - withRunDefaultPostApprovalStepLogicOnEmptyWorkflow(boolean) - Method in class WorkflowDTO
-
Decides if default post step logic should be executed also in case the wf has no approval steps (i.e. empty or all steps are watcher steps).
- withSelectStepOnDeny(boolean) - Method in class WorkflowDTO
- withShouldSendNotification(boolean) - Method in class CreationWorkflowStepDefinition
-
Set to
false
to not send the notification to users when the document with assigned users or user groups is created.
Default:true
- withShowGroupByColumns(boolean) - Method in interface ResultMatrix
-
Sets the visibility of the Group By columns in the ResultMatrix.
- withShowGroupByColumns(boolean) - Method in class ResultMatrix
-
Deprecated.
- withShowGroupByControls(boolean) - Method in interface ResultMatrix
-
Sets whether "Group by" controls are completely hidden.
- withShowGroupByControls(boolean) - Method in class ResultMatrix
-
Deprecated.
- 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 BoxplotChart.BoxplotSeries
- 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
- withSource(String) - Method in interface NotificationApi
-
Sets the source of the Notification.
- withSteppedLine() - Method in class AuxLine
- withSteps(CreationWorkflowStepDefinition...) - Method in class CreationWorkflowDefinition
-
Adds specified steps (must be already defined within the logic) to the Creation Workflow.
- withSubsetFilter(Filter) - Method in class CustomFormListPopupInputBuilder
-
Allows you to set a filter criteria to filter Custom Forms that will be visible in the pop-up modal.
- withSuccessMessage(String) - Method in interface ResultMatrix.BackEndAction
- withSuccessMessage(String) - Method in class ResultMatrix.ResultMatrixBackEndAction
-
Deprecated.
- withSuccessStatus() - Method in interface NotificationApi
-
Sets the status of the Notification to SUCCESS.
- withSuffix(String) - Method in class AttributedResult
-
Sets a suffix to be appended to the result.
- withTargetDate(Date) - Method in interface ResultMatrix.BackEndAction
- withTargetDate(Date) - Method in class ResultMatrix.ResultMatrixBackEndAction
-
Deprecated.
- 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.
- withTitle(String) - Method in interface ResultMatrix
-
Sets the title that will be shown as window title of the result matrix in the client
- withTitle(String) - Method in interface NotificationApi
-
Sets the title of the Notification.
- withTitle(String) - Method in class ResultMatrix
-
Deprecated.
- withToolTip(String) - Method in interface ResultMatrix.StyledCell
-
Show a tooltip text in the cell
- withToolTip(String) - Method in class ResultMatrix.ResultMatrixStyledCell
-
Deprecated.
- withTotal() - Method in class AbstractChartMeasures
- withTotal() - Method in class ChartMeasures.Basic
- withTotalRow(Object) - Method in interface ResultMatrix
-
Assigns any data to the
totalRow
property within the ResultMatrix. - withTotalRow(Object) - Method in class ResultMatrix
-
Deprecated.
- withTrendLine() - Method in class AbstractChartSeries
- withTrendLine() - Method in class BubbleChart.BubbleSeries
- withTrendLine() - Method in class ScatterChart.ScatterSeries
- withTrendLine() - Method in class TimeSeriesChart.TimeSeriesSeries
- withUser(String) - Method in class CustomFormApi.DocumentActionApi
-
To pass a
User
's login name as the WorkFlow logic submitter.
NOTE: works only forCustomFormApi.DocumentActionApi.submit()
- withUser(String) - Method in class CustomFormApi.WorkflowActionApi
-
To pass a
User
's login name as the WorkFlow logic approver/denier.
NOTE: works only forCustomFormApi.WorkflowActionApi.approve()
andCustomFormApi.WorkflowActionApi.deny()
- withUserAssignee(String) - Method in class CreationWorkflowStepDefinition
-
Assigns a user to the Creation Workflow Step.
- withUserAssignees(String...) - Method in class CreationWorkflowStepDefinition
-
Assigns one or more users to the Creation Workflow Step.
- 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 - withUserGroupAssignee(String) - Method in class CreationWorkflowStepDefinition
-
Assigns a user group to the Creation Workflow Step.
- withUserGroupAssignees(String...) - Method in class CreationWorkflowStepDefinition
-
Assigns one or more user groups to the Creation Workflow Step.
- withUserGroupId(Long) - Method in interface NotificationApi
-
Sets the user group as the recipient of the notification.
- withUserGroupId(List<Long>) - Method in interface NotificationApi
-
Sets user groups as recipients of the notification.
- withUserGroupUqName(String) - Method in interface NotificationApi
-
Sets the user group as the recipient of the notification.
- withUserGroupUqName(List<String>) - Method in interface NotificationApi
-
Sets user groups as recipients of the notification.
- 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 CreationWorkflowStepDefinition
-
Assigns user group(s) as watchers to the Creation Workflow Step.
Example: - 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 CreationWorkflowStepDefinition
-
Adds users as watchers to the Creation Workflow Step.
Example: - 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
- withWarningStatus() - Method in interface NotificationApi
-
Sets the status of the Notification to WARNING.
- withWhisker(WhiskerType) - Method in class BoxplotChart.BoxplotSeries
- withWidth(int) - Method in class AbstractChartBuilder
- withWidth(int) - Method in interface Portlet
-
Builder style method for setting the width in pixels.
- withWidth(int, String) - Method in class AbstractChartBuilder
- withWidth(int, String) - Method in interface Portlet
-
Builder style method for setting the width in supported units.
- withXAsEventDataAttr() - Method in class BarLineChart.BarLineOnChartClick.BarLineTriggerEvent
- withXAsEventDataAttr() - Method in class ChartEvents.OnChartClick.ClickTriggerEvent
- withXAsEventDataAttr() - Method in interface ResultHighchart.TriggerEvent
-
Short for
withCustomEventDataAttr("x")
- withYAsEventDataAttr() - Method in interface ResultHighchart.TriggerEvent
-
Short for
withCustomEventDataAttr("y")
- workflow - Variable in class WorkflowDTO.StepDTO
- WORKFLOW - Enum constant in enum class CalculationResultType
- WORKFLOW_MESSAGE - Enum constant in enum class EventType
-
Whenever an approver approves (or denies) an Approval Step
- WORKFLOW_SUBMIT - Enum constant in enum class EventType
-
When an approvable document is submitted
- workflowAction() - Method in class CustomFormApi.OperationsApi
-
Initiates a workflow action operation.
- WorkflowActionApi(FormulaEngineContext, Long, CustomFormServiceProperties, CustomFormService, PersistedObjectService) - Constructor for class CustomFormApi.WorkflowActionApi
- WorkflowDTO - Class in net.pricefx.common.dto
-
This class is basically the type of object, which is exposed in the workflow logic by the binding variable
workflow
- WorkflowDTO(WorkflowType, String) - Constructor for class WorkflowDTO
- WorkflowDTO(WorkflowType, String, String, boolean) - Constructor for class WorkflowDTO
- WorkflowDTO.ApprovalStepDTO - Class in net.pricefx.common.dto
- WorkflowDTO.StepDTO<T> - 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 logic result.
- WrappedResult(Object) - Constructor for class WrappedResult
- writeKV(String, Map<String, Object>, Object) - Method in interface PublicGroovyAPI
-
Writes a payload (or overwrites the existing one) into the specified table by means of the primary key.
- writeKV(String, Map<String, Object>, String) - Method in interface PublicGroovyAPI
-
Writes a payload string (or overwrites the existing one) into the specified table by means of the primary key.
- writeKVBulk(String, List<String>, List<List>) - Method in interface PublicGroovyAPI
-
Writes larger data sets into the specified table (comparable to loaddata).
X
- XYLabels(C, String) - Constructor for class ChartOptions.XYLabels
- XYMinMax(C, String) - Constructor for class ChartOptions.XYMinMax
Y
- YEAR - Enum constant in enum class CalendarUtil.TimeUnit
- YEAR - Enum constant in enum class ModelSchedulesContextReadOnly.PeriodUnit
- YELLOW - Enum constant in enum class AuxLineColor
- 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
_
- _getInput() - Method in class AbstractInputBuilder
- _getInput() - Method in class ButtonInputBuilder
- _getInput() - Method in class CollapseInputBuilder
- _getInput() - Method in class ConfiguratorInputBuilder
- _getInput() - Method in class ConfiguratorTableInputBuilder
- _getInput() - Method in class CustomerInputBuilder
- _getInput() - Method in class CustomFormListPopupInputBuilder
- _getInput() - Method in class DashboardInputsInputBuilder
- _getInput() - Method in class DashboardPopupInputBuilder
- _getInput() - Method in class DateRangeInputBuilder
- _getInput() - Method in class DMFieldInputBuilder
- _getInput() - Method in class DmFilter
- _getInput() - Method in class DmQueryBuilderInputBuilder
- _getInput() - Method in class DMSourceInputBuilder
- _getInput() - Method in class FilterBuilderInputBuilder
- _getInput() - Method in class InputMatrixInputBuilder
- _getInput() - Method in class MultiTierInputBuilder
- _getInput() - Method in class OptionInputBuilder
- _getInput() - Method in class PCGroupInputBuilder
- _getInput() - Method in class ProductInputBuilder
- _getInput() - Method in class ResultMatrixFilterBuilder
- _getInput() - Method in class RowInputBuilder
- _getInput() - Method in class SellerInputBuilder
- _getInput() - Method in class SimpleInputBuilder
- _getInput() - Method in class SliderInputBuilder
- _getInput() - Method in class StringInputBuilder
- _getInput() - Method in class VLookupBuilder
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
InputBuilderFactory.createAnyUserEntry(String)
instead.