Package net.pricefx.common.api

package net.pricefx.common.api
The value sets that the published Groovy API shares across modules.

These constants name the type of an input field, the kind of result a logic returns, and the display format of a column. They also name the events the platform emits, and the statuses of a Claim, a Custom Form, a Rebate Agreement and a Rebate Record. A logic uses a constant wherever the API expects one of these values, instead of a literal string.


 // an input field in a Configurator logic
 def entry = api.createConfiguratorEntry(InputType.STRINGUSERENTRY, "productName")

 // a result matrix whose price column renders as money
 def matrix = api.newMatrix("sku", "price")
 matrix.withColumnFormat("price", FieldFormatType.MONEY)

EventType works differently from the rest. It does not configure a call. It names an event that the platform emits, such as a finished calculation, an approved document or an updated record. A logic raises its own event with PublicGroovyAPI.customEvent(Object).

Reference