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

A

abortCalculation() - Method in interface PublicGroovyAPI
Aborts the current item's calculation.
AbstractResultMatrixCell() - Constructor for class ResultMatrix.AbstractResultMatrixCell
 
add(Filter) - Method in class Filter
Used with OP_OR and OP_AND filters.
add(String, int, String) - Method in interface DatamartContext.Calendar
Parses the a period string and offsets the start date of the resulting TimePeriod with a number of TimeUnits.
add(Map<?, ?>...) - Method in interface IRebateRecordManager
Add a RR to the current RA.lineitem with the default name and optional initial generic attribute values
add(String, Map<?, ?>...) - Method in interface IRebateRecordManager
Add a RR to the current RA.lineitem with the given name and optional initial generic attribute values
add(String, String, Map<?, ?>...) - Method in interface IRebateRecordManager
Add a RR in the given RR-set to the current RA.lineitem with the given name and optional initial generic attribute values If the RR-set with the given label does not yet exist, it will be created as a side-effect.
add(String, Map<String, Object>) - Method in interface PublicGroovyAPI
Adds a new object to collection of objects of given type.
addApprovalStep(String) - Method in class WorkflowDTO
Adds an approval step at the end of the workflow
addBackendCall(String, String) - Method in class DashboardController
Performs a backend call in the user's context (i.e.
addBackendCall(String, String, String) - Method in class DashboardController
Performs a backend call in the user's context (i.e.
addBackendCall(String, String, String, String, String) - Method in class DashboardController
Performs a backend call in the user's context (i.e.
addButton(String, String) - Method in class DashboardController
Adds a button to the controller
addButton(String, String, Object) - Method in class DashboardController
Adds a button to the controller
addButton(String, String, Object, Object) - Method in class DashboardController
Adds a button to the controller
addColumn(String) - Method in class ResultMatrix
Adds a column to the existing set of columns
addColumns(Collection<String>) - Method in class ResultMatrix
Adds columns to the existing set of columns
addFilter(Filter) - Method in interface DatamartContext.DataSlice
 
addFolder(String) - Method in class QuoteStructure
Creates and adds a new folder
addHTML(String) - Method in class DashboardController
Adds a HTML snippet into the controller
addItemReason(String, String) - Method in class WorkflowDTO
 
addLineItem(String) - Method in class CalculableLineItemCollectionBuilder
This method adds a new line item in the root folder
addLineItem(String, String) - Method in class CalculableLineItemCollectionBuilder
This method adds a new line item in the specified parent (folder id)
addLineItemWithId(String, String) - Method in class RATBuilder.RABuilder
 
addLineItemWithId(String, String, String) - Method in class RATBuilder.RABuilder
 
addOrUpdate(String, Map<String, Object>) - Method in interface PublicGroovyAPI
Adds or updates object in collection of objects of given type.
addOrUpdateInput(Map<String, Object>) - Method in class CalculableLineItemCollectionBuilder
This method adds or updates an input value on the root level
addOrUpdateInput(String, Map<String, Object>) - Method in class CalculableLineItemCollectionBuilder
This method adds or updates an input value on a line item
addOrUpdateOutput(Map<String, Object>) - Method in class CalculableLineItemCollectionBuilder
This method adds or updates a result value (an output value) on the root level
addOrUpdateOutput(String, Map<String, Object>) - Method in class CalculableLineItemCollectionBuilder
This method adds or updates a result value (an output value) on a line item
addParameterConfigEntry(String, Object) - Method in class ContextParameter
 
addPart(String) - Method in class QuoteStructure
Creates and adds a new part
addProperty(String, Object) - Method in class WorkflowDTO.ApprovalStepDTO
 
addProperty(String, Object) - Method in class WorkflowDTO.WatcherStepDTO
 
addQuoteStructure(QuoteStructure) - Method in class QuoteBuilder
Apply a quote structure.
addRow(Map<String, Object>) - Method in interface DatamartContext.DataLoader
Adds a row to the data buffer that will ultimately be loaded in the feed table.
addRow(List<Object>) - Method in interface DatamartContext.DataLoader
Adds a row to the data buffer that will ultimately be loaded in the feed table.
addRow(Object...) - Method in interface DatamartContext.DataLoader
Adds a row to the data buffer that will ultimately be loaded in the feed table.
addRow(Map<String, Object>) - Method in class ResultMatrix
Adds a data row.
addRow(List<Object>) - Method in class ResultMatrix
Adds a data row.
addRow(Object...) - Method in class ResultMatrix
Adds a data row.
addSector(BigDecimal, String) - Method in class ResultGauge
Add a GaugeSector contained in this Gauge.
addWarning(String) - Method in interface PublicGroovyAPI
Adds a warning to the formula execution warning log
addWatcherStep(String) - Method in class WorkflowDTO
Adds a watcher step to the end of the workflow.
alignment - Variable in class ResultMatrix.ResultMatrixStyledCell
 
all(String, Filter) - Static method in class Filter
Create a new Filter using the ALL operator.
and(Filter...) - Static method in class Filter
Create a new Filter using the AND operator.
applyPlaceholder(String, Object) - Method in class RATBuilder.RABuilder
 
applyType(InputType) - Method in class ContextParameter
 
ApprovalStepDTO(WorkflowDTO, String) - Constructor for class WorkflowDTO.ApprovalStepDTO
 
asLink() - Method in interface IRebateRecordManager
Return a clickable link to the RR with the default name, as the result of a formula element
asLink(String) - Method in interface IRebateRecordManager
Return a clickable link to the RR with the given name, as the result of a formula element
asLink(String, String) - Method in interface IRebateRecordManager
Return a clickable link to the RR for the given name and RR-set, as the result of a formula element
asResultMatrix(String...) - Method in interface IRebateRecordManager
Return a ResultMatrix listing all RRs in the agreement, optionally the fields/attributes to be shown as matrix columns.
attributedResult(Object) - Method in interface PublicGroovyAPI
Creates an AttributedResult object to be returned as a result of an output element.
AttributedResult - Class in net.pricefx.server.dto.calculation
Provides means for output elements' formatting.
AttributedResult(Object) - Constructor for class AttributedResult
 
AttributedResult(Object, Map<String, Object>) - Constructor for class AttributedResult
 

B

background - Variable in class ResultMatrix.ResultMatrixStyledCell
 
BasicRebateAgreementBuilder<T extends BasicRebateAgreementBuilder> - Class in net.pricefx.common.apibuilder.rebateagreement
Created by petercipov on 22/03/16.
BasicRebateAgreementBuilder(String, String, ObjectIdentity, IdGenerator, Invocations<MethodInvocation>, HeaderPhase) - Constructor for class BasicRebateAgreementBuilder
 
