ISandboxAPI (Price f(x) Backend Server - Long Island Iced Tea 2.8.0 API)

```
public interface ISandboxAPI
```
This interface represents internally 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

Method Summary

All Methods Instance Methods Abstract 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 collection of objects of given type.
`Object`	`addOrUpdate(String typeCode, Map<String,Object> values)` Adds or updates object in collection of objects of given type.
`net.pricefx.server.dto.calculation.AttributedResult`	`attributedResult(Object result)`
`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 HTTP/S call to price fx server.
`net.pricefx.server.dto.calculation.ResultFlexChart`	`buildFlexChart(Object definition)` Calls `buildFlexChart(null, definition)`
`net.pricefx.server.dto.calculation.ResultFlexChart`	`buildFlexChart(String baseTemplateToUse, Object definition)` Creates a `FlexChart` from the passed `definition` by merging it with `options` defined within the `baseTemplateToUse` template.
`Calendar`	`calendar()` Gets a calendar object intialized with the current targetDate (or now if no target date is given)
`Calendar`	`calendar(Date date)` Gets a calendar object intialized with `date`
`Object`	`configurator(String configuratorName, String formulaName)` Equivalent of the standard syntax' "Configurator" 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
`int`	`count(String typeCode, Filter... filters)` Similar to the `find(java.lang.String, com.googlecode.genericdao.search.Filter...)` methods this method querys an arbitrary object type.
`net.pricefx.server.dto.calculation.ConfiguratorEntry`	`createConfiguratorEntry()` Creates an empty configurator entry object.
`net.pricefx.server.dto.calculation.ConfiguratorEntry`	`createConfiguratorEntry(net.pricefx.common.api.InputType type, String name)` Creates a cofigurator entry object and adds the specified input parameter as first parameter to the configurator entry If the parameter had a value in the previous round trip, that value is set automatically
`net.pricefx.server.dto.calculation.ConfiguratorEntry`	`createConfiguratorEntry(net.pricefx.common.api.InputType type, String name, Date targetDate)` Creates a cofigurator entry object and adds the specified input parameter as first parameter to the configurator entry If the parameter had a value in the previous round trip, that value is set automatically
`Filter`	`createElementNameFilter(String elementName, Object fieldValue, String... listTypedIds)` Creates a cross-list filter expression based on meta data.
`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.
`Object`	`currentItem(String attributeName)` Same as `currentItem()` but just returns 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
`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`	`customerExtension(String extensionName)` Equivalent of the standard syntax' "CXLookup" 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.
`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".
`net.pricefx.server.dto.calculation.dashboard.DashboardApi`	`dashboard(String dashboardName)`
`String`	`dashboardWideEvent(String eventName)`
`Object`	`datamartCalendar()` Returns a datamart calendar object
`Filter`	`datamartFilter(net.pricefx.domain.CustomerGroup customerGroup)` Translates a CustomerGroup to its equivalent Filter representation, mapping domain level field names to the corresponding Datamart field names in the process
`Filter`	`datamartFilter(net.pricefx.domain.DMDataSlice slice)` Translates a DMDataSlice to its equivalent Filter representation, mapping domain level field names to the corresponding Datamart field names in the process
`Filter`	`datamartFilter(net.pricefx.domain.ProductGroup productGroup)` Translates a ProductGroup to its equivalent Filter representation, mapping domain level field names to the corresponding Datamart field names in the process
`Object`	`datamartFilterBuilderUserEntry(String entryName, String datamart)` Equivalent of the standard syntax' "DatamartFilterBuilderUserEntry" function.
`Object`	`datamartLookup(Object... queryAndProjectionsAndFilters)`
`Object`	`datamartQuery(Object... queryAndDatamartAndProjectionsAndFilters)`
`Object`	`dateTimeUserEntry(String entryName)` Equivalent of the standard syntax' "DateTimeUserEntry" function.
`Object`	`dateUserEntry(String entryName)` Equivalent of the standard syntax' "DateUserEntry" function.
`Object`	`delete(String typeCode, Map<String,Object> values)` Deletes object in collection of objects of given type.
`boolean`	`emit(Object obj)` Emits an object to be consumed by an external thread.
`void`	`emitRebateRecords(String sortBy, Filter... filters)`
`Object`	`filter(String property, Object value)` Creates a filter object that can be used in other API functions.
`Object`	`filter(String property, Object lowerBound, Object upperBound)`
`Object`	`filter(String property, String 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 a map representation of that filter (from the "wire format") The map representation is the way the filter is described in the JSON requests between UI and server
`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, String sortBy, Filter... filters)` The swiss army knife method of the API.
`List<net.pricefx.server.dto.SummaryCalculableObjectItem>`	`findApprovedPricelistItems(String sku)` Returns a list of summary items.
`List<net.pricefx.domain.CalculatedFieldSet>`	`findCalculatedFieldSets(Date targetDate, String cfsName)` Returns a list of calculated field sets that match the targetDate
`List<net.pricefx.domain.CustomerAssignment>`	`findCustomerAssignments(String customerId)` Finds all assignement rcords for a given customerId Also matches by CustomerGroup definitions
`List<net.pricefx.domain.Customer>`	`findCustomersInGroup(net.pricefx.domain.CustomerGroup group)` Retrieves a list of customers that match a given CustomerGroup (returns first 200 entries)
`List<net.pricefx.domain.Customer>`	`findCustomersInGroup(net.pricefx.domain.CustomerGroup group, int startRow, String sortBy)` Retrieves a list of customers that match a given CustomerGroup with custom paging and sorting
`Object`	`findDataLoad(String dataLoadLabel, String dataLoadType, String target)`
`net.pricefx.domain.LookupTable`	`findLookupTable(String tableName)` Finds a LookupTbale / price parameter table base don the table name.
`List<Object>`	`findLookupTableValues(String tableName, Filter... filters)` Searches and returns values of a named lookup table.
`List<net.pricefx.domain.ManualPricelist>`	`findManualPricelists(Date targetDate, String listName)` Returns a list of manual pricelists that match the targetDate (i.e.
`List<net.pricefx.domain.PriceGrid>`	`findPriceGrids(Date targetDate, String priceGridName)` Returns a list of price grids that match the targetDate (i.e.
`List<net.pricefx.domain.Pricelist>`	`findPricelists(Date targetDate, String listName)` Returns a list of pricelists that match the targetDate (i.e.
`Object`	`findRebateRecords(String rebateTypeUN, Date startDate, Date endDate, net.pricefx.domain.CustomerGroup customerGroup, net.pricefx.domain.ProductGroup productGroup, Filter... filters)`
`List<net.pricefx.domain.Simulation>`	`findSimulations(Date targetDate, String simulationName)` Returns a list of simulations that match the targetDate (i.e.
`net.pricefx.workflowengine.WorkflowInfo`	`findWorkflowInfo(String approvableTypeCode, Object approvableId)` Finds active workflow for given approvable.
`String`	`formatNumber(String pattern, BigDecimal n)` Formats a number into a string.
`String`	`formatNumber(String pattern, Integer n)` Formats a number into a string.
`String`	`formatNumber(String locale, String pattern, BigDecimal n)` Formats a number into a string.
`String`	`formatNumber(String locale, String pattern, Integer 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...)`
`Object`	`getBinding(String name)` Gets a named binding variable from a library function.
`Object`	`getBoundPartitionNames()` Returns bound partition list
`<T extends net.pricefx.domain.CalculableLineItem> T`	`getCalculableLineItem(Object clic, String lineId)` Returns a line item of a given calculable line item collection (a.k.a.
`Object`	`getCalculableLineItemResult(Object cli, String... resultNamesOrLabels)` Returns result(s) of given name(s) (or label(s)) from a line item object (its map representation to be exact).
`Object`	`getClusterNodes()`
`net.pricefx.domain.Customer`	`getCustomer(String customerId)`
`net.pricefx.domain.Customer`	`getCustomerParent(String customerId)`
`net.pricefx.formulaengine.DatamartContext`	`getDatamartContext()`
`net.pricefx.formulaengine.DatamartRowSet`	`getDatamartRowSet()`
`net.pricefx.formulaengine.DatamartRowSet`	`getDatamartRowSet(String name)`
`Object`	`getElement(String name)` Gets the result of a previous formula element.
`Map<String,Object>`	`getGlobal()` A publicly available hashmap to store and share values accross formula elements If `api.retainGlobal` is set to true this map will also be available with an entire list calculation, i.e accross item boundaries.
`Long`	`getId(Object obj)` Returns the id part of an object.
`Map<String,Object>`	`getItemCompleteCalculationResults(String typedId)` Gets current complete calculation results of the given item (e.g.
`int`	`getIterationNumber()` 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
`Object`	`getManualOverride(String elementName)` In certain scenarios (e.g.
`ContextParameter`	`getParameter(String parameterName)` Retrieves an already generated (i.e.
`net.pricefx.service.ItemSummaryQuery<net.pricefx.domain.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)
`Map<String,Object>`	`getPricelistItem(String listName)` Similar to the standard syntax' "Pricelist" function.
`net.pricefx.service.ItemSummaryQuery<net.pricefx.domain.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)
`net.pricefx.domain.Product`	`getProduct(String sku)`
`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.
`net.pricefx.service.ItemSummaryQuery<net.pricefx.domain.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
`Object`	`getSecondaryKey()` Gets the secondary key in case a matrix pricelist or matrix simulation is processed
`net.pricefx.service.ItemSummaryQuery<net.pricefx.domain.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)
`net.pricefx.formulaengine.TableContext`	`getTableContext()`
`Object`	`httpCall(String url, String body)` Issues HTTP call to external entity.
`Object`	`httpCall(String url, String body, String methodType, String contentType, Map... properties)` Issues HTTP call to external entity.
`Object`	`input(String inputName)` Retrives an input parameter - without triggering a user input
`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`	`isSecondPass()` Method to determine if the calculation is in 2nd pass calculation.
`boolean`	`isSyntaxCheck()`
`boolean`	`isUserInGroup(String userGroupName, String loginUserName)` Checks if the current user is member of a 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
`void`	`log(String msg, Object arg1)` Generates a system log entry.
`void`	`logInfo(String msg, Object arg1)` Generates a system log entry at INFO level.
`void`	`logWarn(String msg, Object arg1)` Generates a system log entry at WARN level.
`void`	`markItemClean()` Removes a "dirty marker" from the current item
`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.
`Object`	`multiTierEntry(String entryName, String... valueHints)` Equivalent of the standard syntax' "MultiTierEntry" function.
`net.pricefx.common.apibuilder.chart.ChartBuilder`	`newChartBuilder()`
`net.pricefx.server.dto.calculation.DashboardController`	`newController()` Creates a new dashboard controller object that can be further customized
`Object`	`newDatamartSlice()` Creates a new Datamart Slice, which allows for setting filter criteria along the Time, CustomerGroup, ProductGroup any any other dimensions in a Datamart.
`Object`	`newDatamartSlice(String dateFieldName, Object... timePeriodsAndProductAndCustomerGroups)` Creates a new Datamart Slice, which allows for setting filter criteria along the Time, CustomerGroup, ProductGroup any any other dimensions in a Datamart, intiialized with the name of the time dimension field, and an optional set filter criteria.
`net.pricefx.server.dto.calculation.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 filled with calculated data
`ResultMatrix`	`newMatrix(String... columns)` Creates a new result matrix DTO object that can be further customized and filled with calculated data.
`Object`	`option(String entryName, Object... options)` Equivalent of the standard syntax' "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 a given pattern.
`org.joda.time.DateTime`	`parseDateTime(String pattern, String datetime)` Parses a datetime (entered in as string) according to a given pattern.
`org.joda.time.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(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.
`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
`void`	`redAlert(String msg)` Marks the current formula element with a red alert and the given message
`void`	`removeManualOverride(String elementName)` Removes a manual result override.
`void`	`resetSKUContextSwitch()` Resets a sku context switch to the origionally specified sku
`List<Map<String,Object>>`	`runSummaryQuery(net.pricefx.service.ItemSummaryQuery<? extends net.pricefx.domain.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 email.
`org.hibernate.ScrollableResults`	`stream(String typeCode, String sortBy, Filter... filters)` Search for all types of objects with a freestyle query, and iterate over the result set.
`org.hibernate.ScrollableResults`	`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.
`org.hibernate.ScrollableResults`	`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.
`Object`	`stringUserEntry(String entryName)` Equivalent of the standard syntax' "StringUserEntry" function.
`Object`	`stringUserEntry(String entryName, String textMask)` 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
`void`	`throwException(String errorMessage)` Throws a calculation exception with a 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.
`Object`	`update(String typeCode, Map<String,Object> values)` Updates object in collection of objects of given type.
`Object`	`updateCalculableObjectHeader(String calcObjTypeCode, String calcObjName)` Updates the header information of a CalculableObject (e.g.
`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.
`Object`	`vLookup(String parameterName)` Equivalent of the standard syntax' "VLookup" function.
`Object`	`vLookup(String parameterName, Number rangeValue)` Equivalent of the standard syntax' "VLookup" function.
`Object`	`vLookup(String parameterName, String attributeNameOrKey)` 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, groovy.lang.Closure visitBefore, groovy.lang.Closure visitAfter, boolean removeNulls)` Walks a filter and all its sub filters, visiting each filter in the tree.
`void`	`yellowAlert(String msg)` Marks the current formula element with a yellow alert and the given message

- Method Detail
  - isSyntaxCheck
```
boolean isSyntaxCheck()
```
  - isDebugMode
```
boolean isDebugMode()
```
    Returns true if formula is called via UI debug/test exec mode
    
    Returns:
  - getGlobal
```
Map<String,Object> getGlobal()
```
    A publicly available hashmap to store and share values accross formula elements If api.retainGlobal is set to true this map will also be available with an entire list calculation, i.e accross item boundaries. Can be also accessed directly as api.global
    
    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
  - 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
    
    Parameters:
    
    obj -
    
    Returns:
  - 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")
    
    Parameters:
    
    name -
    
    Returns:
  - targetDate
```
Date targetDate()
```
    Gets the current execution context's target date
    
    Returns:
    
    The date
  - calendar
```
Calendar calendar()
```
    Gets a calendar object intialized 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 intialized with date
    
    Parameters:
    
    date - The date to initialize the calendar with
    
    Returns:
    
    The initialized Calendar object
  - datamartCalendar
```
Object datamartCalendar()
```
    Returns a datamart calendar object
    
    Returns:
  - newDatamartSlice
```
Object newDatamartSlice()
```
    Creates a new Datamart Slice, which allows for setting filter criteria along the Time, CustomerGroup, ProductGroup any any other dimensions in a Datamart.
    
    Returns:
    
    The instantiated, empty, DMDataSlice object
  - newDatamartSlice
```
Object newDatamartSlice(String dateFieldName,
                        Object... timePeriodsAndProductAndCustomerGroups)
```
    Creates a new Datamart Slice, which allows for setting filter criteria along the Time, CustomerGroup, ProductGroup any any other dimensions in a Datamart, intiialized with the name of the time dimension field, and an optional set filter criteria.
    
    Parameters:
    
    dateFieldName - Name of the time dimension field
    
    timePeriodsAndProductAndCustomerGroups - TimePeriod, CustomerGroup, ProductGroup filters
    
    Returns:
    
    The initialzied DMDataSlice object
  - datamartFilter
```
Filter datamartFilter(net.pricefx.domain.CustomerGroup customerGroup)
```
    Translates a CustomerGroup to its equivalent Filter representation, mapping domain level field names to the corresponding Datamart field names in the process
    
    Parameters:
    
    customerGroup - The CustomerGroup to translate into Datamart level filter criteria
    
    Returns:
    
    Filter object representing the CustomerGroup dimension slice in the Datamart
  - datamartFilter
```
Filter datamartFilter(net.pricefx.domain.ProductGroup productGroup)
```
    Translates a ProductGroup to its equivalent Filter representation, mapping domain level field names to the corresponding Datamart field names in the process
    
    Parameters:
    
    productGroup - The CustomerGroup to translate into Datamart level filter criteria
    
    Returns:
    
    Filter object representing the CustomerGroup dimension slice in the Datamart
  - datamartFilter
```
Filter datamartFilter(net.pricefx.domain.DMDataSlice slice)
```
    Translates a DMDataSlice to its equivalent Filter representation, mapping domain level field names to the corresponding Datamart field names in the process
    
    Parameters:
    
    slice - A DMDataSlice object instantiated by api.newDatamartSlice, or in a Rebate calculation context, referenced by the 'calulationBase' binding.
    
    Returns:
    
    Filter object representing the data slice in the Datamart
  - 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 witha 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(String attributeName)
```
    Equivalent of the standard syntax' "Product" function. Retrieves a named 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 a named attribute's value of the named 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
  - 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
    
    Returns:
  - customer
```
Object customer(String attributeName)
```
    Equivalent of the standard syntax' "Customer" function. Retrieves a named 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 a named attribute's value of the customer context parameter (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
    
    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 a named attribute's value of the named 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 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
    
    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)
```
    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
    
    Returns:
    
    A list of matching CX records
  - 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 - One or more filter(java.lang.String,java.lang.Object) objects that narrow down the CX search
    
    Returns:
    
    A list of matching CX records
  - getProduct
```
net.pricefx.domain.Product getProduct(String sku)
```
  - getCustomer
```
net.pricefx.domain.Customer getCustomer(String customerId)
```
  - getCustomerParent
```
net.pricefx.domain.Customer getCustomerParent(String customerId)
```
  - getCalculableLineItem
```
<T extends net.pricefx.domain.CalculableLineItem> T getCalculableLineItem(Object clic,
                                                                          String lineId)
```
    Returns a line item of a 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 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
  - 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,
               Number rangeValue)
```
    Equivalent of the standard syntax' "VLookup" function. This syntax is only relevant for range parameters.
    
    Parameters:
    
    parameterName - The name of the price parameter table
    
    rangeValue - The value to match a range of parameter
    
    Returns:
    
    The user selected value.
  - vLookup
```
Object vLookup(String parameterName,
               String attributeNameOrKey)
```
    Equivalent of the standard syntax' "VLookup" function.
    
    Parameters:
    
    parameterName - The name of the price parameter table
    
    attributeNameOrKey - A predefined key (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.
    
    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
  - integerUserEntry
```
Object integerUserEntry(String entryName)
```
    Equivalent of the standard syntax' "IntegerUserEntry" function. 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. Will trigger a 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. Will trigger a 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
  - booleanUserEntry
```
Object booleanUserEntry(String entryName)
```
    Equivalent of the standard syntax' "BooleanUserEntry" function. 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. Will trigger a date input element
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    Returns:
    
    The user entered value as String in the format yyyy-MM-dd
    
    See Also:
    
    #parseDate(String, String)}
  - timeUserEntry
```
Object timeUserEntry(String entryName)
```
    Equivalent of the standard syntax' "TimUserEntry" function. Will trigger a time input element
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    Returns:
    
    The user entered value as String in the format HH:mm
    
    See Also:
    
    #parseDate(String, String)}
  - dateTimeUserEntry
```
Object dateTimeUserEntry(String entryName)
```
    Equivalent of the standard syntax' "DateTimeUserEntry" function. Will trigger a datetime input element
    
    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.)
    
    See Also:
    
    #parseDate(String, String)}
  - productGroupEntry
```
Object productGroupEntry(String... entryName)
```
    Equivalent of the standard syntax' "ProductGroup" function. 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. Will trigger a customer group picker entry
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    Returns:
    
    The entered customer group
  - multiTierEntry
```
Object multiTierEntry(String entryName,
                      String... valueHints)
```
    Equivalent of the standard syntax' "MultiTierEntry" function. Will trigger a multi tier entry type
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    valueHints -
    
    Returns:
  - option
```
Object option(String entryName,
              Object... options)
```
    Equivalent of the standard syntax' "Options" function. 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
  - filterBuilderUserEntry
```
Object filterBuilderUserEntry(String entryName,
                              String typeCode)
```
    Equivalent of the standard syntax' "FilterBuilderUserEntry" function.
    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 datamart)
```
    Equivalent of the standard syntax' "DatamartFilterBuilderUserEntry" function.
    Will trigger a FilterBuilder widget allowing to construct a filter object filtering upon the specified datamart.
    The filter object will typically be used in other API functions, like datamartQuery(Object...).
    
    Parameters:
    
    entryName - The name of the user entry parameter
    
    datamart - the datamart to filter upon
    
    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.
    
    Returns:
  - 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. 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. 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. 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)
```
    Retrives 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. 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)
  - 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
    
    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 a map representation of that filter (from the "wire format") The map representation is the way the filter is described in the JSON requests between UI and server
    
    Parameters:
    
    filterMap - The filter in form of nested maps
    
    Returns:
  - filter
```
Object filter(String property,
              String opString,
              Object value)
```
    Creates a filter object that can be used in other API functions.
    
    Parameters:
    
    property - The property's name to filter on
    
    value - The specified value
    
    opString - One out of : "=", "<", "<=", ">", ">=", "<>", "~"
    
    Returns:
    
    A filter object
  - filter
```
Object filter(String property,
              Object lowerBound,
              Object upperBound)
```
  - datamartQuery
```
Object datamartQuery(Object... queryAndDatamartAndProjectionsAndFilters)
```
  - datamartLookup
```
Object datamartLookup(Object... queryAndProjectionsAndFilters)
```
  - getDatamartRowSet
```
net.pricefx.formulaengine.DatamartRowSet getDatamartRowSet()
```
  - getDatamartRowSet
```
net.pricefx.formulaengine.DatamartRowSet getDatamartRowSet(String name)
```
  - getDatamartContext
```
net.pricefx.formulaengine.DatamartContext getDatamartContext()
```
  - getTableContext
```
net.pricefx.formulaengine.TableContext getTableContext()
                                                throws SQLException
```
    Throws:
    
    SQLException
  - findRebateRecords
```
Object findRebateRecords(String rebateTypeUN,
                         Date startDate,
                         Date endDate,
                         net.pricefx.domain.CustomerGroup customerGroup,
                         net.pricefx.domain.ProductGroup productGroup,
                         Filter... filters)
```
  - isUserInGroup
```
boolean isUserInGroup(String userGroupName,
                      String loginUserName)
```
    Checks if the current user is member of a 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
  - log
```
void log(String msg,
         Object arg1)
```
    Generates a system log entry. Log message can contain placeholders like {} which are then filled in dynamically with the argument's value
    
    Parameters:
    
    msg - The log message to print
    
    arg1 - The arguments for the log message.
  - logInfo
```
void logInfo(String msg,
             Object arg1)
```
    Generates a system log entry at INFO level. Log message can contain placeholders like {} which are then filled in dynamically with the argument's value
    
    Parameters:
    
    msg - The log message to print
    
    arg1 - The arguments for the log message.
  - logWarn
```
void logWarn(String msg,
             Object arg1)
```
    Generates a system log entry at WARN level. Log message can contain placeholders like {} which are then filled in dynamically with the argument's value
    
    Parameters:
    
    msg - The log message to print
    
    arg1 - The arguments for the log message.
  - 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
    
    Returns:
  - 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. Obviously works only on objects that have meta attributes which contain 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
    
    Parameters:
    
    elementName -
    
    Returns:
    
    The item's property value
  - currentItem
```
Object currentItem(String attributeName)
```
    Same as currentItem() but just returns 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 get returned per one call. If there's more, 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
  - find
```
List<Object> find(String typeCode,
                  Filter... filters)
```
    The swiss army knife method of the API. With that method you can search for all types of objects with a freestyle query. The filters are AND'ed together. A maximum of 200 items are 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 that method you can search for all types of objects with a freestyle query. The filters are AND'ed together. A maximum of 200 items are 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 that method you can search for all types of objects with a freestyle query. The filters are AND'ed together. A maximum of 200 items are 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
    
    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 that 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
    
    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
    
    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 that 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
    
    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 that 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
    
    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
  - stream
```
org.hibernate.ScrollableResults stream(String typeCode,
                                       String sortBy,
                                       Filter... filters)
```
    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
    
    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
    
    Returns:
    
    The result implements the ScrollableResults interface, allowing for iteration over all records in scope of the query.
  - stream
```
org.hibernate.ScrollableResults 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. 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
    
    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
    
    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
    
    Returns:
    
    The result implements the ScrollableResults interface, allowing for iteration over all records in scope of the query.
    
    Throws:
    
    RemoteException
  - stream
```
org.hibernate.ScrollableResults 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. 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
    
    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
    
    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
    
    Returns:
    
    The result implements the ScrollableResults interface, allowing for iteration over all records in scope of the query.
    
    Throws:
    
    RemoteException
  - emit
```
boolean emit(Object obj)
```
    Emits an object to be consumed by an external thread. Requires a a blocking emitQueue to be set in the FormulaEngineContext, and a consuming thread to take emiitted objects from the queue. See also FeederFormulaExecutor.
    
    Parameters:
    
    obj - The object to be emitted/inserted in the emit queue
    
    Returns:
    
    True is the object is successfully inserted in the queue, false otherwise.
  - emitRebateRecords
```
void emitRebateRecords(String sortBy,
                       Filter... filters)
```
  - count
```
int count(String typeCode,
          Filter... filters)
```
    Similar to the find(java.lang.String, com.googlecode.genericdao.search.Filter...) methods this method querys 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
```
net.pricefx.domain.LookupTable findLookupTable(String tableName)
```
    Finds a LookupTbale / price parameter table base don 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
```
net.pricefx.workflowengine.WorkflowInfo findWorkflowInfo(String approvableTypeCode,
                                                         Object approvableId)
```
    Finds active workflow for given approvable. One is able to get the same information that is displayed in 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 non found
  - findCustomerAssignments
```
List<net.pricefx.domain.CustomerAssignment> findCustomerAssignments(String customerId)
```
    Finds all assignement rcords for a given customerId Also matches by CustomerGroup definitions
    
    Parameters:
    
    customerId - The customer to search an assignment for
    
    Returns:
    
    A list of assignment records
  - findPricelists
```
List<net.pricefx.domain.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<net.pricefx.domain.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<net.pricefx.domain.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<net.pricefx.domain.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<net.pricefx.domain.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<net.pricefx.server.dto.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<net.pricefx.domain.Customer> findCustomersInGroup(net.pricefx.domain.CustomerGroup group)
```
    Retrieves a list of customers that match a given CustomerGroup (returns first 200 entries)
    
    Parameters:
    
    group - The group to match
    
    Returns:
    
    A list of customers
  - findCustomersInGroup
```
List<net.pricefx.domain.Customer> findCustomersInGroup(net.pricefx.domain.CustomerGroup group,
                                                       int startRow,
                                                       String sortBy)
```
    Retrieves a list of customers that match a 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
    
    Throws:
    
    RemoteException
  - getManualOverride
```
Object getManualOverride(String elementName)
```
    In certain scenarios (e.g. price lists) the user can manually override calculation results. This method gets the user entered values by formula element
    
    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 manual result override. Use with caution as it may confise the user
    
    Parameters:
    
    elementName - The formula/result element that is overridden
  - abortCalculation
```
void abortCalculation()
```
    Aborts the current item's calculation. Subsequent formula elements aren't executed anymore
  - throwException
```
void throwException(String errorMessage)
             throws net.pricefx.formulaengine.XExpression
```
    Throws a calculation exception with a specified message and aborts the calculation
    
    Parameters:
    
    errorMessage - The error message that is then also displayed
    
    Throws:
    
    net.pricefx.formulaengine.XExpression
  - markItemDirty
```
void markItemDirty(String sku)
            throws net.pricefx.formulaengine.XExpression
```
    Marks the specfied item dirty. I.e. a 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:
    
    net.pricefx.formulaengine.XExpression
  - markItemDirty
```
void markItemDirty(String sku,
                   String key2)
            throws net.pricefx.formulaengine.XExpression
```
    Marks the specfied item dirty. I.e. a second calculation run will be triggered and this item is included in the 2nd pass
    
    Parameters:
    
    sku -
    
    key2 -
    
    Throws:
    
    net.pricefx.formulaengine.XExpression
  - markItemDirty
```
void markItemDirty()
            throws net.pricefx.formulaengine.XExpression
```
    Marks the current item dirty. I.e. a second calculation run will be triggered and this item is included in the 2nd pass
    
    Throws:
    
    net.pricefx.formulaengine.XExpression
  - markItemClean
```
void markItemClean()
            throws net.pricefx.formulaengine.XExpression
```
    Removes a "dirty marker" from the current item
    
    Throws:
    
    net.pricefx.formulaengine.XExpression
  - isSecondPass
```
boolean isSecondPass()
              throws net.pricefx.formulaengine.XExpression
```
    Method to determine if the calculation is in 2nd pass calculation. Useful for flow control Note: This does not necessarily mean it is the second iteration (i.e. 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:
    
    net.pricefx.formulaengine.XExpression
  - getIterationNumber
```
int getIterationNumber()
                throws net.pricefx.formulaengine.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
    
    Returns:
    
    Throws:
    
    net.pricefx.formulaengine.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,
                    BigDecimal 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 pattern,
                    Integer 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,
                    BigDecimal 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
  - formatNumber
```
String formatNumber(String locale,
                    String pattern,
                    Integer 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 locale 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
    
    Parameters:
    
    json - The input object, usually map
    
    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
```
net.pricefx.server.dto.calculation.ResultFlexChart buildFlexChart(Object definition)
                                                           throws RemoteException
```
    Calls buildFlexChart(null, definition)
    
    Throws:
    
    RemoteException
  - buildFlexChart
```
net.pricefx.server.dto.calculation.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 normally get specified by using 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 get defined by an 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
  - getPricelistSummaryQuery
```
net.pricefx.service.ItemSummaryQuery<net.pricefx.domain.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
```
net.pricefx.service.ItemSummaryQuery<net.pricefx.domain.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
```
net.pricefx.service.ItemSummaryQuery<net.pricefx.domain.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
```
net.pricefx.service.ItemSummaryQuery<net.pricefx.domain.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(net.pricefx.service.ItemSummaryQuery<? extends net.pricefx.domain.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
```
net.pricefx.server.dto.calculation.ConfiguratorEntry createConfiguratorEntry(net.pricefx.common.api.InputType type,
                                                                             String name)
```
    Creates a cofigurator entry object and adds the specified input parameter as first parameter to the configurator entry If the parameter had a value in the previous round trip, that value is set automatically
    
    Parameters:
    
    type - Input type of the parameter
    
    name - name of the parameter
    
    Returns:
    
    The configurator entry with the input parameter added
  - createConfiguratorEntry
```
net.pricefx.server.dto.calculation.ConfiguratorEntry createConfiguratorEntry(net.pricefx.common.api.InputType type,
                                                                             String name,
                                                                             Date targetDate)
```
    Creates a cofigurator entry object and adds the specified input parameter as first parameter to the configurator entry If the parameter had a value in the previous round trip, that value is set automatically
    
    Parameters:
    
    type - Input type of the parameter
    
    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
```
net.pricefx.server.dto.calculation.ConfiguratorEntry createConfiguratorEntry()
```
    Creates an empty configurator entry object. Needs to be filled with input parameters by calling createParameter on the object
    
    Returns:
    
    The configurator entry
  - 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
  - parseDate
```
Date parseDate(String pattern,
               String date)
```
    Parses a date (entered in as string) according to a given pattern.
    Hint: for parsing datetimes (i.e. dates also including information about the time of a 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
```
org.joda.time.DateTime parseDateTime(String pattern,
                                     String datetime)
```
    Parses a datetime (entered in as string) according to a given pattern.
    Important note: this method will use the UTC time zone for parsing (unless the provided pattern make use of 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
```
org.joda.time.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 no matter on 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" a 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
    
    Returns:
  - 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 and RR
    
    Returns:
    
    map of individual calculation results with 'Element Name' as key
  - httpCall
```
Object httpCall(String url,
                String body)
         throws net.pricefx.formulaengine.XExpression
```
    Issues 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'
    
    Throws:
    
    net.pricefx.formulaengine.XExpression
  - boundCall
```
Object boundCall(String uniqueName,
                 String relativeUrl,
                 String body,
                 Boolean... responseBodyAsAString)
          throws net.pricefx.formulaengine.XExpression
```
    Issues HTTP/S call to price fx server. Local one or any 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
    
    responseBodyAsAStrings - - 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:
    
    net.pricefx.formulaengine.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 net.pricefx.formulaengine.XExpression
```
    Issues 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
    Returns:
    
    Map containing two elements 'responseBody' and 'statusCode'
    
    Throws:
    
    net.pricefx.formulaengine.XExpression
  - add
```
Object add(String typeCode,
           Map<String,Object> values)
```
    Adds a new object to collection of objects of 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 has to be present.
  - addOrUpdate
```
Object addOrUpdate(String typeCode,
                   Map<String,Object> values)
```
    Adds or updates object in collection of objects of 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 or update. Note that all significant fields has to be present.
    
    Returns:
  - update
```
Object update(String typeCode,
              Map<String,Object> values)
```
    Updates object in collection of objects of 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 update. Note that all significant fields has to be present.
    
    Returns:
    
    updated object or null if error occured
  - delete
```
Object delete(String typeCode,
              Map<String,Object> values)
```
    Deletes object in collection of objects of 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 significant fields of object we want to delete. Note that all significant fields has 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 email. Just one TO. 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 alon 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 alon 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 alon 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
  - 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
    
    Returns:
  - getClusterNodes
```
Object getClusterNodes()
```
  - dashboard
```
net.pricefx.server.dto.calculation.dashboard.DashboardApi dashboard(String dashboardName)
```
  - dashboardWideEvent
```
String dashboardWideEvent(String eventName)
```
  - attributedResult
```
net.pricefx.server.dto.calculation.AttributedResult attributedResult(Object result)
```
  - newMatrix
```
ResultMatrix newMatrix()
```
    Creates a new result matrix DTO object that can be further customized and filled with calculated data
    
    Returns:
  - newMatrix
```
ResultMatrix newMatrix(String... columns)
```
    Creates a new result matrix DTO object that can be further customized and filled 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
    
    Returns:
  - newGauge
```
net.pricefx.server.dto.calculation.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)
    Returns:
  - newChartBuilder
```
net.pricefx.common.apibuilder.chart.ChartBuilder newChartBuilder()
```
    Returns:
  - newController
```
net.pricefx.server.dto.calculation.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)
    Returns:
  - walkFilter
```
Filter walkFilter(Filter filter,
                  groovy.lang.Closure visitBefore,
                  groovy.lang.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. Either closure may 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)

Interface ISandboxAPI

Method Summary

Method Detail

isSyntaxCheck

isDebugMode

getGlobal

putGlobal

getId

getElement

getSecondaryKey

getBinding

targetDate

calendar

calendar

datamartCalendar

newDatamartSlice

newDatamartSlice

datamartFilter

datamartFilter

datamartFilter

switchSKUContext

resetSKUContextSwitch

product

product

otherProduct

otherProduct

productExtension

productExtension

productCompetition

productCompetition

productXRef

productXRef

customer

customer

customer

customer

otherCustomer

otherCustomer

otherCustomer

customerExtension

customerExtension

getProduct

getCustomer

getCustomerParent

getCalculableLineItem

getCalculableLineItemResult

vLookup

vLookup

vLookup

vLookup

vLookup

vLookup

vLookup

vLookup

vLookup

userEntry

integerUserEntry

stringUserEntry

stringUserEntry

booleanUserEntry

dateUserEntry

timeUserEntry

dateTimeUserEntry

productGroupEntry

customerGroupEntry

multiTierEntry

option

filterBuilderUserEntry

datamartFilterBuilderUserEntry

pricelist

pricelist

pricelist

pricelist

pricelistItem

pricelistItem

pricelistItem

getPricelistItem

bom

bom

bom