Package net.pricefx.formulaengine.scripting

package net.pricefx.formulaengine.scripting
Root package of the public Groovy API available to Pricefx logics. The central type is PublicGroovyAPI, the interface behind the api binding that every logic element can call. The other types in this package are objects a logic obtains through api calls: SystemPortlet home screen portlet results, Matrix2D query results, ClaimContext for Channel Management configuration, RContext for R integration, and the AppPages constants used as targetPage when linking from a dashboard to other parts of the user interface.

Entry point: the api binding itself, an instance of PublicGroovyAPI. Its functions cover input generation (api.inputBuilderFactory()), data querying (api.queryApi(), api.find), data manipulation, calculation engine access, date and time helpers, and tracing. The subpackages hold the larger APIs reached from api: inputbuilder for input builders, queryapi for the Query API, and portlets for dashboard portlet types.

Cross-cutting conventions: in the input generation mode (see PublicGroovyAPI.isInputGenerationExecution()) the logic runs against no calculable item, so functions that depend on item data return null or mocked values. Lookup functions generally return null when the requested object is not found. Transient caching is available through api.local and api.global; a logic must handle missing cache entries gracefully.