bom() - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "BoM" function.
bom(String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "BoM" function.
bom(String, String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "BoM" function.
bom(String, String, String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "BoM" function.
bomList() - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "BoMList" function.
booleanUserEntry(String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "BooleanUserEntry" function.
boundCall(String, String, String, Boolean...) - Method in interface PublicGroovyAPI
Issues HTTP/S call to price fx server.
build() - Method in class ContractBuilder
 
build() - Method in class QuoteBuilder
 
build() - Method in class BasicRebateAgreementBuilder
 
build() - Method in class RATBuilder
 
buildDataTableChart(String, String) - Method in interface IRebateRecordManager
Deprecated.
buildFlexChart(Object) - Method in interface PublicGroovyAPI
buildFlexChart(String, Object) - Method in interface PublicGroovyAPI
Creates a FlexChart from the passed definition by merging it with options defined within the baseTemplateToUse template.

C

CalculableLineItemCollectionBuilder<T extends CalculableLineItemCollectionBuilder> - Class in net.pricefx.common.apibuilder.clicoll
 
CalculableLineItemCollectionBuilder(String, String, ObjectIdentity, IdGenerator, Invocations<MethodInvocation>, HeaderPhase) - Constructor for class CalculableLineItemCollectionBuilder
 
calculateSummaryStatistics() - Method in interface DatamartQueryResult
Calculates basic summary statistics on the query result data: 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.
calendar() - Method in interface DatamartContext
Instantiate a PA Calendar utility object.
calendar() - Method in interface PublicGroovyAPI
Gets a calendar object intialized with the current targetDate (or now if no target date is given)
calendar(Date) - Method in interface PublicGroovyAPI
Gets a calendar object intialized with date
clear() - Method in interface DatamartContext.DataSlice
 
clearAttribute(String) - Method in class AttributedResult
 
clearConfigParameter(String) - Method in class ContextParameter
 
close() - Method in interface StreamResults
Releases the often significant resources required to provide access to the query result set.
color - Variable in class ResultMatrix.ResultMatrixStyledCell
 
com.googlecode.genericdao.search - package com.googlecode.genericdao.search
 
configurator(String, String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "Configurator" function.
ConfiguratorEntry - Class in net.pricefx.server.dto.calculation
This class is used to transport a configurator entry
ConfiguratorEntry() - Constructor for class ConfiguratorEntry
 
containsAttribute(String) - Method in class AttributedResult
 
contextByLabel(String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "ContextByLabel" function.
contextName() - Method in interface PublicGroovyAPI
The name of the current context.
ContextParameter - Class in net.pricefx.server.dto.calculation
 
ContextParameter() - Constructor for class ContextParameter
 
ContextParameter(InputType, String, Date, PersistedObjectService) - Constructor for class ContextParameter
 
ContextParameter(LookupTable, Date) - Constructor for class ContextParameter
 
ContextParameter(LookupTable, Date, String) - Constructor for class ContextParameter
 
ContextParameter(String, DMFieldCollection, String, 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
ContractBuilder - Class in net.pricefx.common.apibuilder.contract
 
ContractHelper - Class in net.pricefx.common.apibuilder.contract
 
ContractHelper(Map<String, Object>) - Constructor for class ContractHelper
 
ControllerItem() - Constructor for class DashboardController.ControllerItem
 
copyWithoutValue() - Method in class ContextParameter
 
count(String, Filter...) - Method in interface PublicGroovyAPI
Similar to the PublicGroovyAPI.find(java.lang.String, com.googlecode.genericdao.search.Filter...) methods this method querys an arbitrary object type.
createConfiguratorEntry(InputType, String) - Method in interface PublicGroovyAPI
Creates a cofigurator entry object and adds the specified input parameter as first parameter to the configurator entry If the parameter had a value in the previous round trip, that value is set automatically
createConfiguratorEntry(InputType, String, Date) - Method in interface PublicGroovyAPI
Creates a cofigurator entry object and adds the specified input parameter as first parameter to the configurator entry If the parameter had a value in the previous round trip, that value is set automatically
createConfiguratorEntry() - Method in interface PublicGroovyAPI
Creates an empty configurator entry object.
createConfiguratorEntryArray(Object...) - Method in interface PublicGroovyAPI
Creates configurator entry array object which is to be returned from formula element.
createDWTable(String, Table) - Method in interface DatamartContext
 
createDWTableFromCustomerExtension(String, String) - Method in interface DatamartContext
 
createDWTableFromCustomerMaster(String) - Method in interface DatamartContext
 
createDWTableFromLookupTable(String, Long) - Method in interface DatamartContext
 
createDWTableFromProductExtension(String, String) - Method in interface DatamartContext
 
createDWTableFromProductMaster(String) - Method in interface DatamartContext
 
createDWTableFromQuery(String, DatamartContext.Query) - Method in interface DatamartContext
 
createElementNameFilter(String, Object, String...) - Method in interface PublicGroovyAPI
Creates a cross-list filter expression based on meta data.
createFolder(String) - Method in class QuoteStructure
Creates a new folder item, but does not add it to the list
createParameter(InputType, String) - Method in class ConfiguratorEntry
 
createParameter(InputType, String, Date) - Method in class ConfiguratorEntry
 
createPart(String) - Method in class QuoteStructure
Creates a new "part" item but does not add it
criticalAlert(String) - Method in interface PublicGroovyAPI
Marks the current formula element with a critical alert and the given message
currentContext(String) - Method in interface PublicGroovyAPI
In case of list processing (such as a price list or a price grid) this method allows easy access to values from the same list.
currentContext(String, String) - Method in interface PublicGroovyAPI
In case of list processing (such as a price list or a price grid) this method allows easy access to values from the same list.
currentItem() - Method in interface PublicGroovyAPI
In case of a list processing operation this method gets the currently worked on record (e.g.
currentItem(String) - Method in interface PublicGroovyAPI
Same as PublicGroovyAPI.currentItem() but just returns the specified attribute
currentItemByElementName(String) - Method in interface PublicGroovyAPI
In case of a list processing operation this method gets the currently worked on record's property by elementName
currentPartitionName() - Method in interface PublicGroovyAPI
Returns the current partition name
custom(String) - Static method in class Filter
Create a new Filter using a custom JPQL/HQL expression.
custom(String, Object...) - Static method in class Filter
Create a new Filter using a custom JPQL/HQL expression.
custom(String, Collection<?>) - Static method in class Filter
Create a new Filter using a custom JPQL/HQL expression.
customer(String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "Customer" function.
customer(String, boolean) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "Customer" function.
customer(String, String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "Customer" function.
customer(String, String, boolean) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "Customer" function.
customerExtension(String, Filter...) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "CXLookup" function.
customerGroupEntry(String...) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "CustomerGroup" function.
customerToRelatedObjectsFilter(String, String) - Method in interface PublicGroovyAPI
Creates a filter to be applied to a search on a related object type, limiting the result to objects of the related type that have a link to the given customer.
customEvent(Object) - Method in interface PublicGroovyAPI
Sends an event of type "CUSTOM".
customEvent(Object, String) - Method in interface PublicGroovyAPI
Sends an event of type "CUSTOM".
customEvent(Object, String, String) - Method in interface PublicGroovyAPI
Sends an event of type "CUSTOM".

D

DashboardController - Class in net.pricefx.server.dto.calculation
This class is used to generate the definition of a so called controller dashboard portlet (or wizard).
DashboardController() - Constructor for class DashboardController
 
DashboardController.ControllerItem - Class in net.pricefx.server.dto.calculation
 
DashboardController.ControllerItemType - Enum in net.pricefx.server.dto.calculation
 
datamartCalendar() - Method in interface PublicGroovyAPI
Deprecated.
DatamartContext - Interface in net.pricefx.formulaengine
Provides an API to query and load PA data from a formula context.
DatamartContext.Calendar - Interface in net.pricefx.formulaengine
Helper class mainly, but not solely, for working with dates and time periods as used in the PA module.
DatamartContext.DataLoader - Interface in net.pricefx.formulaengine
API for DataFeed loading from a formula context.
DatamartContext.DataSlice - Interface in net.pricefx.formulaengine
A DataSlice defines a set of filters to be applied to a PA DataSet (Datamart, DataSource...).
DatamartContext.Query - Interface in net.pricefx.formulaengine
API for building a PA query in a formula context.
datamartFilter(Object) - Method in interface PublicGroovyAPI
Translates a CustomerGroup/ProductGroup/DMDataSlice to its equivalent Filter representation, mapping domain level field names to the corresponding Datamart field names in the process.
datamartFilterBuilderUserEntry(String, String) - Method in interface PublicGroovyAPI
Deprecated.
Now provided by DatamartContext.
datamartLookup(Object...) - Method in interface PublicGroovyAPI
Important: please use the groovy query API instead (see DatamartContext).
datamartQuery(Object...) - Method in interface PublicGroovyAPI
Important: please use the groovy query API instead (see DatamartContext).
DatamartQueryResult - Interface in net.pricefx.formulaengine
Provides access to a QueryResult in a formula context.
dateTimeUserEntry(String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "DateTimeUserEntry" function.
dateUserEntry(String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "DateUserEntry" function.
delete(String, Map<String, Object>) - Method in interface PublicGroovyAPI
Deletes object in collection of objects of given type.
determineDistinctValues(String, String) - Method in interface DatamartQueryResult
Adds the set of distinct values for the specified projections to the Summary map, in summary.distinctValuesFor_.
dimFilterEntry(String, Column) - Method in interface DatamartContext
DimFilter input parameter: renders a selection of all possible values for the given dimension field, in the FC which the column's table represents.
dimFilterEntry(String, Column, String) - Method in interface DatamartContext
DimFilter input parameter: renders a selection of all possible values for the given dimension field, in the FC which the column's table represents.

E

editabilityStatus - Variable in class QuoteStructure.Item
 
emailAttachment - Variable in class WorkflowDTO.StepDTO
Signals that approvable should be exported and attached to email in the given step
emit(Object) - Method in interface PublicGroovyAPI
Emits an object to be consumed by an external thread.
emitPersistedObject(String) - Method in interface PublicGroovyAPI
Finds the PersistedObject with the given typedId, and emits it if it exists.
emitPersistedObject(String, Long) - Method in interface PublicGroovyAPI
Finds the PersistedObject for the given typeCode 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 formulaa accepting each emitted RebateRecord as its currentItem context, and distributing one or more RebateRecord accruals over the set of PA rows havong contributed to those accruals in some way (by revenue, bvolume...).
entityRef(PartitionedObject) - Method in interface PublicGroovyAPI
Create entityRef value (usually db id) for given entity.
equal(String, Object) - Static method in class Filter
Create a new Filter using the == operator.
equals(Object) - Method in class Filter
 
equals(Object) - Method in class WorkflowDTO.StepDTO
 
equals(Object) - Method in class ContextParameter
 
evalExpression(String) - Method in interface PublicGroovyAPI
Evaluates a arithmetic expression that is passed in as a string.
exclude(CustomerGroup) - Method in interface DatamartContext.DataSlice
 
exclude(ProductGroup) - Method in interface DatamartContext.DataSlice
 
exclude(CalendarUtil.TimePeriod) - Method in interface DatamartContext.DataSlice
 
executeQuery(DatamartContext.Query) - Method in interface DatamartContext
Executes the given DatamartContext.Query.
extraCSS - Variable in class ResultMatrix.ResultMatrixStyledCell
 

F

fieldSelectionEntry(String, Table, String) - Method in interface DatamartContext
FC field selector, optionally limited to fields of a given type.
fieldSelectionEntry(String, Table, String, Boolean) - Method in interface DatamartContext
FC field selector, optionally limited to fields of a given type.
Filter - Class in com.googlecode.genericdao.search
A Filter is used by the Search class to specify a restriction on what results should be returned in the search.
Filter() - Constructor for class Filter
 
Filter(String, Object, int) - Constructor for class Filter
 
Filter(String, Object) - Constructor for class Filter
 
filter(String, Object) - Method in interface PublicGroovyAPI
Creates a filter object that can be used in other API functions.
filter(String, Object, Object) - Method in interface PublicGroovyAPI
Creates a filter object that can be used in other API functions.
filterBuilderUserEntry(String, String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "FilterBuilderUserEntry" function.
filterFromMap(Map<String, Object>) - Method in interface PublicGroovyAPI
Constructs a Filter object from a map representation of that filter (from the "wire format") The map representation is the way the filter is described in the JSON requests between UI and server
find(String, Filter...) - Method in interface PublicGroovyAPI
The swiss army knife method of the API.
find(String, int, Filter...) - Method in interface PublicGroovyAPI
The swiss army knife method of the API.
find(String, int, String, Filter...) - Method in interface PublicGroovyAPI
The swiss army knife method of the API.
find(String, int, int, String, Filter...) - Method in interface PublicGroovyAPI
The swiss army knife method of the API.
find(String, int, int, String, List<String>, Filter...) - Method in interface PublicGroovyAPI
The swiss army knife method of the API.
find(String, int, int, String, List<String>, boolean, Filter...) - Method in interface PublicGroovyAPI
The swiss army knife method of the API.
find(String, int, int, String, Map<String, String>, boolean, Filter...) - Method in interface PublicGroovyAPI
The swiss army knife method of the API.
findAllWithContractTermTypeUN(String) - Method in class ContractHelper
 
findAllWithSKU(String) - Method in class QuoteHelper
Retrieves a list of all line items that are for a particular sku
findApprovedPricelistItems(String) - Method in interface PublicGroovyAPI
Returns a list of summary items.
findCalculatedFieldSets(Date, String) - Method in interface PublicGroovyAPI
Returns a list of calculated field sets that match the targetDate
findCustomerAssignments(String) - Method in interface PublicGroovyAPI
Finds all assignement rcords for a given customerId Also matches by CustomerGroup definitions
findCustomersInGroup(CustomerGroup) - Method in interface PublicGroovyAPI
Retrieves a list of customers that match a given CustomerGroup (returns first 200 entries)
findCustomersInGroup(CustomerGroup, int, String) - Method in interface PublicGroovyAPI
Retrieves a list of customers that match a given CustomerGroup with custom paging and sorting
findDataLoad(String, String, String) - Method in interface PublicGroovyAPI
 
findLookupTable(String) - Method in interface PublicGroovyAPI
Finds a LookupTbale / price parameter table base don the table name.
findLookupTableValues(String, Filter...) - Method in interface PublicGroovyAPI
Searches and returns values of a named lookup table.
findManualPricelists(Date, String) - Method in interface PublicGroovyAPI
Returns a list of manual pricelists that match the targetDate (i.e.
findPriceGrids(Date, String) - Method in interface PublicGroovyAPI
Returns a list of price grids that match the targetDate (i.e.
findPricelists(Date, String) - Method in interface PublicGroovyAPI
Returns a list of pricelists that match the targetDate (i.e.
findRebateRecordLoad(String) - Method in interface PublicGroovyAPI
 
findRow(String, Object) - Method in class ResultMatrix
Retrieves a particular row based on a value check
findSimulations(Date, String) - Method in interface PublicGroovyAPI
Returns a list of simulations that match the targetDate (i.e.
findWorkflowInfo(String, Object) - Method in interface PublicGroovyAPI
Finds active workflow for given approvable.
flush() - Method in interface DatamartContext.DataLoader
Flushes the data to the DB.
fontweight - Variable in class ResultMatrix.ResultMatrixStyledCell
 
formatNumber(String, Object) - Method in interface PublicGroovyAPI
Formats a number into a string.
formatNumber(String, String, Object) - Method in interface PublicGroovyAPI
Formats a number into a string.
formatString(String, String, Object...) - Method in interface PublicGroovyAPI
fromExisting(String) - Method in class RATBuilder
 
fromMap(Map<String, Object>) - Method in class WorkflowDTO.ApprovalStepDTO
 
fromMap(Map<String, Object>) - Method in class WorkflowDTO.StepDTO
 
fromMap(Map<String, Object>) - Method in class WorkflowDTO.WatcherStepDTO
 
fromParams(Map) - Method in class RATBuilder
 

G

get() - Method in interface IRebateRecordManager
Get the RR with the default name linked to the current RA.lineitem
get(String) - Method in interface IRebateRecordManager
Get the RR with the given name linked to the current RA.lineitem
get(String, String) - Method in interface IRebateRecordManager
In the given RR-set, get the RR with the given name linked to the current RA.lineitem
get() - 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.
getAll() - Method in interface IRebateRecordManager
Get all RRs linked to the the current agreement (via RR --> RLI --> RBA).
getAll(String) - Method in interface IRebateRecordManager
Get all RRs linked to the line item with the given lineID in the current agreement (via RR --> RLI).
getApprovalRequiredEmailAttachments() - Method in class WorkflowDTO.ApprovalStepDTO
 
getApprover() - Method in class WorkflowDTO.ApprovalStepDTO
Return the current approver (or null if none set or if group approval)
getAttribute(String) - Method in class AttributedResult
 
getAttributes() - Method in class AttributedResult
 
getBaseTemplateToUse() - Method in class ResultFlexChart
 
getBinding(String) - Method in interface PublicGroovyAPI
Gets a named binding variable from a library function.
getBoundPartitionNames() - Method in interface PublicGroovyAPI
Returns bound partition list
getCalculableLineItem(Object, String) - Method in interface PublicGroovyAPI
Returns a line item of a given calculable line item collection (a.k.a.
getCalculableLineItemCollection(String) - Method in interface PublicGroovyAPI
Returns the full object (header and line items) of e.g.
getCalculableLineItemResult(Object, String...) - Method in interface PublicGroovyAPI
Returns result(s) of given name(s) (or label(s)) from a line item object (its map representation to be exact).
getColumnFormats() - Method in class ResultMatrix
Gets individual column formats (if specified)
getColumns() - Method in class ResultMatrix
Gets a list of defined columns
getContractView() - Method in class ContractBuilder
 
getData() - Method in interface DatamartQueryResult
Retreives the query result data.
getDataFeed(String) - Method in interface DatamartContext
Get a table object representing the DataFeed with the given name.
getDatamart(String) - Method in interface DatamartContext
Get a table object representing the Datamart with the given name.
getDatamartContext() - Method in interface PublicGroovyAPI
The DatamartContext provides an API for querying and loading PA data.
getDatamartRowSet() - Method in interface PublicGroovyAPI
Available in a PA DataLoad context only, a DatamartRowSet provides access to the rows being loaded or calculated.
getDatamartRowSet(String) - Method in interface PublicGroovyAPI
Available in a PA DataLoad context only, a DatamartRowSet provides access to the rows currently being loaded or calculated.
getDataSource(String) - Method in interface DatamartContext
Get a table object representing the DataSource with the given name.
getDaysDiff(String, String) - Method in interface DatamartContext.Calendar
Calculates the number of days between the start date of period1 and end date of period2 (both inclusive).
getDefaultFormat() - Method in class ResultMatrix
Gets the default format
getDenialReasons() - Method in class WorkflowDTO.ApprovalStepDTO
 
getDenialReasons() - Method in class WorkflowDTO
 
getDWTable(String) - Method in interface DatamartContext
Get a table object representing the DWTable with the given name.
getElement(String) - Method in interface PublicGroovyAPI
Gets the result of a previous formula element.
getEmailAttachment() - Method in class WorkflowDTO.StepDTO
Retrieves the attachment sending setting
getEmailListWatcher() - Method in class WorkflowDTO.WatcherStepDTO
Gets the list of email addresses if specified as recipient for this node
getEndDate(String) - Method in interface DatamartContext.Calendar
Returns the end date of given TimePeriod.
getEntries() - Method in class ResultMatrix
Returns the current list entries as a list (=the rows) of maps (= the row content)
getExcludeSubmitter() - Method in class WorkflowDTO.ApprovalStepDTO
Returns status if the submitter is excluded in case of group approval
getFieldCollection(String) - Method in interface DatamartContext
Get a table object representing the FC with the given source name.
getFilter() - Method in class ContextParameter
 
getFirstInput() - Method in class ConfiguratorEntry
 
getFlexChart() - Method in class ResultFlexChart
 
getGlobal() - Method in interface PublicGroovyAPI
A publicly available cache (as a hashmap) to store and share values across formula elements If api.retainGlobal is set to true this map will also be available with an entire list calculation, i.e across item boundaries.
getHelper() - Method in class ContractBuilder
 
getHelper() - Method in class QuoteBuilder
Gets a helper class that assists in manipulating the quote object
getHelper() - Method in class RebateAgreementBuilder
 
getId(Object) - Method in interface PublicGroovyAPI
Returns the id part of an object.
getInputs() - Method in class ConfiguratorEntry
 
getInvariantContext() - Method in interface PublicGroovyAPI
Available in invariant formula run.
getIstanceId() - Method in class RATBuilder.RABuilder
 
getItemCompleteCalculationResults(String) - Method in interface PublicGroovyAPI
Gets current complete calculation results of the given item (e.g.
getItemReasons() - Method in class WorkflowDTO
 
getItems() - Method in class DashboardController
 
getIterationNumber() - Method in interface PublicGroovyAPI
Returns the number of iterations this list has been calculated during this cycle 0 means: initial calculation (non-dirty) 1 means: first dirty pass and so on
getLabel() - Method in class ContextParameter
 
getLookupTableId() - Method in class ContextParameter
 
getManualOverride(String) - Method in interface PublicGroovyAPI
In certain scenarios (e.g.
getMax() - Method in class ResultGauge
The maximum dial value.
getMaxFindResultsLimit() - Method in interface PublicGroovyAPI
The PublicGroovyAPI.find(String, Filter...) method (and its variations) are limitied in how many results are returned in one call.
getMessage() - Method in class ConfiguratorEntry
 
getMin() - Method in class ResultGauge
The minimum dial value.
getName() - Method in class ContextParameter
 
getObjectService() - Method in class ConfiguratorEntry
 
getObjectService() - Method in class ContextParameter
 
getOnRowSelectEvents() - Method in class ResultMatrix
 
getOperator() - Method in class Filter
 
getParameter(String) - Method in interface PublicGroovyAPI
Retrieves an already generated (i.e.
getParameterConfig() - Method in class ContextParameter
 
getParameterGroup() - Method in class ContextParameter
 
getPrefix() - Method in class ResultGauge
The label prefix.
getPriceGridSummaryQuery() - Method in interface PublicGroovyAPI
Creates a summary query object that can be parameterized and is then subsequently used in PublicGroovyAPI.runSummaryQuery(ItemSummaryQuery) This query runs against price grid(s)
getPricelistItem(String) - Method in interface PublicGroovyAPI
Similar to the standard syntax' "Pricelist" function.
getPricelistSummaryQuery() - Method in interface PublicGroovyAPI
Creates a summary query object that can be parameterized and is then subsequently used in PublicGroovyAPI.runSummaryQuery(ItemSummaryQuery) This query runs against pricelist(s)
getProperties() - Method in class WorkflowDTO.StepDTO
 
getProperty() - Method in class Filter
 
getProperty(Object, String) - Method in interface PublicGroovyAPI
This method serves as an optimized way to get to certain object attributes.
getPropertyByElementName(Object, String) - Method in interface PublicGroovyAPI
This method gets object attributes by elementName.
getQuoteView() - Method in class QuoteBuilder
Gets the full quote object as a nested map
getReadOnly() - Method in class ContextParameter
 
getReason() - Method in class WorkflowDTO.ApprovalStepDTO
Returns the reason text
getReason() - Method in class WorkflowDTO.WatcherStepDTO
Returns the reason text
getRebateAgreementView() - Method in class RebateAgreementBuilder
 
getRebateRecordSummaryQuery() - Method in interface PublicGroovyAPI
Creates a summary query object that can be parameterized and is then subsequently used in PublicGroovyAPI.runSummaryQuery(ItemSummaryQuery) This query runs against rebate records
getResult(String) - Method in interface IRebateRecordManager
Get the formula element result for the RR with the default name linked to the current RA.lineitem
getResult(String, String) - Method in interface IRebateRecordManager
Get the formula element result for the RR with the given name linked to the current RA.lineitem
getResult(String, String, String) - Method in interface IRebateRecordManager
In the given RR-set, get the formula element result for the RR with the given name linked to the current RA.lineitem
getResult() - Method in class AttributedResult
 
getResultType() - Method in class ConfiguratorEntry
 
getResultType() - Method in class DashboardController
 
getResultType() - Method in class ResultFlexChart
 
getResultType() - Method in class ResultGauge
 
getResultType() - Method in class ResultMatrix
 
getSecondaryKey() - Method in interface PublicGroovyAPI
Gets the secondary key in case a matrix pricelist or matrix simulation is processed
getSectors() - Method in class ResultGauge
 
getSharedCache(String) - Method in interface PublicGroovyAPI
Retrieves a value from the shared cache (and resets the TTL of the key)
getSimulationSummaryQuery() - Method in interface PublicGroovyAPI
Creates a summary query object that can be parameterized and is then subsequently used in PublicGroovyAPI.runSummaryQuery(ItemSummaryQuery) This query runs against simulation(s)
getStartDate(String) - Method in interface DatamartContext.Calendar
Returns the start date of given TimePeriod.
getStep(String) - Method in class WorkflowDTO
Retrieves a named step (if existing)
getSteps() - Method in class WorkflowDTO
 
getSuffix() - Method in class ResultGauge
 
getSummary() - Method in interface DatamartQueryResult
Additional query summary information,
getTableContext() - Method in interface PublicGroovyAPI
The TableContext provides an SQL query (SELECT only) interface to PA query results.
getTimePeriod(String) - Method in interface DatamartContext.Calendar
Returns the TimePeriod object matching its string representation.
getTimePeriodByDate(String, String) - Method in interface DatamartContext.Calendar
Parses a date, as well as a named TimeUnit, resulting in a TimePeriod with that unit that encompasses the given date.
getTimePeriodNames(String, String, String) - Method in interface DatamartContext.Calendar
Useful for constructing Options lists (user entry/input parameters).
getTimePeriods(String, String, String) - Method in interface DatamartContext.Calendar
Same as above but now returning a list of TimePeriod objects, rather than the corresponding period names.
getTimePeriods(Date, Date, CalendarUtil.TimeUnit) - Method in interface DatamartContext.Calendar
 
getTimeZone(String) - Method in interface PublicGroovyAPI
Just a wrapper for org.joda.time.DateTimeZone.forId(String tzString) method See also documentation there.
getType() - Method in class WorkflowDTO
Returns the type of the workflow.
getType() - Method in class ContextParameter
 
getTypedId() - Method in class WorkflowDTO
 
getUniqueName() - Method in class WorkflowDTO.StepDTO
Gets the name of the step
getURL() - Method in class ContextParameter
 
getUserGroupApprover() - Method in class WorkflowDTO.ApprovalStepDTO
Gets user group name in case of group approval (or null otherwise)
getUserGroupWatcher() - Method in class WorkflowDTO.WatcherStepDTO
Gets user group name in case of group watcher (or null otherwise)
getUserWatcher() - Method in class WorkflowDTO.WatcherStepDTO
Return the current watcher (or null if none set or if group watcher)
getValue() - Method in class Filter
 
getValue() - Method in class ContextParameter
 
getValue() - Method in class ResultGauge
The current value on the dial.
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.
greaterOrEqual(String, Object) - Static method in class Filter
Create a new Filter using the >= operator.
greaterThan(String, Object) - Static method in class Filter
Create a new Filter using the > operator.

H

hashCode() - Method in class Filter
 
hashCode() - Method in class WorkflowDTO.StepDTO
 
hashCode() - Method in class ContextParameter
 
having(String...) - Method in interface DatamartContext.Query
Parses and ANDs one or more SQL-like conditions to the query's HAVING clause.
having(Filter...) - Method in interface DatamartContext.Query
Adds generic Filters to the query's HAVING clause.
httpCall(String, String) - Method in interface PublicGroovyAPI
Issues HTTP call to external entity.
httpCall(String, String, String, String, Map...) - Method in interface PublicGroovyAPI
Issues HTTP call to external entity.

I

ilike(String, String) - Static method in class Filter
Create a new Filter using the ILIKE operator.
imageCell(Object) - Method in class ResultMatrix
Creates an image cell that can then be added as row value.
in(String, Collection<?>) - Static method in class Filter
Create a new Filter using the IN operator.
in(String, Object...) - Static method in class Filter
Create a new Filter using the IN operator.
include(CustomerGroup) - Method in interface DatamartContext.DataSlice
 
include(ProductGroup) - Method in interface DatamartContext.DataSlice
 
include(CalendarUtil.TimePeriod) - Method in interface DatamartContext.DataSlice
 
input(String) - Method in interface PublicGroovyAPI
Retrives an input parameter - without triggering a user input
inputMatrix(String, String...) - Method in interface PublicGroovyAPI
Equivalent of the standard "InputMatrix" function.
integerUserEntry(String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "IntegerUserEntry" function.
IRebateRecordManager - Interface in net.pricefx.formulaengine
The RebateRecordManager API is exposed to formula groovy elements in two separate contexts: 1) in a RebateAgreement calculation (typeCode='RBA' aka RA), when the formula context's 'currentItem' would be an individual line item (typeCode='RBLI' aka RLI) 2) in a RebateAgreement 'read-only' evaluation (when opening an uneditable RA); currentItem is again a RLI 3) in a RebateRecordSet calculation, the formula context's 'currentItem' would be an individual RebateRecord (typeCode='RR') The API can be accessed via the 'rebateRecords' Groovy binding.
isCustomerParam() - Method in class ContextParameter
 
isDebugMode() - Method in interface PublicGroovyAPI
Returns true if formula is called via UI debug/test exec mode
isDenialReasonOptional() - Method in class WorkflowDTO.ApprovalStepDTO
 
isDenialReasonOptional() - Method in class WorkflowDTO
 
isDistributedMode() - Method in interface PublicGroovyAPI
Returns true if calculation is executed in distributed mode Useful to suppress warnings (or not execute methods) for operations that do not work in distributed mode.
isEmpty(String) - Static method in class Filter
Create a new Filter using the IS EMPTY operator.
isEnableClientFilter() - Method in class ResultMatrix
 
isFolder - Variable in class QuoteStructure.Item
 
isLookupType() - Method in class ContextParameter
 
isMatrixParam() - Method in class ContextParameter
 
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.
isPostPhase() - Method in class CalculableLineItemCollectionBuilder
Determines current calculation phase of logic execution
isPrePhase() - Method in class CalculableLineItemCollectionBuilder
Determines current calculation phase of logic execution
isProductGroupParam() - Method in class ContextParameter
 
isProductParam() - Method in class ContextParameter
 
isRequired() - Method in class ContextParameter
 
isSecondPass() - Method in interface PublicGroovyAPI
Method to determine if the calculation is in 2nd pass calculation.
isSyntaxCheck() - Method in interface PublicGroovyAPI
Returns true if the formula is executed in syntax check (or parameter determination) mode
isTakesListOfSubFilters() - Method in class Filter
 
isTakesListOfValues() - Method in class Filter
 
isTakesNoProperty() - Method in class Filter
Gets the value of the property takesNoProperty.
isTakesNoValue() - Method in class Filter
 
isTakesSingleSubFilter() - Method in class Filter
 
isTakesSingleValue() - Method in class Filter
 
isUserInGroup(String, String) - Method in interface PublicGroovyAPI
Checks if the current user is member of a given user group
Item() - Constructor for class QuoteStructure.Item
 
items - Variable in class QuoteStructure.Item
 
items - Variable in class QuoteStructure
The list of items to add in this level of the quote

J

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

L

label - Variable in class DashboardController.ControllerItem
 
labelOrSku - Variable in class QuoteStructure.Item
 
lessOrEqual(String, Object) - Static method in class Filter
Create a new Filter using the <= operator.
lessThan(String, Object) - Static method in class Filter
Create a new Filter using the < operator.
libraryImage(String, String) - Method in class ResultMatrix
 
like(String, String) - Static method in class Filter
Create a new Filter using the LIKE operator.
linkCell(Object, String, String) - Method in class ResultMatrix
 
linkToPriceGrid(Object, long, Filter) - Method in class ResultMatrix
 
linkToPriceList(Object, long, Filter) - Method in class ResultMatrix
 

M

markItemClean() - Method in interface PublicGroovyAPI
Removes a "dirty marker" from the current item
markItemDirty(String) - Method in interface PublicGroovyAPI
Marks the specfied item dirty.
markItemDirty(String, String) - Method in interface PublicGroovyAPI
Marks the specfied item dirty.
markItemDirty() - Method in interface PublicGroovyAPI
Marks the current item dirty.
matches(MatcherContext) - Method in class Filter
 
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
 
multiTierEntry(String, String...) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "MultiTierEntry" function.

N

NAME - Static variable in class RATBuilder
 
NAME - Static variable in class RATBuilder.RABuilder
 
net.pricefx.common.apibuilder.clicoll - package net.pricefx.common.apibuilder.clicoll
 
net.pricefx.common.apibuilder.contract - package net.pricefx.common.apibuilder.contract
 
net.pricefx.common.apibuilder.quote - package net.pricefx.common.apibuilder.quote
 
net.pricefx.common.apibuilder.rebateagreement - package net.pricefx.common.apibuilder.rebateagreement
 
net.pricefx.common.dto - package net.pricefx.common.dto
 
net.pricefx.formulaengine - package net.pricefx.formulaengine
 
net.pricefx.formulaengine.scripting - package net.pricefx.formulaengine.scripting
 
net.pricefx.server.dto.calculation - package net.pricefx.server.dto.calculation
 
net.pricefx.server.protocol - package net.pricefx.server.protocol
 
newController() - Method in interface PublicGroovyAPI
Creates a new dashboard controller object that can be further customized
newDataLoader(Table) - Method in interface DatamartContext
Instantiate a new DatamartContext.DataLoader to load rows with data for all the feed's attributes.
newDataLoader(Table, List<String>) - Method in interface DatamartContext
Instantiate a new DatamartContext.DataLoader to load rows with data for the named fields.
newDatamartSlice() - Method in interface DatamartContext
Creates a new DatamartSlice, which allows for setting filter criteria along the Time, CustomerGroup, ProductGroup any any other dimensions in a Datamart.
newDatamartSlice(String, Object...) - Method in interface DatamartContext
Creates a new DatamartSlice, which allows for setting filter criteria along the Time, CustomerGroup, ProductGroup any any other dimensions in a Datamart, intiialized with the name of the time dimension field, and an optional set filter criteria.
newDatamartSlice() - Method in interface PublicGroovyAPI
Deprecated.
Now provided by DatamartContext.
newDatamartSlice(String, Object...) - Method in interface PublicGroovyAPI
Deprecated.
Now provided by DatamartContext.
newGauge() - Method in interface PublicGroovyAPI
Creates a new gauge object that can be further customized.
newMatrix() - Method in interface PublicGroovyAPI
Creates a new result matrix DTO object that can be further customized and filled with calculated data
newMatrix(String...) - Method in interface PublicGroovyAPI
Creates a new result matrix DTO object that can be further customized and filled with calculated data.
newMatrix(Collection<String>) - Method in interface PublicGroovyAPI
Creates a new result matrix DTO object that can be further customized and filled with calculated data.
newQuery(Table) - Method in interface DatamartContext
 
newQuery(Table, boolean) - Method in interface DatamartContext
Build a new query on the given table.
newQuery(DatamartContext.Query) - Method in interface DatamartContext
Create a new query from an existing one.
newQuery(DatamartContext.Query, DatamartContext.Query, LinkedHashMap<String, String>) - Method in interface DatamartContext
 
newQuery(DatamartContext.Query, DatamartContext.Query, LinkedHashMap<String, String>, boolean) - Method in interface DatamartContext
 
next() - Method in interface StreamResults
Moves the cursor forward one row from its current position.
none(String, Filter) - Static method in class Filter
Create a new Filter using the NONE operator.
not(Filter) - Static method in class Filter
Create a new Filter using the NOT operator.
notEqual(String, Object) - Static method in class Filter
Create a new Filter using the != operator.
notIn(String, Collection<?>) - Static method in class Filter
Create a new Filter using the NOT IN operator.
notIn(String, Object...) - Static method in class Filter
Create a new Filter using the NOT IN operator.

O

onRowSelection() - Method in class ResultMatrix
Configures a client-side UI event.
OP_ALL - Static variable in class Filter
 
OP_AND - Static variable in class Filter
 
OP_CUSTOM - Static variable in class Filter
 
OP_EMPTY - Static variable in class Filter
 
OP_EQUAL - Static variable in class Filter
 
OP_GREATER_OR_EQUAL - Static variable in class Filter
 
OP_GREATER_THAN - Static variable in class Filter
 
OP_ILIKE - Static variable in class Filter
 
OP_IN - Static variable in class Filter
 
OP_LESS_OR_EQUAL - Static variable in class Filter
 
OP_LESS_THAN - Static variable in class Filter
 
OP_LIKE - Static variable in class Filter
 
OP_NONE - Static variable in class Filter
 
OP_NOT - Static variable in class Filter
 
OP_NOT_EMPTY - Static variable in class Filter
 
OP_NOT_EQUAL - Static variable in class Filter
 
OP_NOT_IN - Static variable in class Filter
 
OP_NOT_NULL - Static variable in class Filter
 
OP_NULL - Static variable in class Filter
 
OP_OR - Static variable in class Filter
 
OP_SOME - Static variable in class Filter
 
operator - Variable in class Filter
The type of comparison to do between the property and the value.
option(String, Object...) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "Options" function.
or(Filter...) - Static method in class Filter
Create a new Filter using the OR operator.
orderBy(String...) - Method in interface DatamartContext.Query
Parses and adds one or more SQL-like conditions to the query's ORDER BY clause.
otherCustomer(String) - Method in interface PublicGroovyAPI
A method to trigger a custom-named customer picker input parameter
otherCustomer(String, String) - Method in interface PublicGroovyAPI
A method to trigger a custom-named customer picker input parameter
otherCustomer(String, String, boolean) - Method in interface PublicGroovyAPI
A method to trigger a custom-named customer picker input parameter
otherProduct(String, String) - Method in interface PublicGroovyAPI
A method to trigger a custom-named product picker input parameter
otherProduct(String) - Method in interface PublicGroovyAPI
A method to trigger a custom-named product picker input parameter

P

parentId - Variable in class QuoteStructure
The level of the quote.
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 in as string) according to a given pattern.
parseDateTime(String) - Method in interface DatamartContext.Calendar
Not so much a PA specific helper method: best attempt at converting a string representation (not necessarily in the 'yyyy-MM-dd'T'HHmmss' format) to a DateTime.
parseDateTime(String, String) - Method in interface PublicGroovyAPI
Parses a datetime (entered in as string) according to a given pattern.
parseDateTime(String, String, int, int) - Method in interface PublicGroovyAPI
Parses a datetime (entered in as string) according to a given pattern and time zone.
phase - Variable in class CalculableLineItemCollectionBuilder
 
placeholders() - Method in class RATBuilder
 
previousContext(String) - Method in interface PublicGroovyAPI
In case of (chained) price lists, this method allows for 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 easy retrieval of records from the previous list.
pricelist(String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "Pricelist" function.
pricelist(String, String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "Pricelist" function.
pricelist(String, String, String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "Pricelist" function.
pricelist(String, String, String, String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "Pricelist" function.
pricelistItem(String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "Pricelist" function - with the difference that the full item is returned
pricelistItem(String, String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "Pricelist" function - with the difference that the full item is returned.
pricelistItem(String, String, String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "Pricelist" function - with the difference that the full item is returned.
product(String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "Product" function.
product(String, String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "Product" function.
productCompetition() - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "Competition" function.
productCompetition(Filter...) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "Competition" function.
productExtension(String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "PXLookup" function.
productExtension(String, Filter...) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "PXLookup" function.
productGroupEntry(String...) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "ProductGroup" function.
productToRelatedObjectsFilter(String, String) - Method in interface PublicGroovyAPI
Creates a filter to be applied to a search on a related object type, limiting the result to objects of the related type that have a link to the given product.
productXRef() - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "XRefLookup" function.
productXRef(Filter...) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "XRefLookup" function.
properties - Variable in class WorkflowDTO.StepDTO
 
property - Variable in class Filter
The name of the property to filter on.
PublicGroovyAPI - Interface in net.pricefx.formulaengine.scripting
This interface represents what can be reached in groovy formula syntax as api.
putGlobal(Map<String, Object>) - Method in interface PublicGroovyAPI
Puts an entire map of variables into the global cache

Q

QuoteBuilder - Class in net.pricefx.common.apibuilder.quote
QuoteBuilder is the starting point of an interface that allows you manipulate a quote object in a quote header calculation logic.
The header calculation is executed twice: Once before the calculation of the individual line items (= pre phase) and once after that (=post phase).
Usually code should only apply in one phase.
QuoteHelper - Class in net.pricefx.common.apibuilder.quote
A helper class that assists in manipulating the quote object
QuoteHelper(Map<String, Object>) - Constructor for class QuoteHelper
 
QuoteStructure - Class in net.pricefx.common.apibuilder.quote
This is a helper object that is used to build up code generated content of a quote.
QuoteStructure() - Constructor for class QuoteStructure
 
QuoteStructure.Item - Class in net.pricefx.common.apibuilder.quote
A DTO that holds information about the new item (part or folder) to be created.

R

RABuilder(RATBuilder) - Constructor for class RATBuilder.RABuilder
 
random() - Method in interface PublicGroovyAPI
 
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
 
RebateAgreementBuilder - Class in net.pricefx.common.apibuilder.rebateagreement
 
rebateAgreementUserEntry(String, String) - Method in interface PublicGroovyAPI
Prompts user for rebate agreement.
redAlert(String) - Method in interface PublicGroovyAPI
Marks the current formula element with a red alert and the given message
registerPlaceholder(InputType, String) - Method in class RATBuilder
 
relatedObjectToCustomersFilter(String) - Method in interface PublicGroovyAPI
Creates a filter to be applied to a Customer search, limiting the result to customers that are linked to the given related object, the latter defined by its typedId.
relatedObjectToProductsFilter(String) - Method in interface PublicGroovyAPI
Creates a filter to be applied to a Product search, limiting the result to products that are linked to the given related object, the latter defined by its typedId.
remove(Filter) - Method in class Filter
Used with OP_OR and OP_AND filters.
removeManualOverride(String) - Method in interface PublicGroovyAPI
Removes a manual result override.
removeSharedCache(String) - Method in interface PublicGroovyAPI
Deletes a key from the shared chache
removeStep(String) - Method in class WorkflowDTO
Removes a named step (if existing)
resetSKUContextSwitch() - Method in interface PublicGroovyAPI
Resets a sku context switch to the origionally specified sku
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
 
ResultMatrix - Class in net.pricefx.server.dto.calculation
This class is used to transport a calculated matrix-style result It is basically a list of maps with the addition that the column names are clearly named and can have a format This means: - the UI knows exactly which columns to display (even if some maps do not have those as keys) - the entry maps can have more "columns" (or keys) than those that are displayed; maybe useful for calculation
ResultMatrix() - Constructor for class ResultMatrix
 
ResultMatrix(Map) - Constructor for class ResultMatrix
 
ResultMatrix(String...) - Constructor for class ResultMatrix
Creates a new matrix object with an initial set of columns
ResultMatrix(Collection<String>) - Constructor for class ResultMatrix
Creates a new matrix object with an initial set of columns
ResultMatrix.AbstractResultMatrixCell - Class in net.pricefx.server.dto.calculation
 
ResultMatrix.ResultMatrixImageCell - Class in net.pricefx.server.dto.calculation
 
ResultMatrix.ResultMatrixLinkCell - Class in net.pricefx.server.dto.calculation
 
ResultMatrix.ResultMatrixOnRowSelection - Class in net.pricefx.server.dto.calculation
 
ResultMatrix.ResultMatrixOnRowSelection.TriggerEvent - Class in net.pricefx.server.dto.calculation
 
ResultMatrix.ResultMatrixStyledCell - Class in net.pricefx.server.dto.calculation
 
ResultMatrixImageCell() - Constructor for class ResultMatrix.ResultMatrixImageCell
 
ResultMatrixLinkCell() - Constructor for class ResultMatrix.ResultMatrixLinkCell
 
ResultMatrixOnRowSelection() - Constructor for class ResultMatrix.ResultMatrixOnRowSelection
 
ResultMatrixStyledCell() - Constructor for class ResultMatrix.ResultMatrixStyledCell
 
roles() - Method in interface PublicGroovyAPI
Lists all roles available in application
ROOT_ENTITY - Static variable in class Filter
Property string representing the root entity of the search.
ROOT_LINE_ID - Static variable in class CalculableLineItemCollectionBuilder
 
runRegression(String, String, String...) - Method in interface DatamartQueryResult
Runs a linear and exponential regression on the data set in the query result.
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

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
 
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.
sendEmail(String, String, String) - Method in interface PublicGroovyAPI
Sends email.
set(Map<?, ?>...) - Method in interface IRebateRecordManager
Update genetic attributes of the RR with the default name (linked to the current RA.lineitem)
set(String, Map<?, ?>...) - Method in interface IRebateRecordManager
Update genetic attributes of the RR with the given name (linked to the current RA.lineitem)
set(String, String, Map<?, ?>...) - Method in interface IRebateRecordManager
In the given RR-set, update genetic attributes of the RR with the given name (linked to the current RA.lineitem)
setAttribute(String, Object) - Method in class AttributedResult
 
setBaseTemplateToUse(String) - Method in class ResultFlexChart
 
setColumnFormat(String, FieldFormatType) - Method in class ResultMatrix
Sets a column format for a specified column
setConfigParameter(String, Object) - Method in class ContextParameter
 
setContext(FormulaEngineContext) - Method in class ConfiguratorEntry
 
setDefaultFormat(FieldFormatType) - Method in class ResultMatrix
Sets a default column format
setEnableClientFilter(boolean) - Method in class ResultMatrix
 
setFilter(Map<String, Object>) - Method in class ContextParameter
 
setFilters(Filter...) - Method in class ContextParameter
 
setFlexChart(Object) - Method in class ResultFlexChart
 
setInputs(List<ContextParameter>) - Method in class ConfiguratorEntry
 
setLabel(String) - Method in class ContextParameter
 
setMax(BigDecimal) - Method in class ResultGauge
The maximum dial value.
setMaxRows(Integer) - Method in interface DatamartContext.Query
Limits the number of rows returned in the query result.
setMessage(String) - Method in class ConfiguratorEntry
 
setMin(BigDecimal) - Method in class ResultGauge
The minimum dial value.
setOperator(int) - Method in class Filter
 
setOptions(Map<String, Object>) - Method in interface DatamartContext.Query
Allows for a number of query tweaking options, such as setting the target currency to convert to (if applicable), and requesting additional statistics to be calculated.
setParameterConfig(Map<String, Object>) - Method in class ContextParameter
 
setParameterGroup(String) - Method in class ContextParameter
 
setPrefix(String) - Method in class ResultGauge
Set the label prefix.
setProperty(String) - Method in class Filter
 
setRank(int) - Method in interface IRebateRecordManager
Sets the rank on the default RR.
setRank(String, int) - Method in interface IRebateRecordManager
Sets the rank on the named RR.
setReadOnly(Boolean) - Method in class ContextParameter
 
setReason(String) - Method in class WorkflowDTO.ApprovalStepDTO
Set an explanation for the approval step
setReason(String) - Method in class WorkflowDTO.WatcherStepDTO
 
setRequired(Boolean) - Method in class ContextParameter
 
setSharedCache(String, String) - Method in interface PublicGroovyAPI
Stores a string value in the shared cache with a given key.
setSuffix(String) - Method in class ResultGauge
The label suffix.
setURL(String) - Method in class ContextParameter
 
setValue(Object) - Method in class Filter
 
setValue(Object) - Method in class ContextParameter
 
setValue(BigDecimal) - Method in class ResultGauge
The current value on the dial.
setValueHint(String) - Method in class ContextParameter
 
setValueOptions(String[]) - Method in class ContextParameter
 
setValueOptions(List<String>) - Method in class ContextParameter
 
some(String, Filter) - Static method in class Filter
Create a new Filter using the SOME operator.
StepDTO(WorkflowDTO, String) - Constructor for class WorkflowDTO.StepDTO
 
stream(String, String, Filter...) - Method in interface PublicGroovyAPI
Search for all types of objects with a freestyle query, and iterate over the result set.
stream(String, String, List<String>, Filter...) - Method in interface PublicGroovyAPI
Search for all types of objects with a freestyle query, and iterate over the result set.
stream(String, String, List<String>, boolean, Filter...) - Method in interface PublicGroovyAPI
Search for all types of objects with a freestyle query, and iterate over the result set.
stream(String, String, Map<String, String>, boolean, Filter...) - Method in interface PublicGroovyAPI
Search for all types of objects with a freestyle query, and iterate over the result set.
streamQuery(DatamartContext.Query) - Method in interface DatamartContext
Executes the given DatamartContext.Query and return so that it can be examined one row at the time.
StreamResults - Interface in net.pricefx.server.protocol
Unifying (and very limited) JDBC ResultSet like API to a forward-only cursor on a query result, either from a Hibernate or PA query.
stringUserEntry(String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "StringUserEntry" function.
stringUserEntry(String, String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "StringUserEntry" function.
styledCell(Object) - Method in class ResultMatrix
Creates a styled cell that can then be added as row value
styledCell(Object, String, String) - Method in class ResultMatrix
Creates a styled cell that can then be added as row value
styledCell(Object, String, String, String) - Method in class ResultMatrix
Creates a styled cell that can then be added as row value
styledCell(Object, String, String, String, String) - Method in class ResultMatrix
Creates a styled cell that can then be added as row value
submitAfterBuild() - Method in class RATBuilder.RABuilder
 
switchSKUContext(String) - Method in interface PublicGroovyAPI
Temporarily switches the current sku context to another sku.

T

targetDate() - Method in interface PublicGroovyAPI
Gets the current execution context's target date
targetPage - Variable in class ResultMatrix.ResultMatrixLinkCell
 
targetPageState - Variable in class ResultMatrix.ResultMatrixLinkCell
 
targetRAUniqueName() - Method in class RATBuilder
 
templateTypeId() - Method in class RATBuilder
 
throwException(String) - Method in interface PublicGroovyAPI
Throws a calculation exception with a specified message and aborts the calculation
timePeriodAsFilter(CalendarUtil.TimePeriod, String) - Method in interface DatamartContext.Calendar
Helper method to build a filter representing dateDimFieldName in [timePeriod.startPeriod, timePeriod.endPeriod] Note the inclusion on both ends; this is to accommodate the most frequent use case where the TimePeriod is a single period, for example InvoiceDate in [2015,2015].
timeUserEntry(String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "TimUserEntry" function.
toMap() - Method in class WorkflowDTO.ApprovalStepDTO
 
toMap() - Method in class WorkflowDTO.StepDTO
 
toMap() - Method in class WorkflowDTO.WatcherStepDTO
 
tooltip - Variable in class ResultMatrix.ResultMatrixStyledCell
 
toQueryString() - Method in class Filter
 
toString() - Method in class Filter
 
toString() - Method in class RATBuilder.RABuilder
 
toString() - Method in class ContextParameter
 
toString() - Method in class ResultMatrix
 
trace(String, String, Object) - Method in interface PublicGroovyAPI
Generates a trace message that can be used in the formula test drive.
triggerEvent(String) - Method in class ResultMatrix.ResultMatrixOnRowSelection
 
TriggerEvent(HashMap<String, String>) - Constructor for class ResultMatrix.ResultMatrixOnRowSelection.TriggerEvent
 
type - Variable in class DashboardController.ControllerItem
 
type - Variable in class ResultMatrix.AbstractResultMatrixCell
 

U

uniqueName - Variable in class WorkflowDTO.StepDTO
 
update(String, Map<String, Object>) - Method in interface PublicGroovyAPI
Updates object in collection of objects of given type.
update(ContextParameter) - Method in class ContextParameter
 
updateCalculableObjectHeader(String, String) - Method in interface PublicGroovyAPI
Updates the header information of a CalculableObject (e.g.
updateField(String, String, Object) - Method in class CalculableLineItemCollectionBuilder
Updates a field on the line.
updateField(String, Object) - Method in class CalculableLineItemCollectionBuilder
Updates a header field For quotes supported fields are: additionalInfo1 additionalInfo2 additionalInfo3 additionalInfo4 externalRef expiryDate editabilityStatus targetDate
updateFromFormulaInputDescriptor(FormulaInputDescriptor) - Method in class ContextParameter
 
updateWithLookupTable(LookupTable) - Method in class ContextParameter
This is a convenience method to update a ContextParameter with a new version of the same lookup table This can happen e.g.
user(String) - Method in interface PublicGroovyAPI
Returns a value from the current user's master data
user() - Method in interface PublicGroovyAPI
Returns the entire master data object of the current user
userEntry(String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "UserEntry" function.
uuid(int) - Method in interface PublicGroovyAPI
Generate a random uuid of the specified length.
uuid(int, int) - Method in interface PublicGroovyAPI
Generate a random uuid of the specified length, and radix.
uuid() - Method in interface PublicGroovyAPI
Generate a RFC4122, version 4 ID.

V

value - Variable in class Filter
The value to compare the property with.
value - Variable in class ResultMatrix.AbstractResultMatrixCell
 
valueOf(String) - Static method in enum DashboardController.ControllerItemType
Returns the enum constant of this type with the specified name.
values - Variable in class DashboardController.ControllerItem
 
values() - Static method in enum DashboardController.ControllerItemType
Returns an array containing the constants of this enum type, in the order they are declared.
vLookup(String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "VLookup" function.
vLookup(String, Object) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "VLookup" function.
vLookup(String, String, String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "VLookup" function.
vLookup(String, String, String, String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "VLookup" function.
vLookup(String, String, String, String, String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "VLookup" function.
vLookup(String, String, String, String, String, String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "VLookup" function.
vLookup(String, String, String, String, String, String, String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "VLookup" function.
vLookup(String, String, String, String, String, String, String, String) - Method in interface PublicGroovyAPI
Equivalent of the standard syntax' "VLookup" function.

W

walkFilter(Filter, Closure<?>, Closure<?>, boolean) - Method in interface PublicGroovyAPI
Walks a filter and all its sub filters, visiting each filter in the tree.
WatcherStepDTO(WorkflowDTO, String) - Constructor for class WorkflowDTO.WatcherStepDTO
 
where(DatamartContext.DataSlice) - Method in interface DatamartContext.Query
Adds a condition to the query's WHERE clause.
where(ProductGroup) - Method in interface DatamartContext.Query
Adds a ProductGroup filter condition to the query's WHERE clause, for example a product group from an InputEntry("ProductGroup") parameter.
where(CustomerGroup) - Method in interface DatamartContext.Query
Adds a CustomerGroup condition to the query's WHERE clause, for example a customer group from an InputEntry("CustomerGroup") parameter.
where(String...) - Method in interface DatamartContext.Query
Parses and ANDs one or more SQL-like conditions to the query's WHERE clause.
where(Filter...) - Method in interface DatamartContext.Query
Adds generic Filters to the query's WHERE clause.
withAlignment(String) - Method in class ResultMatrix.ResultMatrixStyledCell
Specify the alignment of the cell
withApprovalRequiredEmailAttachment(Object) - Method in class WorkflowDTO.ApprovalStepDTO
 
withApprovalRequiredEmailAttachments(Object) - Method in class WorkflowDTO.ApprovalStepDTO
 
withApprover(String) - Method in class WorkflowDTO.ApprovalStepDTO
Last invoked of #withApprover(String), #withUserGroupApprover(String) wins
withBackground(String) - Method in class ResultMatrix.ResultMatrixStyledCell
Set the background color of the cell
withBackgroundColor(String) - Method in class AttributedResult
Sets the background color.
withColor(String) - Method in class ResultMatrix.ResultMatrixStyledCell
Set the foreground color of the value font
withColValueAsEventDataAttr(String, String) - Method in class ResultMatrix.ResultMatrixOnRowSelection.TriggerEvent
 
withCSS(String) - Method in class ResultMatrix.ResultMatrixStyledCell
Apply any other valid CSS instructions to the cell
withDenialReasons(List<String>, boolean) - Method in class WorkflowDTO.ApprovalStepDTO
 
withDenialReasons(List<String>, boolean) - Method in class WorkflowDTO
 
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
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 #withUserWatcher(String), #withUserGroupWatcher(String), #withEmailListWatcher(String...) wins
withFontWeight(String) - Method in class ResultMatrix.ResultMatrixStyledCell
Set the font weight (in standard CSS terms) of the value text
withManualOverrideAllowEmpty(Boolean) - Method in class AttributedResult
In case the result element is overridable, this method defines if the selection box shows also the "empty value" option.
withManualOverrideValueOptions(List<Object>) - Method in class AttributedResult
In case the result element is overridable, this method defines a set (list) of values tha the user can pick from (vs.
withRawCSS(String) - Method in class AttributedResult
Adds any valid CSS style to the cell.
withSuffix(String) - Method in class AttributedResult
Sets a suffix to be appended to the result.
withTextColor(String) - Method in class AttributedResult
Sets the text (foreground) color.
withTextDecoration(String) - Method in class AttributedResult
Sets the decoration to be added to the resulting text.
withToolTip(String) - Method in class ResultMatrix.ResultMatrixStyledCell
Show a tooltip text in the cell
withUserGroupApprover(String) - Method in class WorkflowDTO.ApprovalStepDTO
Last invoked of #withApprover(String), #withUserGroupApprover(String) wins
withUserGroupApprover(String, boolean) - Method in class WorkflowDTO.ApprovalStepDTO
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
withUserGroupWatcher(String) - Method in class WorkflowDTO.WatcherStepDTO
Specify a user group as recipient Last invoked of #withUserWatcher(String), #withUserGroupWatcher(String), #withEmailListWatcher(String...) wins
withUserWatcher(String) - Method in class WorkflowDTO.WatcherStepDTO
Specify a user as recipient Last invoked of #withUserWatcher(String), #withUserGroupWatcher(String), #withEmailListWatcher(String...) wins
workflow - Variable in class WorkflowDTO.StepDTO
 
WorkflowDTO - Class in net.pricefx.common.dto
This class is basically the type that is exposed by the workflow formula binding workflow
So in your workflow formula you would call methods on that instance to add approval nodes and/or watcher nodes and supply further details while doing so.
The methods are designed to be used in a simple flow pattern.
Simple example:
WorkflowDTO(WorkflowType, String) - Constructor for class WorkflowDTO
 
WorkflowDTO.ApprovalStepDTO - Class in net.pricefx.common.dto
 
WorkflowDTO.StepDTO - Class in net.pricefx.common.dto
 
WorkflowDTO.WatcherStepDTO - Class in net.pricefx.common.dto
 

Y

yellowAlert(String) - Method in interface PublicGroovyAPI
Marks the current formula element with a yellow alert and the given message
A B C D E F G H I J L M N O P Q R S T U V W Y 
Skip navigation links

Copyright © 2016. All rights reserved.