PublicGroovyAPI (Price f(x) Core Application 3.5 API)

```
public interface PublicGroovyAPI
```
This interface represents what can be reached in groovy formula syntax as api. That api variable or binding is merely an instance of this interface to expose certain "safe" methods and functionality.

Caching usage
The api exposes 3 ways to store transient and temporary data during formula executions. Each variant has its own specifics and therefore is not suitable for all use cases. The options are:
- api.local
- api.global
- Shared Cache
The first two can be understood as mere in-memory hash maps. For example, api.local.put("key","value") will work fine.
The difference between them is the potential scope and retention of the contained data.

api.local:
This is a hash map that is available during the lifetime of exactly one formula execution. It can (and should) be used to store intermediate results that need to be accessed by other subsequent formula elements.

api.global:
By default, api.global is very similar to api.local. Without any further settings, the only difference is that api.global is also available in Groovy library functions (while api.local is not).
However, by setting api.retainGlobal = true you can instruct the formula engine to keep the hash map in between formula runs. It works between line items and, in case of Quotes, Contracts and Rebate Agreements, between the header and the line items (but only in the pre-phase, not in the post-phase). The values are also carried forward between two list calculation passes (i.e. form initial run to dirty item run; ONLY in non-distributed mode!).
Important notes:
retainGlobal is effective only once. In order to keep it for the 3rd item as well (and so on) you need to call it in every formula execution.
api.global data also sticks to its execution thread. That means that it is NOT shared between the different parallel executions of a distributed calculation. It effectively builds up multiple caches. Another side effect of this is that api.global is not retained and passed to a subsequent calculation pass if the original calculation was in a distributed mode.

Shared Cache:
The main limitation of api.global is the restriction of its availability to the current execution thread. In a distributed calculation however, there are multiple threads and even multiple servers involved in the calculation. If all these should share a single cache, you must use the shared cache. The shared cache is even available to different calculations (such as other lists or list & CFS or dashboard formula etc). Be careful with key naming so that you do not mix and match data.
These advantages come at a cost: Due to the distributed "superglobal" nature, the read/write operations of that cache are slower compared to a real local in-memory map. Use the shared cache only for data that is expensive to calculate or for avoiding frequent database calls. Data in the shared cache expires automatically, the TTL is extended everytime a key is written or read. Values stored are "String" type only. Serialization and deserialization of other objects like dates and numbers are to be done in formula itself.

Object modifications
The API does contain methods to manipulate data (add, addOrUpdate, delete, etc). These methods can only be used (and will otherwise be ignored) in certain formula contexts. These contexts are:
- From within a CFS execution (non distributed only!)
- From within a calculation flow
- From within a direct formula execution via JSON API
On top of this, some restrictions apply which data objects can be manipulated - i.e. not every possible object can be modified. Currently available whitelisted typecodes are:
- All customer extension types
- All product extension types
- All matrix price parameter values and normal price parameter values (LTV) as well as price parameter header (LT)
- PGI and XPGI
- PLI and XPLI
- MPLI
- P
- C
- PCOMP
- PDESC
- PGI
- TODO
- Data export, import and archive

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`abortCalculation()` Aborts the current item's calculation.
`Object`	`add(String typeCode, Map<String,Object> values)` Adds a new object to the collection of objects of the given type.
`Object`	`addOrUpdate(String typeCode, Map<String,Object> values)` Adds or updates an object in the collection of objects of the given type.
`void`	`addWarning(String message)` Adds a warning to the formula execution warning log.
`AttributedResult`	`attributedResult(Object result)` Creates an `AttributedResult` object to be returned as a result of an output element.
`String`	`base64Decode(String base64String)` Decodes a base64 encoded string
`String`	`base64Encode(String string)` Does a standard Base64 encoding of a string
`Object`	`bom()` Equivalent of the standard syntax "BoM" function.
`Object`	`bom(String lookupTableName)` Equivalent of the standard syntax "BoM" function.
`Object`	`bom(String lookupTableName, String categoryName)` Equivalent of the standard syntax "BoM" function.
`Object`	`bom(String lookupTableName, String categoryName, String materialName)` Equivalent of the standard syntax "BoM" function.
`Object`	`bomList()` Equivalent of the standard syntax "BoMList" function.
`Object`	`booleanUserEntry(String entryName)` Equivalent of the standard syntax "BooleanUserEntry" function.
`Object`	`boundCall(String uniqueName, String relativeUrl, String body, Boolean... responseBodyAsAString)` Issues an HTTP/S call to Price fx server.
`ResultFlexChart`	`buildFlexChart(Object definition)` Calls `buildFlexChart(null, definition)`
`ResultFlexChart`	`buildFlexChart(String baseTemplateToUse, Object definition)` Creates a `FlexChart` from the passed `definition` by merging it with `options` defined within the `baseTemplateToUse` template.
`ResultHighchart`	`buildHighchart(Map<String,?> definition)` BETA Creates a `ResultHighchart` from the passed `definition`.
`ResultHighmap`	`buildHighmap(Map<String,?> definition)` BETA Creates a `ResultHighmap` from the passed `definition`.
`Calendar`	`calendar()` Gets a calendar object initialized with the current targetDate (or now if no target date is given).
`Calendar`	`calendar(Date date)` Gets a calendar object initialized with `date`.
`Object`	`configurator(String configuratorName, String formulaName)` Equivalent of the standard syntax "Configurator" function.
`Object`	`configurator(String configuratorName, String formulaName, Object resultName)` Equivalent of the standard syntax "Configurator" function.
`Object`	`configurator(String configuratorName, String formulaName, Object width, Object height)` Equivalent of the standard syntax "Configurator" function.
`Object`	`contextByLabel(String label)` Equivalent of the standard syntax "ContextByLabel" function.
`String`	`contextName()` The name of the current context.
`Set<Object>`	`contextSkuSet(int startRow)` Returns a set of skus which comprise so-called 'sku context' of the current formula execution.
`String`	`contextType()` The type (type code string) of the current context.
`String`	`contextTypedId()` The typedId of the current context
`int`	`count(String typeCode, Filter... filters)` Similar to the `find(java.lang.String, com.googlecode.genericdao.search.Filter...)` methods, this method queries an arbitrary object type.
`ConfiguratorEntry`	`createConfiguratorEntry()` Creates an empty configurator entry object.
`ConfiguratorEntry`	`createConfiguratorEntry(InputType type, String name)` Creates a cofigurator entry object and adds the specified input parameter as the first parameter to the configurator entry.
`ConfiguratorEntry`	`createConfiguratorEntry(InputType type, String name, Date targetDate)` Creates a cofigurator entry object and adds the specified input parameter as the first parameter to the configurator entry.
`ConfiguratorEntryArray`	`createConfiguratorEntryArray(Object... entries)` Creates configurator entry array object which is to be returned from formula element.
`Filter`	`createElementNameFilter(String elementName, Object fieldValue, String... listTypedIds)` Creates a cross-list filter expression based on meta data.
`Object`	`createNewRevision(String typedId)` Creates a revision of CalculableLineItemCollection (Quote/Rebate Agreement/Contract).
`void`	`criticalAlert(String msg)` Marks the current formula element with a critical alert and the given message.
`Map<String,Object>`	`currentContext(String sku)` 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.
`Map<String,Object>`	`currentContext(String sku, String key2)` 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.
`Object`	`currentItem()` In case of a list processing operation this method gets the currently worked on record (e.g., price list item or price grid item or quote item).
`Object`	`currentItem(String attributeName)` Same as `currentItem()` but returns only the specified attribute.
`Object`	`currentItemByElementName(String elementName)` In case of a list processing operation, this method gets the currently worked on record's property by elementName.
`String`	`currentPartitionName()` Returns the current partition name.
`Object`	`customer(String attributeName)` Equivalent of the standard syntax "Customer" function.
`Object`	`customer(String attributeName, boolean defaultFromParent)` Equivalent of the standard syntax "Customer" function.
`Object`	`customer(String attributeName, String customerId)` Equivalent of the standard syntax "Customer" function.
`Object`	`customer(String attributeName, String customerId, boolean defaultFromParent)` Equivalent of the standard syntax "Customer" function.
`Object`	`customer(String attributeName, String customerId, boolean defaultFromParent, String filterFormulaName, Object filterFormulaParam)` Equivalent of the standard syntax' "Customer" function.
`Object`	`customerExtension(String extensionName, Filter... filters)` Equivalent of the standard syntax "CXLookup" function.
`Object`	`customerGroupEntry(String... entryName)` Equivalent of the standard syntax "CustomerGroup" function.
`Object`	`customerGroupEntry(String entryName, String filterFormulaName, Object filterFormulaParam)` Equivalent of the standard syntax "CustomerGroup" function.
`Filter`	`customerToRelatedObjectsFilter(String relatedObjectTypeCode, String customerId)` 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.
`void`	`customEvent(Object object)` Sends an event of type "CUSTOM".
`void`	`customEvent(Object object, String customEventType)` Sends an event of type "CUSTOM".
`void`	`customEvent(Object object, String customEventType, String operation)` Sends an event of type "CUSTOM".
`void`	`customEvent(Object object, String customEventType, String operation, boolean omitNullValues)` Sends an event of type "CUSTOM".
`Object`	`datamartCalendar()` Deprecated. Use `DatamartContext.calendar()` instead.
`Filter`	`datamartFilter(Object groupOrSlice)` Translates a CustomerGroup/ProductGroup/DMDataSlice to its equivalent Filter representation, mapping domain level field names to the corresponding Datamart field names in the process.
`Object`	`datamartFilterBuilderUserEntry(String entryName, String source, Object... args)` Equivalent of the standard syntax "DatamartFilterBuilderUserEntry" function.
`Object`	`datamartLookup(Object... queryAndProjectionsAndFilters)` Important: Please use the Groovy query API instead (see `DatamartContext`).
`Object`	`datamartQuery(Object... queryAndDatamartAndProjectionsAndFilters)` Important: please use the Groovy query API instead (see `DatamartContext`).
`Object`	`dateTimeUserEntry(String entryName)` Equivalent of the standard syntax "DateTimeUserEntry" function.
`Object`	`dateUserEntry(String entryName)` Equivalent of the standard syntax "DateUserEntry" function.
`Object`	`decimalUserEntry(String entryName)` Alias of "userEntry", to conform to the general naming structure
`Object`	`delete(String typeCode, Map<String,Object> values)` Deletes an object in the collection of objects of the given type.
`boolean`	`emit(Object obj)` Emits an object to be consumed by an external thread.
`boolean`	`emitPersistedObject(String typedId)` Finds the PersistedObject with the given typedId, and emits it if it exists.
`boolean`	`emitPersistedObject(String typeCode, Long id)` Finds the PersistedObject for the given typeCode and id, and emits it if it exists.
`void`	`emitRebateRecords(String dateFieldName, String sortBy, Filter... filters)` Emits the rebate records matching the given search criteria, to be consumed by a PA allocation task (a PA calculation task with a feeder formula calling this method, and a regular formula accepting each emitted RebateRecord as its currentItem context, and distributing one or more RebateRecord accruals over the set of PA rows which have contributed to those accruals in some way (by revenue, bvolume...).
`String`	`entityRef(PartitionedObject po)` Creates entityRef value (usually db id) for the given entity.
`double`	`evalExpression(String mathExpression)` Evaluates an arithmetic expression that is passed in as a string.
`Object`	`filter(String property, Object value)` Creates a filter object that can be used in other API functions.
`Object`	`filter(String property, Object opString, Object value)` Creates a filter object that can be used in other API functions.
`Object`	`filterBuilderUserEntry(String entryName, String typeCode)` Equivalent of the standard syntax "FilterBuilderUserEntry" function.
`Filter`	`filterFromMap(Map<String,Object> filterMap)` Constructs a Filter object from the map representation of that filter (from the "wire format").
`List<Object>`	`find(String typeCode, Filter... filters)` The Swiss army knife method of the API.
`List<Object>`	`find(String typeCode, int startRow, Filter... filters)` The Swiss army knife method of the API.
`List<Object>`	`find(String typeCode, int startRow, int maxRows, String sortBy, Filter... filters)` The Swiss army knife method of the API.
`List<Object>`	`find(String typeCode, int startRow, int maxRows, String sortBy, List<String> fields, boolean distinctValuesOnly, Filter... filters)` The Swiss army knife method of the API.
`List<Object>`	`find(String typeCode, int startRow, int maxRows, String sortBy, List<String> fields, Filter... filters)` The Swiss army knife method of the API.
`List<Object>`	`find(String typeCode, int startRow, int maxRows, String sortBy, Map<String,String> fields, boolean distinctValuesOnly, Filter... filters)` The Swiss army knife method of the API.
`List<Object>`	`find(String typeCode, int startRow, String sortBy, Filter... filters)` The Swiss army knife method of the API.
`List<SummaryCalculableObjectItem>`	`findApprovedPricelistItems(String sku)` Returns a list of summary items.
`List<CalculatedFieldSet>`	`findCalculatedFieldSets(Date targetDate, String cfsName)` Returns a list of calculated field sets that match the targetDate.
`List<CustomerAssignment>`	`findCustomerAssignments(String customerId)` Finds all assignement records for the given customerId.
`List<Customer>`	`findCustomersInGroup(CustomerGroup group)` Retrieves a list of customers that match the given CustomerGroup (returns first 200 entries).
`List<Customer>`	`findCustomersInGroup(CustomerGroup group, int startRow, String sortBy)` Retrieves a list of customers that match the given CustomerGroup with custom paging and sorting.
`Object`	`findDataLoad(String dataLoadLabel, String dataLoadType, String target)`
`LookupTable`	`findLookupTable(String tableName)` Finds a lookup table / price parameter table based on the table name.
`List<Object>`	`findLookupTableValues(String tableName, Filter... filters)` Searches and returns values of a named lookup table.
`List<ManualPricelist>`	`findManualPricelists(Date targetDate, String listName)` Returns a list of manual pricelists that match the targetDate (i.e., list's validAfter <= targetDate and expiryDate > targetDate).
`Map<String,List<String>>`	`findNextRevUNs(String typeCode, String... uniqueNames)` Finds next revision uniqueNames for given Quotes/Contracts/RebateAgreements
`Map<String,Object>`	`findPreviousApprovableState(String typedId, String... workflowStatuses)` Finds previous approvable entity state in case some 'DENIED' or 'WITHDRAWN' workflow for the approvable exists
`WorkflowInfo`	`findPreviousWorkflowInfo(String typedId, String... workflowStatuses)` Finds approvable entity previous workflow history in case some 'DENIED' or 'WITHDRAWN' workflow for the approvable exists
`List<PriceGrid>`	`findPriceGrids(Date targetDate, String priceGridName)` Returns a list of price grids that match the targetDate (i.e., price grid's targetDate <= targetDate).
`List<Pricelist>`	`findPricelists(Date targetDate, String listName)` Returns a list of pricelists that match the targetDate (i.e., list's targetDate <= targetDate and expiryDate > targetDate).
`Object`	`findRebateRecordLoad(String rebateRecordLoadLabel)`
`List<Simulation>`	`findSimulations(Date targetDate, String simulationName)` Returns a list of simulations that match the targetDate (i.e., list's targetDate <= targetDate).
`WorkflowInfo`	`findWorkflowInfo(String approvableTypeCode, Object approvableId)` Finds active workflows for the given approvable.
`String`	`formatNumber(String pattern, Object n)` Formats a number into a string.
`String`	`formatNumber(String locale, String pattern, Object n)` Formats a number into a string.
`String`	`formatString(String locale, String format, Object... args)` Formats a string like `String.format(java.lang.String, java.lang.Object...)`.
`String`	`getBaseURL()` Returns the base URL component of the current instance.
`Object`	`getBinding(String name)` Gets a named binding variable from a library function.
`Object`	`getBoundPartitionNames()` Returns bound partition list.
`<T extends CalculableLineItem> T`	`getCalculableLineItem(Object clic, String lineId)` Returns a line item of the given calculable line item collection (a.k.a.
`Object`	`getCalculableLineItemCollection(String typedId)` Returns the full object (header and line items) of e.g.
`Object`	`getCalculableLineItemResult(Object cli, String... resultNamesOrLabels)` Returns result(s) of the given name(s) (or label(s)) from a line item object (its map representation, to be exact).
`String`	`getCalculationContext()` Retreive the CalculationContext of the formula evaluation (aka formula element group). a) For a PA Calculation or Flush formula this can be (from PriceFxInterface): - FORMULAELEMENTGROUP_DM_INIT = "init"; - FORMULAELEMENTGROUP_DM_ROW = "row"; - FORMULAELEMENTGROUP_DM_SUMMARY = "summary"; b) In RebateAgreement calculation we have: - FORMULAELEMENTGROUP_RM_AGREEMENT = "agreement"; - FORMULAELEMENTGROUP_RM_AGREEMENT_READONLY = "agreementReadOnly"; - FORMULAELEMENTGROUP_RM_REBATERECORD = "rebateRecord"; c) In the Optimizer module, when evaluating Model formulas, there is: - FORMULAELEMENTGROUP_MODEL_DEFINITION = "definition"; - FORMULAELEMENTGROUP_MODEL_CALCULATION = "calculation"; - FORMULAELEMENTGROUP_MODEL_ANALYSIS = "analysis";
`DatamartContext`	`getDatamartContext()` The DatamartContext provides an API for querying and loading PA data.
`DatamartRowSet`	`getDatamartRowSet()` Available in a PA DataLoad context only, a `DatamartRowSet` provides access to the rows being loaded or calculated.
`DatamartRowSet`	`getDatamartRowSet(String name)` Available in a PA DataLoad context only, a `DatamartRowSet` provides access to the rows currently being loaded or calculated.
`Object`	`getElement(String name)` Gets the result of a previous formula element.
`Map<String,Object>`	`getGlobal()` A publicly available cache (as a hashmap) for storing and sharing values across formula elements.
`Long`	`getId(Object obj)` Returns the id part of an object.
`Map<String,Object>`	`getItemActiveCalculationResults(String typedId)` Gets current complete active (i.e.
`Map<String,Object>`	`getItemCompleteCalculationResults(String typedId)` Gets current complete calculation results of the given item (e.g., pricelist item).
`int`	`getIterationNumber()` Returns the number of iterations this list has been calculated during this cycle.
`String`	`getLocale()` Returns the language part of the current request's locale
`Object`	`getManualOverride(String elementName)` Returns a user entered value that overrides the calculated result of a formula element.
`int`	`getMaxFindResultsLimit()` The `find(String, Filter...)` method and its variations are limitied in how many results are returned in one call.
`ContextParameter`	`getParameter(String parameterName)` Retrieves an already generated (i.e.
`ItemSummaryQuery<PriceGrid>`	`getPriceGridSummaryQuery()` Creates a summary query object that can be parameterized and is then subsequently used in `runSummaryQuery(ItemSummaryQuery)`.
`Map<String,Object>`	`getPricelistItem(String listName)` Similar to the standard syntax "Pricelist" function.
`ItemSummaryQuery<Pricelist>`	`getPricelistSummaryQuery()` Creates a summary query object that can be parameterized and is then subsequently used in `runSummaryQuery(ItemSummaryQuery)`.
`List<?>`	`getProductReferences(String typeCode, Set<String> skus)` Returns a list of product reference records that tell which other objects of given type these skus are referenced
`Object`	`getProperty(Object object, String path)` This method serves as an optimized way to get to certain object attributes.
`Object`	`getPropertyByElementName(Object object, String elementName)` This method gets object attributes by elementName.
`ItemSummaryQuery<RebateRecordSet>`	`getRebateRecordSummaryQuery()` Creates a summary query object that can be parameterized and is then subsequently used in `runSummaryQuery(ItemSummaryQuery)`.
`Object`	`getSecondaryKey()` Gets the secondary key in case a matrix pricelist or matrix simulation is processed.
`String`	`getSharedCache(String key)` Retrieves a value from the shared cache (and resets the TTL of the key).
`ItemSummaryQuery<Simulation>`	`getSimulationSummaryQuery()` Creates a summary query object that can be parameterized and is then subsequently used in `runSummaryQuery(ItemSummaryQuery)`.
`TableContext`	`getTableContext()` The TableContext provides an SQL query (SELECT only) interface to PA query results.
`DateTimeZone`	`getTimeZone(String tzString)` Just a wrapper for org.joda.time.DateTimeZone.forId(String tzString) method.
`Object`	`httpCall(String url, String body)` Issues an HTTP call to external entity.
`Object`	`httpCall(String url, String body, String methodType, String contentType, Map... properties)` Issues an HTTP call to external entity.
`Object`	`inlineConfigurator(String configuratorName, String formulaName)` Equivalent of the standard syntax' "InlineConfigurator" function.
`Object`	`input(String inputName)` Retrieves an input parameter - without triggering a user input.
`Object`	`inputMatrix(String inputMatrixName, Map<String,Object> paramConfig, String... columns)` Equivalent of the standard "InputMatrix" function.
`Object`	`inputMatrix(String inputMatrixName, String... columnNames)` Equivalent of the standard "InputMatrix" function.
`Object`	`integerUserEntry(String entryName)` Equivalent of the standard syntax "IntegerUserEntry" function.
`boolean`	`isDebugMode()` Returns true if formula is called via UI debug/test exec mode.
`boolean`	`isDistributedMode()` Returns true if calculation is executed in distributed mode.
`Boolean`	`isFullListCalculation()` Indicates wether the current calculation is recalculating the entire list or only parts of it.
`boolean`	`isSecondPass()` A method to determine if the calculation is in the 2nd pass calculation.
`boolean`	`isSyntaxCheck()` Returns true if the formula is executed in syntax check (or parameter determination) mode.
`boolean`	`isUserInGroup(String userGroupName, String loginUserName)` Checks if the current user is member of the given user group.
`Object`	`jsonDecode(String json)` A utility method to decode a JSON string into a Map representation.
`Object`	`jsonDecodeList(String json)` A utility method to decode a JSON string into a List representation.
`Object`	`jsonEncode(Object input)` A utility method to encode Object to JSON string.
`Object`	`jsonEncode(Object input, boolean omitNull)` A utility method to encode Object to JSON string.
`void`	`markItemClean()` Removes a "dirty marker" from the current item.
`void`	`markItemClean(String sku)` Marks the specfied item clean.
`void`	`markItemClean(String sku, String key2)` Marks the specfied item clean.
`void`	`markItemDirty()` Marks the current item dirty.
`void`	`markItemDirty(String sku)` Marks the specfied item dirty.
`void`	`markItemDirty(String sku, String key2)` Marks the specfied item dirty.
`MultiKey<Object>`	`multiKey(Object... keys)` Constructs a new composite key object, which can be used as the key in a map.
`Object`	`multiTierEntry(String entryName, String... arguments)` Equivalent of the standard syntax "MultiTierEntry" function.
`AdaptiveHistogram`	`newAdaptiveHistogram()` Creates a histogram that adapts to an unknown data distribution.
`DashboardController`	`newController()` Creates a new dashboard controller object that can be further customized.
`CreationWorkflowDefinition`	`newCreationWorkflow()`
`CreationWorkflowStepDefinition`	`newCreationWorkflowStep()`
`Object`	`newDatamartSlice()` Deprecated. Now provided by `DatamartContext`.
`Object`	`newDatamartSlice(String dateFieldName, Object... timePeriodsAndProductAndCustomerGroups)` Deprecated. Now provided by `DatamartContext`.
`ResultGauge`	`newGauge()` Creates a new gauge object that can be further customized.
`ResultMatrix`	`newMatrix()` Creates a new result matrix DTO object that can be further customized and populated with calculated data.
`ResultMatrix`	`newMatrix(Collection<String> columns)` Creates a new result matrix DTO object that can be further customized and populated with calculated data.
`ResultMatrix`	`newMatrix(String... columns)` Creates a new result matrix DTO object that can be further customized and populated with calculated data.
`Object`	`option(String entryName, List<Object> options, Map<String,Object> labels)` Equivalent of the standard syntax' "Option" function.
`Object`	`option(String entryName, Object... options)` Equivalent of the standard syntax "Option" function.
`Object`	`options(String entryName, List<Object> options, Map<String,Object> labels)` Equivalent of the standard syntax multi-select "Options" function.
`Object`	`options(String entryName, Object... options)` Equivalent of the standard syntax multi-select "Options" function.
`Object`	`otherCustomer(String parameterName)` A method to trigger a custom-named customer picker input parameter.
`Object`	`otherCustomer(String parameterName, String attributeName)` A method to trigger a custom-named customer picker input parameter.
`Object`	`otherCustomer(String parameterName, String attributeName, boolean defaultFromParent)` A method to trigger a custom-named customer picker input parameter.
`Object`	`otherProduct(String parameterName)` A method to trigger a custom-named product picker input parameter.
`Object`	`otherProduct(String parameterName, String attributeName)` A method to trigger a custom-named product picker input parameter.
`Date`	`parseDate(String pattern, String date)` Parses a date (entered in as string) according to the given pattern.
`DateTime`	`parseDateTime(String pattern, String datetime)` Parses a datetime (entered in as string) according to the given pattern.
`DateTime`	`parseDateTime(String pattern, String datetime, int tzHoursOffset, int tzMinutesOffset)` Parses a datetime (entered in as string) according to a given pattern and time zone.
`Map<String,Object>`	`previousContext(String sku)` In case of (chained) price lists, this method allows for easy retrieval of records from the previous list.
`Map<String,Object>`	`previousContext(String sku, String key2)` In case of (chained) price lists, this method allows for easy retrieval of records from the previous list.
`Object`	`pricelist(String listName)` Equivalent of the standard syntax "Pricelist" function.
`Object`	`pricelist(String listName, String attributeName)` Equivalent of the standard syntax "Pricelist" function.
`Object`	`pricelist(String listName, String attributeName, String sku)` Equivalent of the standard syntax "Pricelist" function.
`Object`	`pricelist(String listName, String attributeName, String sku, String key2)` Equivalent of the standard syntax "Pricelist" function.
`Object`	`pricelistItem(String listName)` Equivalent of the standard syntax "Pricelist" function - with the difference that the full item is returned.
`Object`	`pricelistItem(String listName, String sku)` Equivalent of the standard syntax "Pricelist" function - with the difference that the full item is returned.
`Object`	`pricelistItem(String listName, String sku, String key2)` Equivalent of the standard syntax "Pricelist" function - with the difference that the full item is returned.
`Object`	`product()` Returns the current product object.
`Object`	`product(String attributeName)` Equivalent of the standard syntax "Product" function.
`Object`	`product(String attributeName, String sku)` Equivalent of the standard syntax "Product" function.
`Object`	`productCompetition()` Equivalent of the standard syntax "Competition" function.
`Object`	`productCompetition(Filter... filters)` Equivalent of the standard syntax "Competition" function.
`Object`	`productExtension(String extensionName)` Equivalent of the standard syntax "PXLookup" function.
`Object`	`productExtension(String extensionName, Filter... filters)` Equivalent of the standard syntax "PXLookup" function.
`Object`	`productGroupEntry(String... entryName)` Equivalent of the standard syntax "ProductGroup" function.
`Filter`	`productToRelatedObjectsFilter(String relatedObjectTypeCode, String sku)` 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.
`Object`	`productXRef()` Equivalent of the standard syntax "XRefLookup" function.
`Object`	`productXRef(Filter... filters)` Equivalent of the standard syntax "XRefLookup" function.
`void`	`putGlobal(Map<String,Object> globalVars)` Puts an entire map of variables into the global cache.
`Random`	`random()`
`Object`	`rebateAgreementUserEntry(String parameterName, String attributeName)` Prompts user for rebate agreement.
`void`	`redAlert(String msg)` Marks the current formula element with a red alert and the given message.
`Filter`	`relatedObjectToCustomersFilter(String relatedObjectTypedId)` 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.
`Filter`	`relatedObjectToProductsFilter(String relatedObjerelatedObjectTypedId)` 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.
`void`	`removeManualOverride(String elementName)` Removes a user entered value that overrides the calculated result of a formula element.
`void`	`removeSharedCache(String key)` Deletes a key from the shared chache
`void`	`resetSKUContextSwitch()` Resets a sku context switch to the origionally specified sku.
`Map<String,String>`	`roles()` Lists all roles available in the application.
`List<Map<String,Object>>`	`runSummaryQuery(ItemSummaryQuery<? extends CalculableObject> query)` Runs (executes) a summary query defined by the parameterized query object, which was created by one of the getXXXSummaryQuery calls.
`void`	`sendEmail(String to, String subject, String message)` Sends an email.
`void`	`setSharedCache(String key, String value)` Stores a string value in the shared cache with the given key.
`AbstractProducer.ResultIterator`	`stream(String typeCode, String sortBy, Filter... filters)` Search for all types of objects with a freestyle query, and iterate over the result set.
`AbstractProducer.ResultIterator`	`stream(String typeCode, String sortBy, List<String> fields, boolean distinctValuesOnly, Filter... filters)` Search for all types of objects with a freestyle query, and iterate over the result set.
`AbstractProducer.ResultIterator`	`stream(String typeCode, String sortBy, List<String> fields, Filter... filters)` Search for all types of objects with a freestyle query, and iterate over the result set.
`AbstractProducer.ResultIterator`	`stream(String typeCode, String sortBy, Map<String,String> fields, boolean distinctValuesOnly, Filter... filters)` Search for all types of objects with a freestyle query, and iterate over the result set.
`Object`	`stringUserEntry(String entryName)` Equivalent of the standard syntax "StringUserEntry" function.
`Object`	`stringUserEntry(String entryName, String textMask)` Equivalent of the standard syntax "StringUserEntry" function.
`Object`	`stringUserEntry(String entryName, String textMask, String label)` Equivalent of the standard syntax "StringUserEntry" function.
`void`	`switchSKUContext(String newSKU)` Temporarily switches the current sku context to another sku.
`Date`	`targetDate()` Gets the current execution context's target date.
`Object`	`textUserEntry(String entryName)` Equivalent of the standard syntax "TextUserEntry" function.
`Object`	`textUserEntry(String entryName, String label)` Equivalent of the standard syntax "TextUserEntry" function.
`void`	`throwException(String errorMessage)` Throws a calculation exception with the specified message and aborts the calculation.
`Object`	`timeUserEntry(String entryName)` Equivalent of the standard syntax "TimUserEntry" function.
`void`	`trace(String functionName, String parameters, Object result)` Generates a trace message that can be used in the formula test drive.
`Long`	`triggerCFSCalculation(Long cfsID)` This method will create a new background calculation job for the specified CFS Note: This operation will only work in contexts that allow object modification (CFS,CalculationFlow and direct formula execution via JSON API).
`Long`	`triggerPriceGridCalculation(Long priceGridId, Map<String,Object> parameters)` This method will create new background calculation job for the specified PriceGrid.
`Object`	`update(String typeCode, Map<String,Object> values)` Updates an object in the collection of objects of the given type.
`Object`	`updateCalculableObjectHeader(String calcObjTypeCode, String calcObjName)` Updates the header information of a CalculableObject (e.g., a price grid, a price list, etc.).
`Object`	`user()` Returns the entire master data object of the current user.
`Object`	`user(String attributeName)` Returns a value from the current user's master data.
`Object`	`userEntry(String entryName)` Equivalent of the standard syntax "UserEntry" function.
`String`	`uuid()` Generates a RFC4122, version 4 ID.
`String`	`uuid(int len)` Generate a random uuid of the specified length.
`String`	`uuid(int len, int radix)` Generates a random uuid of the specified length, and radix.
`Object`	`vLookup(String parameterName)` Equivalent of the standard syntax "VLookup" function.
`Object`	`vLookup(String parameterName, Object attributeNameOrKeyOrRangeValue)` Equivalent of the standard syntax "VLookup" function.
`Object`	`vLookup(String parameterName, String attributeName, String key)` Equivalent of the standard syntax "VLookup" function.
`Object`	`vLookup(String parameterName, String attributeName, String key1, String key2)` Equivalent of the standard syntax "VLookup" function.
`Object`	`vLookup(String parameterName, String attributeName, String key1, String key2, String key3)` Equivalent of the standard syntax "VLookup" function.
`Object`	`vLookup(String parameterName, String attributeName, String key1, String key2, String key3, String key4)` Equivalent of the standard syntax "VLookup" function.
`Object`	`vLookup(String parameterName, String attributeName, String key1, String key2, String key3, String key4, String key5)` Equivalent of the standard syntax "VLookup" function.
`Object`	`vLookup(String parameterName, String attributeName, String key1, String key2, String key3, String key4, String key5, String key6)` Equivalent of the standard syntax "VLookup" function.
`Filter`	`walkFilter(Filter filter, Closure<?> visitBefore, Closure<?> visitAfter, boolean removeNulls)` Walks a filter and all its sub filters, visiting each filter in the tree.
`WrappedResult`	`wrap(Object result)` Wraps a result to make sure the original result object appears in the json response.
`void`	`yellowAlert(String msg)` Marks the current formula element with a yellow alert and the given message.

- Method Detail
  - isSyntaxCheck
```
boolean isSyntaxCheck()
```
    Returns true if the formula is executed in syntax check (or parameter determination) mode.
  - isDebugMode
```
boolean isDebugMode()
```
    Returns true if formula is called via UI debug/test exec mode.
    
    Returns:
    
    true if executed in debug mode
  - isDistributedMode
```
boolean isDistributedMode()
```
    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. These operations are basically all writing operations that affect other items. Examples are: all object modification ops (add, addOrUpdate, update, delete) and marking other items dirty
    
    Returns:
    
    true if executed in distributed mode
  - getGlobal
```
Map<String,Object> getGlobal()
```
    A publicly available cache (as a hashmap) for storing and sharing values across formula elements. If api.retainGlobal is set to true, this map will also be available with the entire list calculation, i.e across item boundaries. It can be also accessed directly as api.global. Important: This map must be treated as a cache. It means that the formula should never rely on the cached values, as in various situations this cache is purged or structured differently. For example, in a distributed calculation, every calculation thread has its own cache; or in a multi-pass list calculation, the subsequent passes may not have the cache of the previous pass available. The system always tries to make it available, but the formula should never rely on it.
    
    Returns:
    
    the hashmap
  - putGlobal
```
void putGlobal(Map<String,Object> globalVars)
```
    Puts an entire map of variables into the global cache.
    
    Parameters:
    
    globalVars - The map of variables to put into the global cache
  - getCalculationContext
```
String getCalculationContext()
```
    Retreive the CalculationContext of the formula evaluation (aka formula element group).
    - a) For a PA Calculation or Flush formula this can be (from PriceFxInterface):
      
      - FORMULAELEMENTGROUP_DM_INIT = "init";
      
      - FORMULAELEMENTGROUP_DM_ROW = "row";
      
      - FORMULAELEMENTGROUP_DM_SUMMARY = "summary";
    - b) In RebateAgreement calculation we have:
      
      - FORMULAELEMENTGROUP_RM_AGREEMENT = "agreement";
      
      - FORMULAELEMENTGROUP_RM_AGREEMENT_READONLY = "agreementReadOnly";
      
      - FORMULAELEMENTGROUP_RM_REBATERECORD = "rebateRecord";
    - c) In the Optimizer module, when evaluating Model formulas, there is:
      
      - FORMULAELEMENTGROUP_MODEL_DEFINITION = "definition";
      
      - FORMULAELEMENTGROUP_MODEL_CALCULATION = "calculation";
      
      - FORMULAELEMENTGROUP_MODEL_ANALYSIS = "analysis";
    Returns:
    
    CalculationContext as String
  - getId
```
Long getId(Object obj)
```
    Returns the id part of an object. The method tries to be smart and extracts also ids from maps. or typedId strings
  - getElement
```
Object getElement(String name)
```
    Gets the result of a previous formula element.
    
    Parameters:
    
    name - Name of the formula element
    
    Returns:
    
    The value or null if the element is not found
  - getSecondaryKey
```
Object getSecondaryKey()
```
    Gets the secondary key in case a matrix pricelist or matrix simulation is processed.
    
    Returns:
    
    The value of the secondary key
  - getBinding
```
Object getBinding(String name)
```
    Gets a named binding variable from a library function. Example:
    In a workflow formula the workflow can be referenced in a groovy element directly by the binding/variable "workflow": workflow.addApprovalStep("First Approval")
    However this does not work from a library function as this script does not have the binding available. This would work: api.getBinding("workflow").addApprovalStep("First Approval")
  - targetDate
```
Date targetDate()
```
    Gets the current execution context's target date.
    
    Returns:
    
    The date
  - calendar
```
Calendar calendar()
```
    Gets a calendar object initialized with the current targetDate (or now if no target date is given).
    
    Returns:
    
    The initialized Calendar object
  - calendar
```
Calendar calendar(Date date)
```
    Gets a calendar object initialized with date.
    
    Parameters:
    
    date - The date to initialize the calendar with
    
    Returns:
    
    The initialized Calendar object
  - random
```
Random random()
```
    Returns:
    
    The java.util.Random generator instance created for the duration of the calculation task. (i.e.) does not get recreated for each formula (element) evaluation).
  - datamartCalendar
```
Object datamartCalendar()
```
    Deprecated. Use DatamartContext.calendar() instead.
    
    Returns:
    
    A DatamartCalendar object.
  - newDatamartSlice
```
@Deprecated
Object newDatamartSlice()
```
    Deprecated. Now provided by DatamartContext.
    
    Creates a new DatamartSlice, which allows for setting filter criteria along the Time, CustomerGroup, ProductGroup or any other dimensions in a Datamart.
    
    Returns:
    
    The instantiated, empty, DatamartContext.DataSlice object.
  - newDatamartSlice
```
Object newDatamartSlice(String dateFieldName,
                        Object... timePeriodsAndProductAndCustomerGroups)
```
    Deprecated. Now provided by DatamartContext.
    
    Creates a new DatamartSlice, which allows for setting filter criteria along the Time, CustomerGroup, ProductGroup or any other dimensions in a Datamart, intiialized with the name of the time dimension field, and an optional set filter criteria.
    
    Parameters:
    
    dateFieldName - Name of the time dimension field.
    
    timePeriodsAndProductAndCustomerGroups - TimePeriod, CustomerGroup, ProductGroup filters.
    
    Returns:
    
    The initialzied DatamartContext.DataSlice object.
  - datamartFilter
```
Filter datamartFilter(Object groupOrSlice)
```
    Translates a CustomerGroup/ProductGroup/DMDataSlice to its equivalent Filter representation, mapping domain level field names to the corresponding Datamart field names in the process.
    Note: A DMDataSlice object can be instantiated by api.newDatamartSlice, or in a Rebate calculation context, referenced by the 'calulationBase' binding.
    
    Parameters:
    
    groupOrSlice - The CustomerGroup/ProductGroup/DMDataSlice to translate into Datamart level filter criteria
    
    Returns:
    
    Filter object representing either the CustomerGroup/ProductGroup dimension slice, or the passed slice in the Datamart
  - datamartQuery
```
Object datamartQuery(Object... queryAndDatamartAndProjectionsAndFilters)
```
    Important: please use the Groovy query API instead (see DatamartContext). This method only exists for backward compatibility for older in-production formulas. Runs a query against a PA datamart. The query is only executed once on the scope of a calculation job (PL generation etc.). A query is identified by the first argument. This is also the 'handle' by which datamartLookup refers to the result set of the query.
    
    Parameters:
    
    queryAndDatamartAndProjectionsAndFilters - First argument is the query ID/handle. Subsequent arguments are either DM field names (projections) or filter objects.
    
    Returns:
    
    The numbers of rows in the result set. The actual result set data is stored in memory for subsequent lookup by datamartLookup(...).
  - datamartLookup
```
Object datamartLookup(Object... queryAndProjectionsAndFilters)
```
    Important: Please use the Groovy query API instead (see DatamartContext). This method only exists for backward compatibility for older in-production formulas. Looks up rows in the result of a datamartQuery(...) call.
    
    Parameters:
    
    queryAndProjectionsAndFilters - The first arguments is the ID/handle from a datamartQuery(...) call. Subsequent arguments refer to projections specified in the datamartQuery call, or filter objects leading to additional filtering of rows in the result set.
    
    Returns:
    
    A single primitive value if the result of the lookup results in one row for just one projection. A list of values if the result is multiple rows for one projection. A map of (field name, value) pairs for a single row result with multiple projections. Finally, a Matrix2D object in cse of multiple rows and projecitons.
  - getDatamartContext
```
DatamartContext getDatamartContext()
```
    The DatamartContext provides an API for querying and loading PA data.
    
    Returns:
    
    DatamartContext
  - getTableContext
```
TableContext getTableContext()
                      throws Exception
```
    The TableContext provides an SQL query (SELECT only) interface to PA query results.
    
    Returns:
    
    TableContext
    
    Throws:
    
    Exception
  - getDatamartRowSet
```
DatamartRowSet getDatamartRowSet()
```
    Available in a PA DataLoad context only, a DatamartRowSet provides access to the rows being loaded or calculated.
    
    Returns:
    
    The DatamartRowSet holding the data rows to load in the target FC.
  - getDatamartRowSet
```
DatamartRowSet getDatamartRowSet(String name)
```
    Available in a PA DataLoad context only, a DatamartRowSet provides access to the rows currently being loaded or calculated. The following DL types make use of rowsets:
    - - 'Flush': The source rowset gives access to the DataFeed data rows, while the target rowset holds the rows to be loaded in the target DataSource (DS).
    - - 'Calculate': The source rowset gives access to the source rows, which can either come from a DF or from the target FC being calculated. The target rowset holds the rows to be loaded in the target FC. Initially, this rowset will be empty unless the DL.withTargetSnapshot option is set, in which case the rowset will be pre-populated with the target FC rows in the scope of the DL (determined by the DL.filter).
    Parameters:
    
    name - Either 'source' or 'target', to select the source FC or target FC rowset.
    
    Returns:
    
    The DatamartRowSet holding either the source or target rowset.
  - switchSKUContext
```
void switchSKUContext(String newSKU)
```
    Temporarily switches the current sku context to another sku. This can be used to call functions that rely on a sku context and do not allow to specify an alternate sku with a different sku. The switch is reset by resetSKUContextSwitch() or automatically.
    
    Parameters:
    
    newSKU - The new sku to switch to.
  - resetSKUContextSwitch
```
void resetSKUContextSwitch()
```
    Resets a sku context switch to the origionally specified sku.
  - product
```
Object product()
```
    Returns the current product object. This one does not exist in the regular syntax, but is useful in Groovy.
    
    Returns:
    
    The full current product
  - product
```
Object product(String attributeName)
```
    Equivalent of the standard syntax "Product" function. Retrieves the given attribute's value of the current product.
    
    Parameters:
    
    attributeName - The attribute whose value to return
    
    Returns:
    
    The value of the attribute
  - product
```
Object product(String attributeName,
               String sku)
```
    Equivalent of the standard syntax "Product" function. Retrieves the given attribute's value of the given product.
    
    Parameters:
    
    attributeName - The attribute whose value to return
    
    sku - The product
    
    Returns:
    
    The value of the attribute (or null if product not found)
  - otherProduct
```
Object otherProduct(String parameterName,
                    String attributeName)
```
    A method to trigger a custom-named product picker input parameter.
    
    Parameters:
    
    parameterName - The name of the parameter
    
    attributeName - The attribute which value to return (null for the entire object)
    
    Returns:
    
    The attribute value
  - otherProduct
```
Object otherProduct(String parameterName)
```
    A method to trigger a custom-named product picker input parameter.
    
    Parameters:
    
    parameterName - The name of the parameter
    
    Returns:
    
    The product object
  - productExtension
```
Object productExtension(String extensionName)
```
    Equivalent of the standard syntax "PXLookup" function. Retrieves a list of PX entries for the current product.
    
    Parameters:
    
    extensionName - The name of the extension
    
    Returns:
    
    A list of matching PX records
  - productExtension
```
Object productExtension(String extensionName,
                        Filter... filters)
```
    Equivalent of the standard syntax "PXLookup" function. Retrieves a list of PX entries for the current product.
    
    Parameters:
    
    extensionName - The name of the extension
    
    filters - One or more filter(java.lang.String, java.lang.Object) objects that narrow down the PX search
    
    Returns:
    
    A list of matching PX records
  - productCompetition
```
Object productCompetition()
```
    Equivalent of the standard syntax "Competition" function. Retrieves a list of competition records for the current product.
    
    Returns:
    
    A list of PCOMP records
  - productCompetition
```
Object productCompetition(Filter... filters)
```
    Equivalent of the standard syntax "Competition" function. Retrieves a list of competition records for the current product.
    
    Returns:
    
    * @param filters One or more filter(java.lang.String, java.lang.Object) objects that narrow down the competition search
  - productXRef
```
Object productXRef()
```
    Equivalent of the standard syntax "XRefLookup" function. Retrieves a list of x-reference records for the current product.
    
    Returns:
    
    A list of PXREF records
  - rebateAgreementUserEntry
```
Object rebateAgreementUserEntry(String parameterName,
                                String attributeName)
```
    Prompts user for rebate agreement.
    
    Parameters:
    
    parameterName - - (mandatory) name of entry in input parameters listing
    
    attributeName - - (mandatory) name of attribute you need
    
    Returns:
    
    attribute of rebate agreement or null if RA does not exists
  - productXRef
```
Object productXRef(Filter... filters)
```
    Equivalent of the standard syntax "XRefLookup" function. Retrieves a list of x-reference records for the current product.
    
    Parameters:
    
    filters - One or more filter(java.lang.String, java.lang.Object) objects that narrow down the PXREF search
  - customer
```
Object customer(String attributeName)
```
    Equivalent of the standard syntax "Customer" function. Retrieves the given attribute's value of the customer context parameter.
    
    Parameters:
    
    attributeName - The attribute whose value to return
    
    Returns:
    
    The value of the attribute
  - customer
```
Object customer(String attributeName,
                boolean defaultFromParent)
```
    Equivalent of the standard syntax "Customer" function. Retrieves the given attribute's value of the customer context parameter. If the value is null and defaultFromParent is true, it retrieves (and returns) the value from the customer's parent no matter if that value is null as well or not. In case there's no parent customer set, null will be returned.
    
    Parameters:
    
    attributeName - The attribute whose value to return
    
    defaultFromParent - Tells whether to lookup the value from the parent customer (if any) in case it's null in the customer
    
    Returns:
    
    The value of the attribute
  - customer
```
Object customer(String attributeName,
                String customerId)
```
    Equivalent of the standard syntax "Customer" function. Retrieves the given attribute's value of the given customer.
    
    Parameters:
    
    attributeName - The attribute whose value to return
    
    customerId - The customerId value for the customer search
    
    Returns:
    
    The value of the attribute (or null if no customer found)
  - customer
```
Object customer(String attributeName,
                String customerId,
                boolean defaultFromParent)
```
    Equivalent of the standard syntax "Customer" function. Retrieves the given attribute's value of the given customer. If the value is null and defaultFromParent is true, it retrieves (and returns) the value from the customer's parent no matter if that value is null as well or not. In case there's no parent customer set, null will be returned.
    
    Parameters:
    
    attributeName - The attribute whose value to return
    
    customerId - The customerId value for the customer search
    
    defaultFromParent - Tells whether to lookup the value from the parent customer (if any) in case it's null in the customer
    
    Returns:
    
    The value of the attribute (or null if no customer found)
  - customer
```
Object customer(String attributeName,
                String customerId,
                boolean defaultFromParent,
                String filterFormulaName,
                Object filterFormulaParam)
```
    Equivalent of the standard syntax' "Customer" function. Retrieves a named attribute's value of the named customer (if the value is null and defaultFromParent is true, retrieves (and returns) the value from the customer's parent no matter if that value is null as well or not. In case there's no parent customer set, null will be returned)
    
    Parameters:
    
    attributeName - The attribute whose value to return
    
    customerId - The customerId value for the customer search
    
    defaultFromParent - Tells whether to lookup the value from the parent customer (if any) in case it's null in the customer
    
    filterFormulaName - Unique name of a formula, that will be triggered when Customer Picker opens
    
    filterFormulaParam - Additional data for filterFormula (e.g. agreement's typedId,...)
    
    Returns:
    
    The value of the attribute (or null if no customer found)
  - otherCustomer
```
Object otherCustomer(String parameterName)
```
    A method to trigger a custom-named customer picker input parameter.
    
    Parameters:
    
    parameterName - The name of the parameter
    
    Returns:
    
    The customer object
  - otherCustomer
```
Object otherCustomer(String parameterName,
                     String attributeName)
```
    A method to trigger a custom-named customer picker input parameter.
    
    Parameters:
    
    parameterName - The name of the parameter
    
    attributeName - The attribute which value to return (null for the entire object)
    
    Returns:
    
    The attribute value
  - otherCustomer
```
Object otherCustomer(String parameterName,
                     String attributeName,
                     boolean defaultFromParent)
```
    A method to trigger a custom-named customer picker input parameter.
    
    Parameters:
    
    parameterName - The name of the parameter
    
    attributeName - The attribute which value to return (null for the entire object)
    
    defaultFromParent - Tells whether to lookup the attribute's value from the parent customer (if any) in case it's null in the customer
    
    Returns:
    
    The attribute value
  - customerExtension
```
Object customerExtension(String extensionName,
                         Filter... filters)
```
    Equivalent of the standard syntax "CXLookup" function. Retrieves a list of CX entries for the current customer (via context parameter).
    
    Parameters:
    
    extensionName - The name of the extension
    
    filters - No, one or more filter(java.lang.String, java.lang.Object) object/s that narrow down the CX search
    
    Returns:
    
    A list of matching CX records
  - getCalculableLineItem
```
<T extends CalculableLineItem> T getCalculableLineItem(Object clic,
                                                       String lineId)
```
    Returns a line item of the given calculable line item collection (a.k.a. clic). Currently, there are three types of clics in total: Quote, Contract, and Rebate Agreement.
    
    Parameters:
    
    clic - the clic to which the line item belongs. it may either be the clic object as such (its map representation to be exact), or typedId or a uniqueName
    
    lineId - the lineId of the line item
  - getCalculableLineItemResult
```
Object getCalculableLineItemResult(Object cli,
                                   String... resultNamesOrLabels)
```
    Returns result(s) of the given name(s) (or label(s)) from a line item object (its map representation, to be exact).
    Note: The line item object will typically be fetched via getCalculableLineItem(Object, String).
    
    Returns:
    
    either single result or a map(nameOrLabel,result) of results if there were more names (labels) specified
  - getCalculableLineItemCollection
```
Object getCalculableLineItemCollection(String typedId)
```
    Returns the full object (header and line items) of e.g. a quote, a rebate agreement or a contract.
    
    Returns:
    
    A map specifying the line item collection or null if invalid typedId was passed
  - createNewRevision
```
Object createNewRevision(String typedId)
```
    Creates a revision of CalculableLineItemCollection (Quote/Rebate Agreement/Contract).
    
    Returns:
    
    A map specifying the revised line item collection or null if invalid typedId was passed
  - addWarning
```
void addWarning(String message)
```
    Adds a warning to the formula execution warning log.
    
    Parameters:
    
    message - The warning text message
  - contextByLabel
```
Object contextByLabel(String label)
```
    Equivalent of the standard syntax "ContextByLabel" function. Retrieves a previous calculation result by formula element label (rather than the element result name).
    
    Parameters:
    
    label - The formula element label
    
    Returns:
    
    The calculation result of that element
  - vLookup
```
Object vLookup(String parameterName)
```
    Equivalent of the standard syntax "VLookup" function.
    
    Parameters:
    
    parameterName - The name of the price parameter table
    
    Returns:
    
    The user selected value. In case of matrix lookups the entire object/row
  - vLookup
```
Object vLookup(String parameterName,
               Object attributeNameOrKeyOrRangeValue)
```
    Equivalent of the standard syntax "VLookup" function.
    Example:
    ownShippingCost = api.vLookup("Shipping_Costs", api.product("attribute25").toString())
    Parameters:
    
    parameterName - The name of the price parameter table
    
    attributeNameOrKeyOrRangeValue - A predefined key, or range value (hence no user input required), or in case of a matrix lookup the attribute name => user entry required
    
    Returns:
    
    The value of the parameter table.
  - vLookup
```
Object vLookup(String parameterName,
               String attributeName,
               String key)
```
    Equivalent of the standard syntax "VLookup" function. This syntax is only relevant for matrix parameters.
    Example:
    def prevailing = api.vLookup("MixThreshold", "attribute1", "Prevailing")
    Parameters:
    
    parameterName - The name of the price parameter table
    
    attributeName - The name of the attribute to retrieve
    
    key - The key of the parameter table
    
    Returns:
    
    The value of the named attribute for that key
  - vLookup
```
Object vLookup(String parameterName,
               String attributeName,
               String key1,
               String key2)
```
    Equivalent of the standard syntax "VLookup" function. This syntax is only relevant for matrix 2-key parameters.
    
    Parameters:
    
    parameterName - The name of the price parameter table
    
    attributeName - The name of the attribute to retrieve
    
    key1 - The key1 of the parameter table
    
    key2 - The key2 of the parameter table
    
    Returns:
    
    The value of the named attribute for that key combination
  - vLookup
```
Object vLookup(String parameterName,
               String attributeName,
               String key1,
               String key2,
               String key3)
```
    Equivalent of the standard syntax "VLookup" function. This syntax is only relevant for matrix 3-key parameters.
    
    Parameters:
    
    parameterName - The name of the price parameter table
    
    attributeName - The name of the attribute to retrieve
    
    key1 - The key1 of the parameter table
    
    key2 - The key2 of the parameter table
    
    key3 - The key3 of the parameter table
    
    Returns:
    
    The value of the named attribute for that key combination
  - vLookup
```
Object vLookup(String parameterName,
               String attributeName,
               String key1,
               String key2,
               String key3,
               String key4)
```
    Equivalent of the standard syntax "VLookup" function. This syntax is only relevant for matrix 4-key parameters.
    
    Parameters:
    
    parameterName - The name of the price parameter table
    
    attributeName - The name of the attribute to retrieve
    
    key1 - The key1 of the parameter table
    
    key2 - The key2 of the parameter table
    
    key3 - The key3 of the parameter table
    
    key4 - The key4 of the parameter table
    
    Returns:
    
    The value of the named attribute for that key combination
  - vLookup
```
Object vLookup(String parameterName,
               String attributeName,
               String key1,
               String key2,
               String key3,
               String key4,
               String key5)
```
    Equivalent of the standard syntax "VLookup" function. This syntax is only relevant for matrix 4-key parameters.
    
    Parameters:
    
    parameterName - The name of the price parameter table
    
    attributeName - The name of the attribute to retrieve
    
    key1 - The key1 of the parameter table
    
    key2 - The key2 of the parameter table
    
    key3 - The key3 of the parameter table
    
    key4 - The key4 of the parameter table
    
    key5 - The key5 of the parameter table
    
    Returns:
    
    The value of the named attribute for that key combination
  - vLookup
```
Object vLookup(String parameterName,
               String attributeName,
               String key1,
               String key2,
               String key3,
               String key4,
               String key5,
               String key6)
```
    Equivalent of the standard syntax "VLookup" function. This syntax is only relevant for matrix 4-key parameters.
    
    Parameters:
    
    parameterName - The name of the price parameter table
    
    attributeName - The name of the attribute to retrieve
    
    key1 - The key1 of the parameter table
    
    key2 - The key2 of the parameter table
    
    key3 - The key3 of the parameter table
    
    key4 - The key4 of the parameter table
    
    key5 - The key5 of the parameter table
    
    key6 - The key6 of the parameter table
    
    Returns:
    
    The value of the named attribute for that key combination
  - userEntry
```
Object userEntry(String entryName)
```
    Equivalent of the standard syntax "UserEntry" function. Will trigger a numeric input element.
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    Returns:
    
    The user entered value
  - decimalUserEntry
```
Object decimalUserEntry(String entryName)
```
    Alias of "userEntry", to conform to the general naming structure
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    Returns:
    
    The user entered value
  - integerUserEntry
```
Object integerUserEntry(String entryName)
```
    Equivalent of the standard syntax "IntegerUserEntry" function. It will trigger a numeric input element allowing whole numbers only.
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    Returns:
    
    The user entered value
  - stringUserEntry
```
Object stringUserEntry(String entryName)
```
    Equivalent of the standard syntax "StringUserEntry" function. It will trigger a single-line text input element.
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    Returns:
    
    The user entered value
  - stringUserEntry
```
Object stringUserEntry(String entryName,
                       String textMask)
```
    Equivalent of the standard syntax "StringUserEntry" function. It will trigger a single-line text input element.
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    textMask - Optional text mask that is displayed in the UI
    
    Returns:
    
    The user entered value
  - stringUserEntry
```
Object stringUserEntry(String entryName,
                       String textMask,
                       String label)
```
    Equivalent of the standard syntax "StringUserEntry" function. It will trigger a single-line text input element.
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    textMask - Optional text mask that is displayed in the UI
    
    label - Label of the entry box
    
    Returns:
  - textUserEntry
```
Object textUserEntry(String entryName)
```
    Equivalent of the standard syntax "TextUserEntry" function. It will trigger a textbox (multiline) input element.
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    Returns:
    
    The user entered value
  - textUserEntry
```
Object textUserEntry(String entryName,
                     String label)
```
    Equivalent of the standard syntax "TextUserEntry" function. It will trigger a textbox (multiline) input element.
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    label - Label of the entry box
    
    Returns:
  - booleanUserEntry
```
Object booleanUserEntry(String entryName)
```
    Equivalent of the standard syntax "BooleanUserEntry" function. It will trigger a Boolean input element.
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    Returns:
    
    The user entered value
  - dateUserEntry
```
Object dateUserEntry(String entryName)
```
    Equivalent of the standard syntax "DateUserEntry" function. It will trigger a date input element. See also: parseDate(String, String)
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    Returns:
    
    The user entered value as String in the format yyyy-MM-dd
  - timeUserEntry
```
Object timeUserEntry(String entryName)
```
    Equivalent of the standard syntax "TimUserEntry" function. It will trigger a time input element. See also: parseDate(String, String)
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    Returns:
    
    The user entered value as String in the format HH:mm
  - dateTimeUserEntry
```
Object dateTimeUserEntry(String entryName)
```
    Equivalent of the standard syntax "DateTimeUserEntry" function. It will trigger a datetime input element. See also: parseDate(String, String)
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    Returns:
    
    The user entered value as String in the format yyyy-MM-dd'T'HH:mm:ss
    
    (Important note: the format implicitly uses the GMT/UTC time zone and so the returned value may differ from what was entered in on the client. As client time may be in a different time zone.)
  - productGroupEntry
```
Object productGroupEntry(String... entryName)
```
    Equivalent of the standard syntax "ProductGroup" function. It will trigger a product group picker entry.
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    Returns:
    
    The entered product group
  - customerGroupEntry
```
Object customerGroupEntry(String... entryName)
```
    Equivalent of the standard syntax "CustomerGroup" function. It will trigger a customer group picker entry.
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    Returns:
    
    The entered customer group
  - customerGroupEntry
```
Object customerGroupEntry(String entryName,
                          String filterFormulaName,
                          Object filterFormulaParam)
```
    Equivalent of the standard syntax "CustomerGroup" function. It will trigger a customer group picker entry.
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    filterFormulaName - Unique name of a formula, that will be triggered when Customer Picker opens
    
    filterFormulaParam - Additional data for filterFormula (e.g. agreement's typedId,...)
    
    Returns:
    
    The entered customer group
  - multiTierEntry
```
Object multiTierEntry(String entryName,
                      String... arguments)
```
    Equivalent of the standard syntax "MultiTierEntry" function. It will trigger a multi tier entry type.
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    arguments - Two value hints, sort type and order validation type. Sort type can be one of ASC (default), DESC, and order validation one of VALIDATE and NO_VALIDATION.
  - option
```
Object option(String entryName,
              Object... options)
```
    Equivalent of the standard syntax "Option" function. It will trigger a drop down list entry with defined values.
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    options - An arbitrary number of parameters that make up the drop down
    
    Returns:
    
    The user entered value
  - option
```
Object option(String entryName,
              List<Object> options,
              Map<String,Object> labels)
```
    Equivalent of the standard syntax' "Option" function. It will trigger a drop down list entry with defined values. You can add custom (display-only) labels
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    options - A list of an arbitrary number of parameters that make up the drop down
    
    labels - A map (value => label) of labels that should be shown in the UI. If null or empty will behave same as api.option() without label definition
    
    Returns:
    
    The user entered value
  - options
```
Object options(String entryName,
               Object... options)
```
    Equivalent of the standard syntax multi-select "Options" function. It will trigger a drop down list entry with defined values.
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    options - An arbitrary number of parameters that make up the drop down
    
    Returns:
    
    List of user selected values
  - options
```
Object options(String entryName,
               List<Object> options,
               Map<String,Object> labels)
```
    Equivalent of the standard syntax multi-select "Options" function. It will trigger a drop down list entry with defined values. You can add custom (display-only) labels
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    options - A list of an arbitrary number of parameters that make up the drop down
    
    labels - A map (value => label) of labels that should be shown in the UI. If null or empty will behave same as api.option() without label definition
    
    Returns:
    
    List of user selected values
  - filterBuilderUserEntry
```
Object filterBuilderUserEntry(String entryName,
                              String typeCode)
```
    Equivalent of the standard syntax "FilterBuilderUserEntry" function.
    It will trigger a FilterBuilder widget allowing to construct a filter object filtering upon the object type represented by the passed typeCode (e.g. to filter upon Products, the typeCode will be P).
    The filter object will typically be used in other API functions, like find(String, Filter...).
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    typeCode - A type code string of the type of the object to filter upon. Supported type codes are P (i.e. Product data) and C (i.e. Customer data), at the moment
    
    Returns:
    
    A filter object
  - datamartFilterBuilderUserEntry
```
Object datamartFilterBuilderUserEntry(String entryName,
                                      String source,
                                      Object... args)
```
    Equivalent of the standard syntax "DatamartFilterBuilderUserEntry" function.
    It will trigger a FilterBuilder widget allowing to construct a filter object filtering upon the specified source.
    The filter object will typically be used in other API functions, like datamartQuery(Object...).
    Parameters:
    
    entryName - The name of the user entry parameter
    source - The name of the source to filter upon. Resolution of the source as follows
    
    any datamart, by typedId, sourceName, uniqueName or label (uniqueName and label for backwards compatibility)
    
    any FieldCollection, by typedId or sourceName
    Returns:
    
    A filter object
  - pricelist
```
Object pricelist(String listName)
```
    Equivalent of the standard syntax "Pricelist" function.
    
    Parameters:
    
    listName - The name of the pricelist. Target date matching and sku context applies.
    
    Returns:
    
    The resultPrice of the pricelist record for the sku
  - pricelist
```
Object pricelist(String listName,
                 String attributeName)
```
    Equivalent of the standard syntax "Pricelist" function.
    
    Parameters:
    
    listName - The name of the pricelist. Target date matching and sku context applies.
    
    attributeName - The name of the attribute to retrieve
    
    Returns:
    
    The value of the attributeName column of the pricelist record
  - pricelist
```
Object pricelist(String listName,
                 String attributeName,
                 String sku)
```
    Equivalent of the standard syntax "Pricelist" function. SKU is taken from parameter and not context.
    
    Parameters:
    
    listName - The name of the pricelist. Target date matching applies.
    
    attributeName - The name of the attribute to retrieve
    
    sku - The sku to use
    
    Returns:
    
    The value of the attributeName column of the pricelist record
  - pricelist
```
Object pricelist(String listName,
                 String attributeName,
                 String sku,
                 String key2)
```
    Equivalent of the standard syntax "Pricelist" function. SKU is taken from parameter and not context.
    
    Parameters:
    
    listName - The name of the pricelist. Target date matching applies.
    
    attributeName - The name of the attribute to retrieve
    
    sku - The sku to use
    
    key2 - The key2 to use *
    
    Returns:
    
    The value of the attributeName column of the matrix pricelist record
  - pricelistItem
```
Object pricelistItem(String listName)
```
    Equivalent of the standard syntax "Pricelist" function - with the difference that the full item is returned.
    
    Parameters:
    
    listName - The name of the pricelist. Target date matching and sku context applies.
    
    Returns:
    
    The entire pricelist item record
  - pricelistItem
```
Object pricelistItem(String listName,
                     String sku)
```
    Equivalent of the standard syntax "Pricelist" function - with the difference that the full item is returned. SKU is taken from parameter and not context.
    
    Parameters:
    
    listName - The name of the pricelist. Target date matching applies.
    
    sku - The sku to use
    
    Returns:
    
    The entire pricelist item record
  - pricelistItem
```
Object pricelistItem(String listName,
                     String sku,
                     String key2)
```
    Equivalent of the standard syntax "Pricelist" function - with the difference that the full item is returned. SKU is taken from parameter and not context.
    
    Parameters:
    
    listName - The name of the pricelist. Target date matching applies.
    
    sku - The sku to use
    
    key2 - The key2 to use
    
    Returns:
    
    The entire matrix pricelist item record
  - getPricelistItem
```
Map<String,Object> getPricelistItem(String listName)
```
    Similar to the standard syntax "Pricelist" function. However it optimizes the subsequent processing by providing the results as map directly.
    
    Parameters:
    
    listName - The name of the pricelist. Target date and sku matching applies.
  - bom
```
Object bom()
```
    Equivalent of the standard syntax "BoM" function. It accesses and retrieves the values from the rolled-up bill of materials for the sku in the context. In this case all quantities are rolled up and summed.
    
    Returns:
    
    A list with the summed up quantities
  - bom
```
Object bom(String lookupTableName)
```
    Equivalent of the standard syntax "BoM" function. It accesses and retrieves the values from the rolled-up bill of materials for the sku in the context. In this case, the summed up quantities are multiplied with a factor that is retrieved by a look up by material name from the provided parameter. An example would be a material-cost table.
    
    Parameters:
    
    lookupTableName - The parameter table name
    
    Returns:
    
    A list with the summed up and multiplied quantities
  - bom
```
Object bom(String lookupTableName,
           String categoryName)
```
    Equivalent of the standard syntax "BoM" function. It accesses and retrieves the values from the rolled-up bill of materials for the sku in the context. Only BoM records with the specified category are considered. In this case, the summed up quantities are multiplied with a factor that is retrieved by a look up by material name from the provided parameter. An example would be a material-cost table.
    
    Parameters:
    
    lookupTableName - The parameter table name
    
    categoryName - The category name to filter on
    
    Returns:
    
    A list with the summed up and multiplied quantities
  - bom
```
Object bom(String lookupTableName,
           String categoryName,
           String materialName)
```
    Equivalent of the standard syntax "BoM" function. It accesses and retrieves the values from the rolled-up bill of materials for the sku in the context. Only BoM records with the specified category and the material are considered. In this case, the summed up quantities are multiplied with a factor that is retrieved by a look up by material name from the provided parameter. An example would be a material-cost table.
    
    Parameters:
    
    lookupTableName - The parameter table name
    
    categoryName - The categroy name to filter on
    
    materialName - The material to filter on
    
    Returns:
    
    A list with the summed up and multiplied quantities
  - bomList
```
Object bomList()
```
    Equivalent of the standard syntax "BoMList" function. It rolls up the current sku's BoM and returns the rolled up BoM records (not just the quantities).
    
    Returns:
    
    A list of BoM records
  - user
```
Object user(String attributeName)
```
    Returns a value from the current user's master data.
    
    Parameters:
    
    attributeName - The attribute to return
    
    Returns:
    
    The attribute value
  - user
```
Object user()
```
    Returns the entire master data object of the current user.
    
    Returns:
    
    The user object
  - input
```
Object input(String inputName)
```
    Retrieves an input parameter - without triggering a user input.
    
    Parameters:
    
    inputName - The parameter name
    
    Returns:
    
    The parameter value
  - inputMatrix
```
Object inputMatrix(String inputMatrixName,
                   String... columnNames)
```
    Equivalent of the standard "InputMatrix" function. Generates a grid-style input widget with the specified columns. The result will be a list (=the rows) of maps (=the row's columns). The map attribute names are the column names. Make sure the column names are valid JSON identifiers. I.e., spaces are ok but special chars rather not.
    
    Parameters:
    
    inputMatrixName - The name of the parameter
    
    columnNames - The column names/labels
    
    Returns:
    
    A list (=the rows) of maps (=the row's columns)
  - inputMatrix
```
Object inputMatrix(String inputMatrixName,
                   Map<String,Object> paramConfig,
                   String... columns)
```
    Equivalent of the standard "InputMatrix" function. Generates a grid-style input widget with the specified columns. The result will be a list (=the rows) of maps (=the row's columns). The map attribute names are the column names. Make sure the column names are valid JSON identifiers. I.e., spaces are ok but special chars rather not.
    Parameters:
    
    inputMatrixName - The name of the parameter
    paramConfig - Map of configuration settings, with the following options (key,value):
    
    'canModifyRows': false/true (user can add and delete row)
    
    'readOnlyColumns': List of columns (names) to be uneditable
    
    'noCellRefresh': false/true (do not update Configurator on each edit)
    columnNames - The column names/labels
    
    Returns:
    
    A list (=the rows) of maps (=the row's columns)
  - filter
```
Object filter(String property,
              Object value)
```
    Creates a filter object that can be used in other API functions. Operator is always "equals", i.e., property = value.
    Example:
    def cas = api.find("CA",api.filter("assignmentId",mplId),api.filter("assignmentType","MPL"))
    Parameters:
    
    property - The property's name to filter on
    
    value - The specified value
    
    Returns:
    
    A filter object
  - filterFromMap
```
Filter filterFromMap(Map<String,Object> filterMap)
```
    Constructs a Filter object from the 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.
    
    Parameters:
    
    filterMap - The filter in form of nested maps
  - filter
```
Object filter(String property,
              Object opString,
              Object value)
```
    Creates a filter object that can be used in other API functions.
    Note: This method is sort of dynamic. Dynamic in a sense that if the opString does not actually represent a valid operator (e.g. "="), the passed value will then be treated as lower bound, and the value as upper bound. In other words, the resulting filter will look like this: Filter.and(Filter.greaterOrEqual(property, opString), Filter.lessThan(property, value)). If either parameter is null, its part is skipped.
    Example:
    datamartQuery.where(api.filter("PricingDate",">",targetDate.minus(365).format("yyyy-MM-dd")))
    Parameters:
    
    property - The property's name to filter on
    
    opString - One out of : "=", "<", "<=", ">", ">=", "<>", "~". If different, it gets treated as lower-bound value, then. Please see the remark.
    
    value - The specified value (or an upper bound)
    
    Returns:
    
    A filter object
  - customerToRelatedObjectsFilter
```
Filter customerToRelatedObjectsFilter(String relatedObjectTypeCode,
                                      String customerId)
```
    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. Example: def filter = api.customerToRelatedObjectsFilter("RBA", "104083") // customerId=104083 def rbas = api.find("RBA", 0,0, null, filter) api.trace("rbas for customer #104083", null, rbas)
    
    Parameters:
    
    relatedObjectTypeCode - TypeCode of the related object type. Possible values are
    'PR': PriceRecord
    
    'CT': Contract
    
    'CTLI': ConttractLineItem
    
    'RBA': RebateAgreement
    
    'RBALI': RebateAgreementLineItem
    
    customerId - Customer.id to filter on.
    
    Returns:
    
    A filter object
  - relatedObjectToCustomersFilter
```
Filter relatedObjectToCustomersFilter(String relatedObjectTypedId)
```
    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. def filter = api.relatedObjectToCustomersFilter("42.RBA") // rba.id=24 def customers = api.find("C", 0,0, null, filter) api.trace("customers for rba #24", null, customers)
    
    Parameters:
    
    relatedObjectTypedId - TypedId of the related object. Its type needs to be one of:
    'PR': PriceRecord
    
    'CT': Contract
    
    'CTLI': ConttractLineItem
    
    'RBA': RebateAgreement
    
    'RBALI': RebateAgreementLineItem
    
    Returns:
    
    A filter object
  - productToRelatedObjectsFilter
```
Filter productToRelatedObjectsFilter(String relatedObjectTypeCode,
                                     String sku)
```
    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.
    
    Parameters:
    
    relatedObjectTypeCode - TypeCode of the related object type. Possible values are:
    'PR': PriceRecord
    
    'CT': Contract
    
    'CTLI': ConttractLineItem
    
    'RBA': RebateAgreement
    
    'RBALI': RebateAgreementLineItem
    
    productId - Product.id to filter on.
    
    Returns:
    
    A filter object
  - relatedObjectToProductsFilter
```
Filter relatedObjectToProductsFilter(String relatedObjerelatedObjectTypedId)
```
    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.
    
    Parameters:
    
    relatedObjectTypedId - TypedId of the related object. Its type needs to be one of:
    'PR': PriceRecord
    
    'CT': Contract
    
    'CTLI': ConttractLineItem
    
    'RBA': RebateAgreement
    
    'RBALI': RebateAgreementLineItem
    
    Returns:
    
    A filter object
  - isUserInGroup
```
boolean isUserInGroup(String userGroupName,
                      String loginUserName)
```
    Checks if the current user is member of the given user group.
    
    Parameters:
    
    userGroupName - The group name
    
    loginUserName - The login name of the user
    
    Returns:
    
    true or false
  - trace
```
void trace(String functionName,
           String parameters,
           Object result)
```
    Generates a trace message that can be used in the formula test drive. During regular formula execution trace messages are ignored. The parameters specify the output of the trace.
    
    Parameters:
    
    functionName - A free to choose function name
    
    parameters - Parameters to trace
    
    result - The result of the trace
  - getParameter
```
ContextParameter getParameter(String parameterName)
```
    Retrieves an already generated (i.e. in a previous formula step) input parameter in the form of a ContextParameter object. This can then be further modified as required.
    
    Parameters:
    
    parameterName - The named parameter to retrieve
    
    Returns:
    
    The parameter or null
  - currentContext
```
Map<String,Object> currentContext(String sku)
```
    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. The result record of the same list with the provided sku is searched and returned. Note: If used within a context that has a secondary key, only the first object is returned!
    
    Parameters:
    
    sku - The sku to look for
    
    Returns:
    
    The result record (entire record)
  - currentContext
```
Map<String,Object> currentContext(String sku,
                                  String key2)
```
    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. The result record of the same list with the provided sku is searched and returned.
    
    Parameters:
    
    sku - The sku to look for
    
    key2 - The key2 to look for
    
    Returns:
    
    The result record (entire record)
  - previousContext
```
Map<String,Object> previousContext(String sku)
```
    In case of (chained) price lists, this method allows for easy retrieval of records from the previous list. Note: If used within a context that has a secondary key, only the first object is returned!
    
    Parameters:
    
    sku - The sku to look for
    
    Returns:
    
    The result record (entire record)
  - previousContext
```
Map<String,Object> previousContext(String sku,
                                   String key2)
```
    In case of (chained) price lists, this method allows for easy retrieval of records from the previous list.
    
    Parameters:
    
    sku - The sku to look for
    
    key2 - The key2 to look for
    
    Returns:
    
    The result record (entire record)
  - contextName
```
String contextName()
```
    The name of the current context. E.g., price list name, quote name, etc.
    
    Returns:
    
    The name
  - contextType
```
String contextType()
```
    The type (type code string) of the current context.
  - contextTypedId
```
String contextTypedId()
```
    The typedId of the current context
  - getProperty
```
Object getProperty(Object object,
                   String path)
```
    This method serves as an optimized way to get to certain object attributes. The sandbox automatically converts "real" server objects into a map representation at the time the object is accessed. This is for safety (sandboxing) reasons. This process obviously converts all object attributes. If only one specific attribute is of interest, this method shortcuts that as the underlying object is not exposed (and thus does not force the sandbox into conversion).
    
    Parameters:
    
    object - The object whose value to retrieve
    
    path - The attribute name
    
    Returns:
    
    The value of the attribute
  - getPropertyByElementName
```
Object getPropertyByElementName(Object object,
                                String elementName)
```
    This method gets object attributes by elementName. It works only for objects that have meta attributes which contain the element name. These are e.g.: PLI, SIMI, PGI, MPLI
    
    Parameters:
    
    object - The object whose value to retrieve
    
    elementName - The elementName value
    
    Returns:
    
    The value of the attribute or null if invalid object or no matching meta found
  - currentItem
```
Object currentItem()
```
    In case of a list processing operation this method gets the currently worked on record (e.g., price list item or price grid item or quote item).
    
    Returns:
    
    The item object as Map
  - currentItemByElementName
```
Object currentItemByElementName(String elementName)
```
    In case of a list processing operation, this method gets the currently worked on record's property by elementName.
    Example:
    def currentItem = api.currentItem() def currentSku = currentItem != null ? currentItem.attribute20 : api.product("attribute20")
    Parameters:
    
    elementName -
    
    Returns:
    
    The item's property value
  - currentItem
```
Object currentItem(String attributeName)
```
    Same as currentItem() but returns only the specified attribute.
    
    Parameters:
    
    attributeName - The attribute to retrieve
    
    Returns:
    
    The value of the attribute
  - contextSkuSet
```
Set<Object> contextSkuSet(int startRow)
```
    Returns a set of skus which comprise so-called 'sku context' of the current formula execution.
    The form of the sku context differs, e.g., in case of product detail formula executed via price grid details, the resulting set will contain all skus of the left-pane's grid.
    Note: If sku context isn't supported by the current formula execution, null is returned.
    Note #2: A maximum of 200 skus is returned per one call. If there are more of them, startRow must be used to get all skus in the set.
    
    Parameters:
    
    startRow - The starting row of the result set
    
    Returns:
    
    a set of skus or null if sku context isn't available for the current formula execution
  - getMaxFindResultsLimit
```
int getMaxFindResultsLimit()
```
    The find(String, Filter...) method and its variations are limitied in how many results are returned in one call. Some method signatures can specify a maxResults parameter, but there is a system-defined absolute maximum. This call returns the currently system-defined absolute maximum value.
    
    Returns:
    
    The currently system-defined absolute maximum number of returned rows by api.find
  - find
```
List<Object> find(String typeCode,
                  Filter... filters)
```
    The Swiss army knife method of the API. With this method you can search for all types of objects with a freestyle query. The filters are AND'ed together. A maximum of 200 items is returned.
    
    Parameters:
    
    typeCode - A type code string of the type of the object to search for. All available type codes can be retrieved by calling <hostname>/pricefx/<partition name>/fetch
    
    filters - a list of filter objects that are AND'ed together
    
    Returns:
    
    The result list
  - find
```
List<Object> find(String typeCode,
                  int startRow,
                  Filter... filters)
```
    The Swiss army knife method of the API. With this method you can search for all types of objects with a freestyle query. The filters are AND'ed together. A maximum of 200 items is returned. The start row parameter can be used to page through more than 200 results.
    
    Parameters:
    
    typeCode - A type code string of the type of the object to search for. All available type codes can be retrieved by calling <hostname>/pricefx/<partition name>/fetch
    
    filters - A list of filter(java.lang.String, java.lang.Object) objects that are AND'ed together
    
    startRow - The starting row of the result set
    
    Returns:
    
    The result list
  - find
```
List<Object> find(String typeCode,
                  int startRow,
                  String sortBy,
                  Filter... filters)
```
    The Swiss army knife method of the API. With this method you can search for all types of objects with a freestyle query. The filters are AND'ed together. A maximum of 200 items is returned. The start row parameter can be used to page through more than 200 results.
    
    Parameters:
    
    typeCode - A type code string of the type of the object to search for. All available type codes can be retrieved by calling <hostname>/pricefx/<partition name>/fetch
    
    filters - A list of filter objects that are AND'ed together
    
    startRow - The starting row of the result set
    
    sortBy - Sort the results by an attribute. Prefix with - for descending sort order. Can be comma separated list of sort fields
    
    Returns:
    
    The result list
  - find
```
List<Object> find(String typeCode,
                  int startRow,
                  int maxRows,
                  String sortBy,
                  Filter... filters)
```
    The Swiss army knife method of the API. With this method you can search for all types of objects with a freestyle query. The filters are AND'ed together. The maximum number of rows retreived is determined by the formulaEngine.script.findMaxResults parameter. The maxRows parameter can only set lower values.
    Example:
    def StockPX = api.find("PX", 0, "-attribute2", Filter.equal("name", "DWHStockReport"), Filter.equal("attribute1", "OFF"), Filter.equal("sku", api.product("sku")), Filter.greaterOrEqual("attribute2", date))
    Parameters:
    
    typeCode - A type code string of the type of the object to search for. All available type codes can be retrieved by calling <hostname>/pricefx/<partition name>/fetch
    
    filters - A list of filter objects that are AND'ed together
    
    startRow - The starting row of the result set
    
    maxRows - The maximum number of rows to retreive. If set to 0 it will default to 200
    
    sortBy - Sort the results by an attribute. Prefix with - for descending sort order. Can be comma separated list of sort fields
    
    Returns:
    
    The result list
  - find
```
List<Object> find(String typeCode,
                  int startRow,
                  int maxRows,
                  String sortBy,
                  List<String> fields,
                  Filter... filters)
```
    The Swiss army knife method of the API. With this method you can search for all types of objects with a freestyle query. The filters are AND'ed together. The maximum number of rows retreived is determined by the formulaEngine.script.findMaxResults parameter. The maxRows parameter can only set lower values than that.
    
    Parameters:
    
    typeCode - A type code string of the type of the object to search for. All available type codes can be retrieved by calling <hostname>/pricefx/<partition name>/fetch
    
    filters - A list of filter objects that are AND'ed together
    
    startRow - The starting row of the result set
    
    maxRows - The maximum number of rows to retreive. If set to 0 it will default to 200
    
    sortBy - Sort the results by an attribute. Prefix with - for descending sort order. Can be comma separated list of sort fields
    
    fields - A list of fields. If null the entire object will be returned
    
    Returns:
    
    The result list
  - find
```
List<Object> find(String typeCode,
                  int startRow,
                  int maxRows,
                  String sortBy,
                  List<String> fields,
                  boolean distinctValuesOnly,
                  Filter... filters)
```
    The Swiss army knife method of the API. With this method you can search for all types of objects with a freestyle query. The filters are AND'ed together. The maximum number of rows retreived is determined by the formulaEngine.script.findMaxResults parameter. The maxRows parameter can only set lower values than that.
    
    Parameters:
    
    typeCode - A type code string of the type of the object to search for. All available type codes can be retrieved by calling <hostname>/pricefx/<partition name>/fetch
    
    filters - A list of filter objects that are AND'ed together
    
    startRow - The starting row of the result set
    
    maxRows - The maximum number of rows to retreive. If set to 0 it will default to 200
    
    sortBy - Sort the results by an attribute. Prefix with - for descending sort order. Can be comma separated list of sort fields
    
    fields - A list of fields. If null the entire object will be returned
    
    distinctValuesOnly - fetches distinct/all values, use case is fetching distinct single column values
    
    Returns:
    
    The result list
  - find
```
List<Object> find(String typeCode,
                  int startRow,
                  int maxRows,
                  String sortBy,
                  Map<String,String> fields,
                  boolean distinctValuesOnly,
                  Filter... filters)
```
    The Swiss army knife method of the API. With this method you can search for all types of objects with a freestyle query. The filters are AND'ed together. The maximum number of rows retreived is determined by the formulaEngine.script.findMaxResults parameter. The maxRows parameter can only set lower values than that.
    
    Parameters:
    
    typeCode - A type code string of the type of the object to search for. All available type codes can be retrieved by calling <hostname>/pricefx/<partition name>/fetch
    
    filters - A list of filter objects that are AND'ed together
    
    startRow - The starting row of the result set
    
    maxRows - The maximum number of rows to retreive. If set to 0 it will default to 200
    
    sortBy - Sort the results by an attribute. Prefix with - for descending sort order. Can be comma separated list of sort fields
    
    fields - A map of attributes we only want to return in the result, i.e. skip all attributes not contained in the list the search would return otherwise. The key of the map is the field name. The value can be a field operator like SUM, AVG, MIN or MAX
    
    distinctValuesOnly - fetches distinct/all values, use case is fetching distinct single column values
    
    Returns:
    
    The result list
  - stream
```
AbstractProducer.ResultIterator stream(String typeCode,
                                       String sortBy,
                                       Filter... filters)
                                throws Exception
```
    Search for all types of objects with a freestyle query, and iterate over the result set. The filters are AND'ed together.
    
    Parameters:
    
    typeCode - A type code string of the type of the object to search for. All available type codes can be retrieved by calling /pricefx//fetch
    
    sortBy - Sort the results by an attribute. Prefix with - for descending sort order. Can be comma separated list of sort fields
    
    filters - A list of filter objects that are AND'ed together
    
    Returns:
    
    The result implements the Iterator interface, allowing for iteration over all records in scope of the query. Sample groovy code: def results = api.stream("PCOMP", "id") def n=0 while(results.hasNext()){ api.logInfo("result $n", results.next()) n++ }
    
    Throws:
    
    Exception
  - stream
```
AbstractProducer.ResultIterator stream(String typeCode,
                                       String sortBy,
                                       List<String> fields,
                                       Filter... filters)
                                throws Exception
```
    Search for all types of objects with a freestyle query, and iterate over the result set. The filters are AND'ed together.
    
    Parameters:
    
    typeCode - A type code string of the type of the object to search for. All available type codes can be retrieved by calling /pricefx//fetch
    
    sortBy - Sort the results by an attribute. Prefix with - for descending sort order. Can be comma separated list of sort fields
    
    fields - A list of attributes we only want to return in the result, i.e. skip all attributes not contained in the list the search would return otherwise
    
    filters - A list of filter objects that are AND'ed together
    
    Returns:
    
    The result implements the Iterator interface, allowing for iteration over all records in scope of the query.
    
    Throws:
    
    Exception
  - stream
```
AbstractProducer.ResultIterator stream(String typeCode,
                                       String sortBy,
                                       List<String> fields,
                                       boolean distinctValuesOnly,
                                       Filter... filters)
                                throws Exception
```
    Search for all types of objects with a freestyle query, and iterate over the result set. The filters are AND'ed together.
    
    Parameters:
    
    typeCode - A type code string of the type of the object to search for. All available type codes can be retrieved by calling /pricefx//fetch
    
    sortBy - Sort the results by an attribute. Prefix with - for descending sort order. Can be comma separated list of sort fields
    
    fields - A list of attributes we only want to return in the result, i.e. skip all attributes not contained in the list the search would return otherwise
    
    distinctValuesOnly - fetches distinct/all values, use case is fetching distinct single column values
    
    filters - A list of filter objects that are AND'ed together
    
    Returns:
    
    The result implements the Iterator interface, allowing for iteration over all records in scope of the query.
    
    Throws:
    
    Exception
  - stream
```
AbstractProducer.ResultIterator stream(String typeCode,
                                       String sortBy,
                                       Map<String,String> fields,
                                       boolean distinctValuesOnly,
                                       Filter... filters)
                                throws Exception
```
    Search for all types of objects with a freestyle query, and iterate over the result set. The filters are AND'ed together.
    
    Parameters:
    
    typeCode - A type code string of the type of the object to search for. All available type codes can be retrieved by calling /pricefx//fetch
    
    sortBy - Sort the results by an attribute. Prefix with - for descending sort order. Can be comma separated list of sort fields
    
    fields - A map of attributes we only want to return in the result, i.e. skip all attributes not contained in the list the search would return otherwise. The key of the map is the field name. The value can be a field operator like SUM, AVG, MIN or MAX
    
    distinctValuesOnly - fetches distinct/all values, use case is fetching distinct single column values
    
    filters - A list of filter objects that are AND'ed together
    
    Returns:
    
    The result implements the Iterator interface, allowing for iteration over all records in scope of the query.
    
    Throws:
    
    Exception
  - emit
```
boolean emit(Object obj)
      throws InterruptedException
```
    Emits an object to be consumed by an external thread. Requires a blocking emitQueue to be set in the FormulaEngineContext, and a consuming thread to take emitted objects from the queue. See also FeederFormulaExecutor.
    
    Parameters:
    
    obj - The object to be emitted/inserted in the emit queue
    
    Returns:
    
    True if the object is successfully inserted in the queue, false otherwise.
    
    Throws:
    
    InterruptedException
  - emitRebateRecords
```
void emitRebateRecords(String dateFieldName,
                       String sortBy,
                       Filter... filters)
                throws InterruptedException
```
    Emits the rebate records matching the given search criteria, to be consumed by a PA allocation task (a PA calculation task with a feeder formula calling this method, and a regular formula accepting each emitted RebateRecord as its currentItem context, and distributing one or more RebateRecord accruals over the set of PA rows which have contributed to those accruals in some way (by revenue, bvolume...).
    
    Parameters:
    
    dateFieldName - The name of the field to be substitued in the RebateRecord's calculationBase (a DMDataSlice object that includes a generic time dimension filter)
    
    sortBy - The RebateRecord field on which to sort
    
    filters - The filters to apply to the RebateRecord search
    
    Throws:
    
    InterruptedException
  - emitPersistedObject
```
boolean emitPersistedObject(String typedId)
                     throws InterruptedException
```
    Finds the PersistedObject with the given typedId, and emits it if it exists. The assumption is that there is a receiving consumer, as in emitRebateRecords.
    
    Parameters:
    
    typedId - The typedId of the PersistedObject to emit
    
    Throws:
    
    InterruptedException
  - emitPersistedObject
```
boolean emitPersistedObject(String typeCode,
                            Long id)
                     throws InterruptedException
```
    Finds the PersistedObject for the given typeCode and id, and emits it if it exists. The assumption is that there is a receiving consumer, as in emitRebateRecords.
    
    Parameters:
    
    typeCode - The typeCode of the PersistedObject to emit
    
    id - The id of the PersistedObject to emit
    
    Throws:
    
    InterruptedException
  - count
```
int count(String typeCode,
          Filter... filters)
```
    Similar to the find(java.lang.String, com.googlecode.genericdao.search.Filter...) methods, this method queries an arbitrary object type. It does not return the objects itself but the count.
    
    Parameters:
    
    typeCode - A type code string of the type of the object to search for. All available type codes can be retrieved by calling <hostname>/pricefx/<partition name>/fetch
    
    filters - A list of filter(java.lang.String, java.lang.Object) objects that are AND'ed together
    
    Returns:
    
    The number of matching records
  - findLookupTable
```
LookupTable findLookupTable(String tableName)
```
    Finds a lookup table / price parameter table based on the table name. It does apply target date and simulation set matching.
    
    Parameters:
    
    tableName - The name of the lookup table
    
    Returns:
    
    The lookup table or null
  - findLookupTableValues
```
List<Object> findLookupTableValues(String tableName,
                                   Filter... filters)
```
    Searches and returns values of a named lookup table. The returned list can optionally be further filtered.
    
    Parameters:
    
    tableName - The name of the lookup table
    
    filters - Optional extra filter(java.lang.String, java.lang.Object)
    
    Returns:
    
    The lookup table values or null
  - findWorkflowInfo
```
WorkflowInfo findWorkflowInfo(String approvableTypeCode,
                              Object approvableId)
```
    Finds active workflows for the given approvable. You can get the same information that is displayed in the workflow UI.
    
    Parameters:
    
    approvableTypeCode - type code of approvable. Approvables are for instances quotes, rebate agreements, data change requests etc.
    
    approvableId - id of the approvable
    
    Returns:
    
    Table like structure resembling workflow UI or null if not found
  - findPreviousApprovableState
```
Map<String,Object> findPreviousApprovableState(String typedId,
                                               String... workflowStatuses)
```
    Finds previous approvable entity state in case some 'DENIED' or 'WITHDRAWN' workflow for the approvable exists
    
    Parameters:
    
    typedId - Approvable entity typed id
    
    workflowStatuses - Only 'DENIED' or 'WITHDRAWN' are supported
    
    Returns:
    
    State of the approvable entity when it's previous workflow was DENIED or WITHDRAWN
  - findPreviousWorkflowInfo
```
WorkflowInfo findPreviousWorkflowInfo(String typedId,
                                      String... workflowStatuses)
```
    Finds approvable entity previous workflow history in case some 'DENIED' or 'WITHDRAWN' workflow for the approvable exists
    
    Parameters:
    
    typedId - Approvable entity typed id
    
    workflowStatuses - Only 'DENIED' or 'WITHDRAWN' are supported
    
    Returns:
    
    Workflow history, see net.pricefx.workflowengine.WorkflowInfo
  - findCustomerAssignments
```
List<CustomerAssignment> findCustomerAssignments(String customerId)
```
    Finds all assignement records for the given customerId. Also matches by CustomerGroup definitions.
    
    Parameters:
    
    customerId - The customer to search an assignment for
    
    Returns:
    
    A list of assignment records
  - findPricelists
```
List<Pricelist> findPricelists(Date targetDate,
                               String listName)
```
    Returns a list of pricelists that match the targetDate (i.e., list's targetDate <= targetDate and expiryDate > targetDate).
    
    Parameters:
    
    targetDate - The targetDate to use
    
    listName - Filter on list name. If null the list name is not included in search
    
    Returns:
    
    The list of matching pricelists
  - findSimulations
```
List<Simulation> findSimulations(Date targetDate,
                                 String simulationName)
```
    Returns a list of simulations that match the targetDate (i.e., list's targetDate <= targetDate).
    
    Parameters:
    
    targetDate - The targetDate to use
    
    simulationName - Filter on simulation name. If null the simulation name is not included in search
    
    Returns:
    
    The list of matching simulations
  - findPriceGrids
```
List<PriceGrid> findPriceGrids(Date targetDate,
                               String priceGridName)
```
    Returns a list of price grids that match the targetDate (i.e., price grid's targetDate <= targetDate).
    
    Parameters:
    
    targetDate - The targetDate to use
    
    priceGridName - Filter on price grid name. If null the price grid name is not included in search
    
    Returns:
    
    The list of matching price grids
  - findCalculatedFieldSets
```
List<CalculatedFieldSet> findCalculatedFieldSets(Date targetDate,
                                                 String cfsName)
```
    Returns a list of calculated field sets that match the targetDate.
    
    Parameters:
    
    targetDate - Target date for the cfs
    
    cfsName - Filter on cfs name. If null the cfs name is not included in search
    
    Returns:
    
    The list of matching calculated field sets
  - findManualPricelists
```
List<ManualPricelist> findManualPricelists(Date targetDate,
                                           String listName)
```
    Returns a list of manual pricelists that match the targetDate (i.e., list's validAfter <= targetDate and expiryDate > targetDate).
    
    Parameters:
    
    targetDate - The targetDate to use
    
    listName - Filter on list name. If null the list name is not included in search
    
    Returns:
    
    The list of matching pricelists
  - findApprovedPricelistItems
```
List<SummaryCalculableObjectItem> findApprovedPricelistItems(String sku)
```
    Returns a list of summary items. One item is returned for every matching (=same sku) PLI or XPLI that is in an approved list.
    
    Parameters:
    
    sku - The sku to filter on
    
    Returns:
    
    A list of summary items
  - findCustomersInGroup
```
List<Customer> findCustomersInGroup(CustomerGroup group)
```
    Retrieves a list of customers that match the given CustomerGroup (returns first 200 entries).
    
    Parameters:
    
    group - The group to match
    
    Returns:
    
    A list of customers
  - findCustomersInGroup
```
List<Customer> findCustomersInGroup(CustomerGroup group,
                                    int startRow,
                                    String sortBy)
```
    Retrieves a list of customers that match the given CustomerGroup with custom paging and sorting.
    
    Parameters:
    
    group -
    
    startRow - The starting row number (only max 200 rows returned at once)
    
    sortBy - A sort key. null if no sorting is required
    
    Returns:
    
    A list of customers
  - getManualOverride
```
Object getManualOverride(String elementName)
```
    Returns a user entered value that overrides the calculated result of a formula element.
    Note that the manualOverride works as a flag - when it is set for an element, the final value of that element is taken from the manually entered value and the calculation of that element does not run at all. If this flag is not set, the final value is the calculated result.
    
    Parameters:
    
    elementName - The formula/result element that is overridden
    
    Returns:
    
    The overridden value or null if not overridden
  - removeManualOverride
```
void removeManualOverride(String elementName)
```
    Removes a user entered value that overrides the calculated result of a formula element.
    If you have a condition to remove the manual override, it is recommended to put this condition in a separate formula element which is always executed (not in the same one which has the manual override allowed; the reason is that once the user enters a value manually, the element calculation does run at all, so the condition would not be evaluated).
    
    Parameters:
    
    elementName - The formula/result element that is overridden
  - abortCalculation
```
void abortCalculation()
```
    Aborts the current item's calculation. Subsequent formula elements are not executed.
  - throwException
```
void throwException(String errorMessage)
             throws XExpression
```
    Throws a calculation exception with the specified message and aborts the calculation.
    
    Parameters:
    
    errorMessage - The error message that is displayed
    
    Throws:
    
    XExpression
  - markItemDirty
```
void markItemDirty(String sku)
            throws XExpression
```
    Marks the specfied item dirty. I.e., second calculation run will be triggered and this item is included in the 2nd pass. If used in a MatrixPricelist/MatrixSimulation (i.e., objects that have a secondary key), all items with that sku are marked as dirty.
    
    Parameters:
    
    sku - The item to mark dirty
    
    Throws:
    
    XExpression
  - markItemDirty
```
void markItemDirty(String sku,
                   String key2)
            throws XExpression
```
    Marks the specfied item dirty. I.e., second calculation run will be triggered and this item is included in the 2nd pass.
    
    Parameters:
    
    sku -
    
    key2 -
    
    Throws:
    
    XExpression
  - markItemDirty
```
void markItemDirty()
            throws XExpression
```
    Marks the current item dirty. I.e., second calculation run will be triggered and this item is included in the 2nd pass.
    
    Throws:
    
    XExpression
  - markItemClean
```
void markItemClean()
            throws XExpression
```
    Removes a "dirty marker" from the current item.
    
    Throws:
    
    XExpression
  - markItemClean
```
void markItemClean(String sku,
                   String key2)
```
    Marks the specfied item clean.
    
    Parameters:
    
    sku -
    
    key2 -
  - markItemClean
```
void markItemClean(String sku)
```
    Marks the specfied item clean.
    
    Parameters:
    
    sku -
  - isSecondPass
```
boolean isSecondPass()
              throws XExpression
```
    A method to determine if the calculation is in the 2nd pass calculation. It is useful for flow control. Note: This does not necessarily mean it is the second iteration (i.e., the first "dirty" iteration), but it is *a* dirty iteration. This is due to the standard default of only one possible dirty run.
    
    Returns:
    
    true if is in 2nd pass
    
    Throws:
    
    XExpression
  - getIterationNumber
```
int getIterationNumber()
                throws XExpression
```
    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
    
    Throws:
    
    XExpression
  - formatString
```
String formatString(String locale,
                    String format,
                    Object... args)
```
    Formats a string like String.format(java.lang.String, java.lang.Object...).
    
    Parameters:
    
    locale - The locale (as string)
    
    format - The format string
    
    args - The arguments to pass on
    
    Returns:
    
    The formatted string
  - formatNumber
```
String formatNumber(String pattern,
                    Object n)
```
    Formats a number into a string. Same semantics as NumberFormat and DecimalFormat.applyPattern(java.lang.String).
    
    Parameters:
    
    pattern - The pattern string
    
    n - The number to format
    
    Returns:
    
    The formatted number as string
  - formatNumber
```
String formatNumber(String locale,
                    String pattern,
                    Object n)
```
    Formats a number into a string. Same semantics as NumberFormat and DecimalFormat.applyPattern(java.lang.String).
    
    Parameters:
    
    pattern - The pattern string
    
    n - The number to format
    
    locale - The locae to use for formatting
    
    Returns:
    
    The formatted number as string
  - jsonDecode
```
Object jsonDecode(String json)
```
    A utility method to decode a JSON string into a Map representation.
    
    Parameters:
    
    json - The input JSON string
    
    Returns:
    
    The parsed JSON as Map
  - jsonDecodeList
```
Object jsonDecodeList(String json)
```
    A utility method to decode a JSON string into a List representation.
    
    Parameters:
    
    json - The input JSON string
    
    Returns:
    
    The parsed JSON as List
  - jsonEncode
```
Object jsonEncode(Object input)
```
    A utility method to encode Object to JSON string. Omitting all null values in output
    
    Parameters:
    
    input - The input object, usually map
    
    Returns:
    
    Encoded object
  - jsonEncode
```
Object jsonEncode(Object input,
                  boolean omitNull)
```
    A utility method to encode Object to JSON string.
    
    Parameters:
    
    input - The input object, usually map
    
    omitNull - Should null values be omitted?
    
    Returns:
    
    Encoded object
  - criticalAlert
```
void criticalAlert(String msg)
```
    Marks the current formula element with a critical alert and the given message.
    
    Parameters:
    
    msg - The alert message
  - redAlert
```
void redAlert(String msg)
```
    Marks the current formula element with a red alert and the given message.
    
    Parameters:
    
    msg - The alert message
  - yellowAlert
```
void yellowAlert(String msg)
```
    Marks the current formula element with a yellow alert and the given message.
    
    Parameters:
    
    msg - The alert message
  - buildFlexChart
```
ResultFlexChart buildFlexChart(Object definition)
```
    Calls buildFlexChart(null, definition)
  - buildFlexChart
```
ResultFlexChart buildFlexChart(String baseTemplateToUse,
                               Object definition)
```
    Creates a FlexChart from the passed definition by merging it with options defined within the baseTemplateToUse template.
    Although it may change in future releases, for now, a FlexChart is nothing else than a Highcharts chart. Therefore the passed definition (also applies to the baseTemplateToUse template) must denote Highcharts options - please consult Highcharts documentation for more details on this.
    Since Highcharts options are normally specified by a JavaScript object literal, the passed definition must be either a JSON string representing such object literal, or any object which can be mapped to such JSON representation. Therefore, typically the definiton will be passed as a map 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)
    Please note that not all Highcharts options are supported! Moreover, usage of some options is prohibited deliberately. These are currently global, events and every JavaScript function-based options.
    
    Note: FlexChart templates are defined by administrator in the 'Configuration' section.
    Parameters:
    
    baseTemplateToUse - the name of the template to use as a basis for merging with the passed definition; if null, the predefined Default template gets used
    
    definition - the definition of the FlexChart; currently, this will typically be a string or map of maps containing Highcharts options
    
    Returns:
    
    a helper object linking the resulting FlexChart, baseTemplateToUse and type of the result - which will always be 'FLEXCHART', here
    
    See Also:
    
    http://api.highcharts.com/highcharts, http://www.highcharts.com/docs, http://json.org
  - buildHighchart
```
ResultHighchart buildHighchart(Map<String,?> definition)
```
    BETA
    Creates a ResultHighchart from the passed definition.
    As opposed to FlexChart, the definition is passed straight to the Highcharts library, currently release 6.1. There is no validation, no templates merging, and JavaScript functions are not supported.
    
    Parameters:
    
    definition - the definition of the Highchart as a map of maps and arrays
    
    See Also:
    
    https://www.highcharts.com/docs, https://api.highcharts.com/highcharts
  - buildHighmap
```
ResultHighmap buildHighmap(Map<String,?> definition)
```
    BETA
    Creates a ResultHighmap from the passed definition.
    As opposed to FlexChart, the definition is passed straight to the Highmaps library, currently release 6.1. There is no validation, no templates merging, and JavaScript functions are not supported.
    
    Parameters:
    
    definition - the definition of the Highmap as a map of maps and arrays
    
    See Also:
    
    https://www.highcharts.com/docs, https://api.highcharts.com/highmaps
  - newAdaptiveHistogram
```
AdaptiveHistogram newAdaptiveHistogram()
```
    Creates a histogram that adapts to an unknown data distribution. It keeps a more or less constant resolution throughout the data range by increasing the resolution where the data is more dense. For example, if the data has such such a distribution that most of the values lie in the 0-5 range and only a few are in the 5-10 range, the histogram would adapt and assign more counting buckets to the 0-5 range and less to the 5-10 range. The histogram provides a method to obtain the accumulative density function ( for a given data point (getValueForPercentile), and a method to obtain the data point that splits the data set at a given percentile (getValueForPercentile).
    
    Returns:
    
    A new AdaptiveHistogram object
  - getPricelistSummaryQuery
```
ItemSummaryQuery<Pricelist> getPricelistSummaryQuery()
```
    Creates a summary query object that can be parameterized and is then subsequently used in runSummaryQuery(ItemSummaryQuery). This query runs against pricelist(s).
    
    Returns:
    
    The query definition object
  - getSimulationSummaryQuery
```
ItemSummaryQuery<Simulation> getSimulationSummaryQuery()
```
    Creates a summary query object that can be parameterized and is then subsequently used in runSummaryQuery(ItemSummaryQuery). This query runs against simulation(s).
    
    Returns:
    
    The query definition object
  - getPriceGridSummaryQuery
```
ItemSummaryQuery<PriceGrid> getPriceGridSummaryQuery()
```
    Creates a summary query object that can be parameterized and is then subsequently used in runSummaryQuery(ItemSummaryQuery). This query runs against price grid(s).
    
    Returns:
    
    The query definition object
  - getRebateRecordSummaryQuery
```
ItemSummaryQuery<RebateRecordSet> getRebateRecordSummaryQuery()
```
    Creates a summary query object that can be parameterized and is then subsequently used in runSummaryQuery(ItemSummaryQuery). This query runs against rebate records.
    
    Returns:
    
    The query definition object
  - runSummaryQuery
```
List<Map<String,Object>> runSummaryQuery(ItemSummaryQuery<? extends CalculableObject> query)
```
    Runs (executes) a summary query defined by the parameterized query object, which was created by one of the getXXXSummaryQuery calls.
    
    Parameters:
    
    query - The query to execute
    
    Returns:
    
    The result set of the query
  - createConfiguratorEntry
```
ConfiguratorEntry createConfiguratorEntry(InputType type,
                                          String name)
```
    Creates a cofigurator entry object and adds the specified input parameter as the first parameter to the configurator entry. If the parameter had a value in the previous round trip, that value is set automatically.
    
    Parameters:
    
    type - Input type of the parameter. Valid enum values are: PRODUCT, PRODUCTGROUP, CUSTOMER, CUSTOMERGROUP, USERENTRY, STRINGUSERENTRY, OPTION, INTEGERUSERENTRY, BOOLEANUSERENTRY, DATEUSERENTRY, TIMEUSERENTRY, DATETIMEUSERENTRY, MULTITIERENTRY, INPUTMATRIX, OPTIONS, MATRIXLOOKUP, LOOKUP, FILTERBUILDER, DMFILTERBUILDER, DMFIELD, DMDIMFILTER, CONFIGURATOR, HIDDEN
    
    name - name of the parameter
    
    Returns:
    
    The configurator entry with the input parameter added
  - createConfiguratorEntry
```
ConfiguratorEntry createConfiguratorEntry(InputType type,
                                          String name,
                                          Date targetDate)
```
    Creates a cofigurator entry object and adds the specified input parameter as the first parameter to the configurator entry. If the parameter had a value in the previous round trip, that value is set automatically.
    
    Parameters:
    
    type - Input type of the parameter. Valid enum values are: PRODUCT, PRODUCTGROUP, CUSTOMER, CUSTOMERGROUP, USERENTRY, STRINGUSERENTRY, OPTION, INTEGERUSERENTRY, BOOLEANUSERENTRY, DATEUSERENTRY, TIMEUSERENTRY, DATETIMEUSERENTRY, MULTITIERENTRY, INPUTMATRIX, OPTIONS, MATRIXLOOKUP, LOOKUP, FILTERBUILDER, DMFILTERBUILDER, DMFIELD, DMDIMFILTER, CONFIGURATOR, HIDDEN
    
    name - name of the parameter
    
    targetDate - Target date for the input parameter (not applicable to all input types)
    
    Returns:
    
    The configurator entry with the input parameter added
  - createConfiguratorEntry
```
ConfiguratorEntry createConfiguratorEntry()
```
    Creates an empty configurator entry object. Must be filled with input parameters by calling createParameter on the object.
    
    Returns:
    
    The configurator entry
  - createConfiguratorEntryArray
```
ConfiguratorEntryArray createConfiguratorEntryArray(Object... entries)
```
    Creates configurator entry array object which is to be returned from formula element. Allows dynamic setup of configurator entries.
    
    Parameters:
    
    entries - 0..N configurator entries. Supports also list nesting
    
    Returns:
    
    The configurator entry array object with defined methods for further anrichment of array as ConfiguratorEntryArray#addEntry(ConfiguratorEntry), ConfiguratorEntryArray#setEntries(List) or ConfiguratorEntryArray#getEntries()
  - configurator
```
Object configurator(String configuratorName,
                    String formulaName)
```
    Equivalent of the standard syntax "Configurator" function.
    
    Parameters:
    
    configuratorName - The name of the configurator. Similar to other options' names
    
    formulaName - The name of the configurator's formula which is used to drive the input selections
    
    Returns:
    
    The result of the configurator
  - configurator
```
Object configurator(String configuratorName,
                    String formulaName,
                    Object resultName)
```
    Equivalent of the standard syntax "Configurator" function.
    
    Parameters:
    
    configuratorName - The name of the configurator. Similar to other options' names
    
    formulaName - The name of the configurator's formula which is used to drive the input selections
    
    resultName - The result that should be returned (instead of the full configurator results map)
    
    Returns:
    
    The result of the configurator
  - configurator
```
Object configurator(String configuratorName,
                    String formulaName,
                    Object width,
                    Object height)
```
    Equivalent of the standard syntax "Configurator" function.
    
    Parameters:
    
    configuratorName - The name of the configurator. Similar to other options' names
    
    formulaName - The name of the configurator's formula which is used to drive the input selections
    
    width - The width of the configurator window. Can be a number (in pixels) or a percentage string.
    
    height - The height of the configurator window. Can be a number (in pixels) or a percentage string.
    
    Returns:
    
    The result of the configurator
  - inlineConfigurator
```
Object inlineConfigurator(String configuratorName,
                          String formulaName)
```
    Equivalent of the standard syntax' "InlineConfigurator" function.
    
    Parameters:
    
    configuratorName - The name of the configurator. Similar to other options' names
    
    formulaName - The name of the configurator's formula which is used to drive the input selections
    
    Returns:
    
    The result of the configurator
  - parseDate
```
Date parseDate(String pattern,
               String date)
```
    Parses a date (entered in as string) according to the given pattern.
    Hint: For parsing datetimes (i.e., dates also including information about the time of day), use the parseDateTime(String, String) method instead.
    
    Parameters:
    
    pattern - pattern for parsing (see DateTimeFormat for pattern format specification)
    
    date - date as string in format specified by the pattern
    
    Returns:
    
    date
  - parseDateTime
```
DateTime parseDateTime(String pattern,
                       String datetime)
```
    Parses a datetime (entered in as string) according to the given pattern.
    Important note: This method will use the UTC time zone for parsing (unless the provided pattern usees a syntax explicitly specifying a time zone). If a different time zone is required, please use the parseDateTime(String, String, int, int) method which allows to set a time zone by providing an offset to UTC in hours and minutes.
    
    Parameters:
    
    pattern - pattern for parsing (see DateTimeFormat for pattern format specification)
    
    datetime - datetime as string in format specified by the pattern
    
    Returns:
    
    datetime
  - parseDateTime
```
DateTime parseDateTime(String pattern,
                       String datetime,
                       int tzHoursOffset,
                       int tzMinutesOffset)
```
    Parses a datetime (entered in as string) according to a given pattern and time zone.
    Important note: This method will always use the provided time zone, regardless of the possible time zone set explicitly in datetime.
    
    Parameters:
    
    pattern - pattern for parsing (see DateTimeFormat for pattern format specification)
    
    datetime - datetime as string in format specified by the pattern
    
    tzHoursOffset - the offset in hours from UTC, from -23 to +23
    
    tzMinutesOffset - the offset in minutes from UTC, from -59 to +59
    
    Returns:
    
    datetime
  - createElementNameFilter
```
Filter createElementNameFilter(String elementName,
                               Object fieldValue,
                               String... listTypedIds)
```
    Creates a cross-list filter expression based on meta data. Example: You'd like to filter accross multiple pricelists on items that have in the column with the elementName "XYZ" the value of "A". Now the elementName XYZ might have been mapped to a different attributeXX column for every list. So a simple attributeXX=A filter does not work. This method does a metadata lookup and creates a proper filter clause based on it for every list. For every list this translates into approx: (attributeXX = A AND listId = ) These filters are OR'ed together.
    
    Parameters:
    
    elementName - The element name (originates from formula element name or MPL integration tag)
    
    fieldValue - The value (= oprtator applied) of that attribute
    
    listTypedIds - A list of typedId of the "header" objects. E.g. 34.PL. Supported type codes are PL, MPL, PG and SIM
  - getItemCompleteCalculationResults
```
Map<String,Object> getItemCompleteCalculationResults(String typedId)
```
    Gets current complete calculation results of the given item (e.g., pricelist item).
    Note: These are not returned when using other methods (e.g., pricelistItem(String, String))
    
    Parameters:
    
    typedId - typedId of the item, e.g. 34.PLI. Supported type codes are PLI, XPLI, SIMI, XSIMI, PGI, XPGI and RR
    
    Returns:
    
    map of individual calculation results with 'Element Name' as key
  - getItemActiveCalculationResults
```
Map<String,Object> getItemActiveCalculationResults(String typedId)
```
    Gets current complete active (i.e. approved) calculation results of the given item.
    
    Parameters:
    
    typedId - typedId of the item, e.g. 34.PLI. Supported type codes are PGI and XPGI
    
    Returns:
    
    map of individual calculation results with 'Element Name' as key
  - httpCall
```
Object httpCall(String url,
                String body)
         throws XExpression
```
    Issues an HTTP call to external entity. Defaulting to POST request and JSON content type.
    
    Parameters:
    
    url - full url to the endpoint (https or http)
    
    body - body of the request
    
    Returns:
    
    Map containing two elements 'responseBody' and 'errorCode'. If content type is JSON and data is returned, responseBody will actually also be a parsed Map and not the raw data.
    
    Throws:
    
    XExpression
  - boundCall
```
Object boundCall(String uniqueName,
                 String relativeUrl,
                 String body,
                 Boolean... responseBodyAsAString)
          throws XExpression
```
    Issues an HTTP/S call to Price fx server. Local one or an external one.
    
    Parameters:
    
    uniqueName - unique name of bound partition. See Configuration/Bound Partitions
    
    relativeUrl - relative URL to Price f(x) server command. First slash excluded.
    
    body - body of the request
    
    responseBodyAsAString - if first param is true, than the body is not converted to json but returned as a string
    
    Returns:
    
    Map containing two elements 'responseBody' and 'errorCode'
    
    Throws:
    
    XExpression
  - getBoundPartitionNames
```
Object getBoundPartitionNames()
```
    Returns bound partition list.
    
    Returns:
    
    bound partition unique names
  - httpCall
```
Object httpCall(String url,
                String body,
                String methodType,
                String contentType,
                Map... properties)
         throws XExpression
```
    Issues an HTTP call to external entity.
    Parameters:
    
    url - - full url to the endpoint (https or http)
    
    body - body of the request
    
    methodType - "Get" or "Post"
    
    contentType - "JSON" "XML" or any full content type for instance "text/plain"
    properties - map of properties. Following are allowed:
    
    basicAuthenticationUserName -> String value - user name for basic authentication
    
    basicAuthenticationPassword -> String value - user password for basic authentication
    
    sslTrustAllCertificates boolean value - Ignores invalid certificates. Use for testing https connections only. Not for production use.
    
    proxyAuthenticationUserName String value - user name for proxy (if any)
    
    proxyAuthenticationPassword String value - user password for proxy (if any)
    
    proxyUrl String value - full url to proxy
    
    additionalHeaders Map value - a sub-map that then will add these headers verbatim to the request
    Returns:
    
    Map containing two elements 'responseBody' and 'statusCode'
    
    Throws:
    
    XExpression
  - add
```
Object add(String typeCode,
           Map<String,Object> values)
```
    Adds a new object to the collection of objects of the given type. Note: This operation will only work in contexts that allow object modification (CFS,CalculationFlow and direct formula execution via JSON API).
    
    Parameters:
    
    typeCode - A type code string of the type of the object to search for. All available type codes can be retrieved by calling <hostname>/pricefx/<partition name>/fetch
    
    values - key-value pairs representing fields of object we want to add. Note that all significant fields have to be present.
    
    Returns:
    
    added object or null if error occurred
  - addOrUpdate
```
Object addOrUpdate(String typeCode,
                   Map<String,Object> values)
```
    Adds or updates an object in the collection of objects of the given type. Note: This operation will only work in contexts that allow object modification (CFS, CalculationFlow and direct formula execution via JSON API). This method also works with the Post Step Logic Formula in workflows.
    
    Parameters:
    
    typeCode - A type code string of the type of the object to search for. All available type codes can be retrieved by calling <hostname>/pricefx/<partition name>/fetch
    
    values - key-value pairs representing fields of object we want to add or update. Note that all significant fields have to be present.
  - update
```
Object update(String typeCode,
              Map<String,Object> values)
```
    Updates an object in the collection of objects of the given type. Note: This operation will only work in contexts that allow object modification (CFS,CalculationFlow and direct formula execution via JSON API).
    Examples:
    api.addOrUpdate("PX", ["name": "Scoring_MM", "sku": sku]) api.addOrUpdate("PGI", ["priceGridName" : "LifeCycleMonitor", "sku" : currentItem.sku, "label" : currentItem.label]) def large = ["lookupTableId": pp.id, "lookupTableName": pp.uniqueName, "name": "L", "attribute1": percentileHigh, "attribute2": "999999999"] api.addOrUpdate("MLTV", large)
    Parameters:
    
    typeCode - A type code string of the type of the object to search for. All available type codes can be retrieved by calling <hostname>/pricefx/<partition name>/fetch
    
    values - key-value pairs representing fields of object we want to update. Note that all significant fields have to be present.
    
    Returns:
    
    updated object or null if error occured
  - delete
```
Object delete(String typeCode,
              Map<String,Object> values)
```
    Deletes an object in the collection of objects of the given type. Note: This operation will only work in contexts that allow object modification (CFS,CalculationFlow and direct formula execution via JSON API).
    Example:
    api.delete("PX", ["id": existingRecord, "name": "ActivePrice"])
    Parameters:
    
    typeCode - A type code string of the type of the object to search for. All available type codes can be retrieved by calling <hostname>/pricefx/<partition name>/fetch
    
    values - key-value pairs representing significant fields of object we want to delete. Note that all significant fields have to be present, if not the id has to be present
    
    Returns:
    
    deleted object or null if error occured
  - sendEmail
```
void sendEmail(String to,
               String subject,
               String message)
```
    Sends an email. Only one recipient can be defined. Note: This operation will only work in contexts that allow object modification (CFS,CalculationFlow and direct formula execution via JSON API).
    
    Parameters:
    
    to - email address the email is sent to
    
    subject - email subject
    
    message - email body
  - customEvent
```
void customEvent(Object object)
```
    Sends an event of type "CUSTOM". Other event types are reserved internally. Note: This operation will only work in contexts that allow object modification (CFS,CalculationFlow and direct formula execution via JSON API).
    
    Parameters:
    
    object - The object to pass along with the event
  - customEvent
```
void customEvent(Object object,
                 String customEventType)
```
    Sends an event of type "CUSTOM". Other event types are reserved internally. Note: This operation will only work in contexts that allow object modification (CFS,CalculationFlow and direct formula execution via JSON API).
    
    Parameters:
    
    object - The object to pass along with the event
    
    customEventType - A custom string to classify the event type (as the general event type is always CUSTOM)
  - customEvent
```
void customEvent(Object object,
                 String customEventType,
                 String operation)
```
    Sends an event of type "CUSTOM". Other event types are reserved internally. Note: This operation will only work in contexts that allow object modification (CFS,CalculationFlow and direct formula execution via JSON API).
    
    Parameters:
    
    object - The object to pass along with the event
    
    customEventType - A custom string to classify the event type (as the general event type is always CUSTOM)
    
    operation - One of these strings: UPDATE,DELETE,ADD,ITEMCHANGE
  - customEvent
```
void customEvent(Object object,
                 String customEventType,
                 String operation,
                 boolean omitNullValues)
```
    Sends an event of type "CUSTOM". Other event types are reserved internally. Note: This operation will only work in contexts that allow object modification (CFS,CalculationFlow and direct formula execution via JSON API).
    
    Parameters:
    
    object - The object to pass along with the event
    
    customEventType - A custom string to classify the event type (as the general event type is always CUSTOM). Can be null.
    
    operation - One of these strings: UPDATE,DELETE,ADD,ITEMCHANGE. Can be null.
    
    omitNullValues - Also include keys that have a null value (false) or omit them (true). True is the default for other method signatures that do not explicitly specify that value.
  - updateCalculableObjectHeader
```
Object updateCalculableObjectHeader(String calcObjTypeCode,
                                    String calcObjName)
```
    Updates the header information of a CalculableObject (e.g., a price grid, a price list, etc.). Note: This operation will only work in contexts that allow object modification (CFS,CalculationFlow and direct formula execution via JSON API).
    
    Parameters:
    
    calcObjTypeCode - Type code of object to update
    
    calcObjName - (Numeric) Id of object to update
  - attributedResult
```
AttributedResult attributedResult(Object result)
```
    Creates an AttributedResult object to be returned as a result of an output element.
    
    Since AttributedResult is configurable, it's used in cases where it's not sufficient to only return a plain value, but it's also required to adjust formatting, e.g., color, whether the value will display underlined, etc.
    
    The usage is simple, instead of returning the output value, create a new AttributedResult instance like this: api.attributedResult(plain value), customize it by calling its various methods, and return it finally.
    
    Sample code:
```
 def cost = api.getElement("Margin_pct")
 return api.attributedResult(cost)
 .withBackgroundColor(cost < 0.30 ? "red" : "#0101DF")
 .withSuffix(cost < 0.30 ? "!!!" : null)
 .withTextColor(cost < 0.30 ? "white" : null)
 .withTextDecoration(cost < 0.30 ? "underline" : null)
 
```
    Parameters:
    
    result - calculation result
    
    See Also:
    
    AttributedResult - for details on formatting
  - wrap
```
WrappedResult wrap(Object result)
```
    Wraps a result to make sure the original result object appears in the json response. This way also more complex results like lists and maps can be exported as such as a formula result
    
    Returns:
    
    A wrapped result object. Should only be used as a return statement of a formula element and not be used otherwise further on
  - newMatrix
```
ResultMatrix newMatrix()
```
    Creates a new result matrix DTO object that can be further customized and populated with calculated data.
  - newMatrix
```
ResultMatrix newMatrix(String... columns)
```
    Creates a new result matrix DTO object that can be further customized and populated with calculated data.
```
 The individual cells can be styled via the use of:
 -  linkCell(Object value,String targetPage, String targetPageState)
 -  imageCell(Object imageUrl)
 -  styledCell(Object value, String textColor,String bgColor, String weight, String alignment)
 -  styledCell(Object value, String textColor,String bgColor, String weight)
 -  styledCell(Object value, String textColor,String bgColor)
 -  setColumnFormat(String column, FieldFormatType fft)

 Valid FieldFormatTypes are:
 NUMERIC, NUMERIC_LONG, MONEY, PERCENT, TEXT, MONEY_EUR, MONEY_USD, MONEY_GBP, MONEY_JPY, MONEY_CHF, MONEY_PLN, DATETIME, DATE, INTEGER
 
```
    Sample code:
    def resultMatrix = api.newMatrix("Margin Status","Customer Id","Name","Net Margin %") def i=0 for(entry in rawValues.getEntries()) { def row =[:] row.put("Customer Id",resultMatrix.linkCell(entry.get("CustomerID"),"customersPage",entry.get("CustomerID"))) row.put("Name",entry.get("CustomerName")) def margin = entry.get("NetMargin%")/100 row.put("Net Margin %",resultMatrix.styledCell(margin,"#FF0000",null,"bold")) if(margin <= 0) row.put("Margin Status",resultMatrix.imageCell("/images/small_trafficlight_red.png")) if(margin <0.1 && margin > 0) row.put("Margin Status",resultMatrix.imageCell("/images/small_trafficlight_yellow.png")) if(margin >=0.1 ) row.put("Margin Status",resultMatrix.imageCell("/images/small_trafficlight_green.png")) resultMatrix.addRow(row) i++ if(i>10) break; } resultMatrix.setColumnFormat("Net Margin %",FieldFormatType.PERCENT) return resultMatrix
    Parameters:
    
    columns - The initial set of columns for the result matrix
  - newMatrix
```
ResultMatrix newMatrix(Collection<String> columns)
```
    Creates a new result matrix DTO object that can be further customized and populated with calculated data.
    
    Parameters:
    
    columns - The initial set of columns for the result matrix
    
    Returns:
    
    See Also:
    
    newMatrix(String... columns)
  - newGauge
```
ResultGauge newGauge()
```
    Creates a new gauge object that can be further customized. Sample:
    def g = api.newGauge() g.addSector(5,"#FF0000") g.addSector(25,"#FFFF00") g.addSector(null,"#00FF00") g.setValue(10)
  - newController
```
DashboardController newController()
```
    Creates a new dashboard controller object that can be further customized.
    def controller = api.newController() controller.addButton(label,targetPage,targetPageState) controller.addHTML(label,someValidHTML)
  - walkFilter
```
Filter walkFilter(Filter filter,
                  Closure<?> visitBefore,
                  Closure<?> visitAfter,
                  boolean removeNulls)
```
    Walks a filter and all its sub filters, visiting each filter in the tree. A pair of closures is used to visit each filter. Each closure can replace the Filter that is visiting. If it does, a new tree will be created for every part of the tree that is affected, thus preserving the original tree. removeNulls is consulted only in case of (sub)filters which take a list of sub filters.
    Hence, this method may be used in many cases. For instance, you could use it for mapping the current property set to another one, e.g. to convert a PB filter to a PA one. Somehow like this:
```
 def propertyMappings = ["sku": "ProductID"]
 api.walkFilter(pbFilter, null, { filter ->
  if (filter != null && propertyMappings[filter.property] != null) filter.property = propertyMappings[filter.property]
  filter
 }, false);
 
```
    Returns:
    
    if any changes have been made, the new Filter; if not, the original Filter.
  - findDataLoad
```
Object findDataLoad(String dataLoadLabel,
                    String dataLoadType,
                    String target)
```
    Parameters:
    
    dataLoadLabel - Label of DMDataLoad as seen in Data load UI
    dataLoadType - Load Type of DMDataLoad as seen in Data load UI. Namely:
    
    Customers
    
    Products
    
    Flush
    
    Calendar
    
    Refresh
    
    Calculation
    
    Truncate
    
    Simulation
    target - Target of DMDataLoad as seen in Data load UI
    
    Returns:
    
    dataload if and only if there is exactly one dataload matching (fail early strategy)
  - findRebateRecordLoad
```
Object findRebateRecordLoad(String rebateRecordLoadLabel)
```
    Parameters:
    
    rebateRecordLoadLabel - Label of rebate record load as seen in Rebate Record UI
    
    Returns:
    
    rebateRecordLoad if and only if there is exactly one load matching (fail early strategy)
  - currentPartitionName
```
String currentPartitionName()
```
    Returns the current partition name.
    
    Returns:
    
    The partition name
  - getTimeZone
```
DateTimeZone getTimeZone(String tzString)
```
    Just a wrapper for org.joda.time.DateTimeZone.forId(String tzString) method. See also the documentation there.
    
    Parameters:
    
    tzString -
    
    Returns:
  - uuid
```
String uuid(int len)
```
    Generate a random uuid of the specified length. Example: uuid(15) returns "VcydxgltxrVZSTV"
    
    Parameters:
    
    len - the desired number of characters
  - uuid
```
String uuid(int len,
            int radix)
```
    Generates a random uuid of the specified length, and radix. Examples:
    - uuid(8, 2) returns "01001010" (8 character ID, base=2)
    - uuid(8, 10) returns "47473046" (8 character ID, base=10)
    - uuid(8, 16) returns "098F4D35" (8 character ID, base=16)
    Parameters:
    
    len - the desired number of characters
    
    radix - the number of allowable values for each character (must be <= 62)
  - uuid
```
String uuid()
```
    Generates a RFC4122, version 4 ID. Example: "92329D39-6F5C-4520-ABFC-AAB64544E172"
  - multiKey
```
MultiKey<Object> multiKey(Object... keys)
```
    Constructs a new composite key object, which can be used as the key in a map. Equality of two keys is defined by the pair-wise equality of the corresponding key values.
    
    Parameters:
    
    keys - Key values
    
    Returns:
    
    MultiKey composed of the passed in, ordered, key values
  - roles
```
Map<String,String> roles()
```
    Lists all roles available in the application.
    
    Returns:
    
    Map of roleUniqueName -> roleLabel pairs
  - entityRef
```
String entityRef(PartitionedObject po)
          throws IllegalAccessException
```
    Creates entityRef value (usually db id) for the given entity. The value can be stored in attributeXX fields and you can set its meta type to ENTITY REFERENCE to convince the UI to show the data as links.
    
    Returns:
    
    String that represents linkable state of the entity
    
    Throws:
    
    IllegalAccessException
  - evalExpression
```
double evalExpression(String mathExpression)
```
    Evaluates an arithmetic expression that is passed in as a string. Supported operations are:
    - addition +
    - subtraction -
    - multiplication *
    - division /
    - exponentiation ^
    - square root sqrt
    Operator precedence and associativity rules are respected.
    Example: evalExpression("((10 - 3^2 + 1) * -sqrt(1*2+3*4)) / 4")
    Parameters:
    
    mathExpression - mathematical expression
    
    Returns:
    
    The result of the expression as double
  - setSharedCache
```
void setSharedCache(String key,
                    String value)
```
    Stores a string value in the shared cache with the given key. Note the "global" nature of the key!
    
    Parameters:
    
    key - The cache key
    
    value - The value to store
  - getSharedCache
```
String getSharedCache(String key)
```
    Retrieves a value from the shared cache (and resets the TTL of the key).
    
    Parameters:
    
    key - The cache key
    
    Returns:
    
    The value or null found in the shared cache
  - removeSharedCache
```
void removeSharedCache(String key)
```
    Deletes a key from the shared chache
    
    Parameters:
    
    key - The cache key
  - base64Encode
```
String base64Encode(String string)
```
    Does a standard Base64 encoding of a string
    
    Parameters:
    
    string - The base64 encoded string
    
    Returns:
  - base64Decode
```
String base64Decode(String base64String)
```
    Decodes a base64 encoded string
    
    Parameters:
    
    base64String - The clear text string
    
    Returns:
  - getProductReferences
```
List<?> getProductReferences(String typeCode,
                             Set<String> skus)
```
    Returns a list of product reference records that tell which other objects of given type these skus are referenced
    
    Parameters:
    
    typeCode - Must be either "Q" or "RBA" for now
    
    skus - A set of SKU strings that should be searched for
    
    Returns:
    
    A list of reference records
  - getLocale
```
String getLocale()
```
    Returns the language part of the current request's locale
    
    Returns:
    
    The language part of the current request's locale (e.g. "en")
  - getBaseURL
```
String getBaseURL()
```
    Returns the base URL component of the current instance. Example: https://www.pricefx.eu
    
    Returns:
    
    The base URL
  - newCreationWorkflow
```
CreationWorkflowDefinition newCreationWorkflow()
```
  - newCreationWorkflowStep
```
CreationWorkflowStepDefinition newCreationWorkflowStep()
```
  - findNextRevUNs
```
Map<String,List<String>> findNextRevUNs(String typeCode,
                                        String... uniqueNames)
```
    Finds next revision uniqueNames for given Quotes/Contracts/RebateAgreements
    
    Parameters:
    
    typeCode - "Q" or "CT" or "RBA"
    
    uniqueNames - var args of Q/CT/RBA uniqueNames
    
    Returns:
    
    Map of Q/CT/RBA uniqueName -> List of nextRevUNs
  - isFullListCalculation
```
Boolean isFullListCalculation()
```
    Indicates wether the current calculation is recalculating the entire list or only parts of it. IMPORTANT: Currently only applicable for PriceGrid calculations!
    
    Returns:
    
    true if entire grid is calculated, false otherwise. null is returned if method is not applicable
  - triggerPriceGridCalculation
```
Long triggerPriceGridCalculation(Long priceGridId,
                                 Map<String,Object> parameters)
```
    This method will create new background calculation job for the specified PriceGrid. Either a full calculation (parameters == null) or a partial calculation (parameter entry "skusToRecalc" as a list of SKU strings) Note: This operation will only work in contexts that allow object modification (CFS,CalculationFlow and direct formula execution via JSON API).
    
    Parameters:
    
    priceGridId - ID of PriceGrid to calculate
    
    parameters - Optional job parameters
    
    Returns:
    
    The ID of the created job tracker
  - triggerCFSCalculation
```
Long triggerCFSCalculation(Long cfsID)
```
    This method will create a new background calculation job for the specified CFS Note: This operation will only work in contexts that allow object modification (CFS,CalculationFlow and direct formula execution via JSON API).
    
    Parameters:
    
    cfsID - ID of CalculatedFieldSet
    
    Returns:
    
    The ID of the created job tracker

Interface PublicGroovyAPI

Method Summary

Method Detail

isSyntaxCheck

isDebugMode

isDistributedMode

getGlobal

putGlobal

getCalculationContext

getId

getElement

getSecondaryKey

getBinding

targetDate

calendar

calendar

random

datamartCalendar

newDatamartSlice

newDatamartSlice

datamartFilter

datamartQuery

datamartLookup

getDatamartContext

getTableContext

getDatamartRowSet

getDatamartRowSet

switchSKUContext

resetSKUContextSwitch

product

product

product

otherProduct

otherProduct

productExtension

productExtension

productCompetition

productCompetition

productXRef

rebateAgreementUserEntry

productXRef

customer

customer

customer

customer

customer

otherCustomer

otherCustomer

otherCustomer

customerExtension

getCalculableLineItem

getCalculableLineItemResult

getCalculableLineItemCollection

createNewRevision

addWarning

contextByLabel

vLookup

vLookup

vLookup

vLookup

vLookup

vLookup

vLookup

vLookup

userEntry

decimalUserEntry

integerUserEntry

stringUserEntry

stringUserEntry

stringUserEntry

textUserEntry

textUserEntry

booleanUserEntry

dateUserEntry

timeUserEntry

dateTimeUserEntry

productGroupEntry

customerGroupEntry

customerGroupEntry

multiTierEntry