Package net.pricefx.formulaengine.scripting.queryapi.tables

package net.pricefx.formulaengine.scripting.queryapi.tables

Typed table descriptors of the Query API.

Each Qapi interface describes one queryable Pricefx table. Every column is an accessor method that returns a selectable expression. The expression carries a Query API type: String, Integer, Real, DateOnly, DateTime, Boolean or Pojo.

Entry point: the accessors of the Tables collection, obtained with api.queryApi().tables(). Examples are products(), customers() and datamart(name). The query pipeline itself lives in the net.pricefx.formulaengine.scripting.queryapi package.

The tables group as follows.

Analytics:

• QapiDataSource, QapiDataFeed, QapiDatamart, QapiRollup, QapiModelTable.

Transactional data:

• Master data: QapiProduct, QapiProductExtensionRow, QapiProductCompetition, QapiProductBillOfMaterial, QapiProductReference, QapiCustomer, QapiCustomerExtensionRow, QapiSeller, QapiSellerExtensionRow, QapiUser.
• Company Parameters and Condition Records: QapiCompanyParameterTable, QapiCompanyParameterRow, QapiConditionRecord, QapiHistoricalConditionRecord.
• Pricing documents: QapiPriceList, QapiPriceListLineItem, QapiPriceGrid, QapiPriceGridLineItem, QapiCalculationGrid, QapiCalculationGridLineItem, QapiQuoteLineItem, QapiContractLineItem, QapiCustomForm.
• Rebates, claims and compensation: QapiRebateRecord, QapiRebateLineItem, QapiClaim, QapiClaimLineItem, QapiCompensationRecord, QapiCompensationLineItem.
• Jobs and tasks: QapiActionItem, QapiJobStatusTracker.

The *Columns interfaces are shared column mixins. They carry the columns common to several tables: PersistedObjectColumns, CalculableObjectColumns, CalculableObjectLineItemColumns, PriceCalculableObjectLineItemColumns, CalculableLineItemColumns, InputsColumns, OutputsColumns and ApprovableColumns. ClicColumns is deprecated.

Related Packages

Package	Description
net.pricefx.formulaengine.scripting.queryapi	The Query API, the unified Groovy API for reading data from Pricefx.

Class	Description
ApprovableColumns	Approval workflow columns shared by every Query API table whose rows go through an approval workflow.
CalculableLineItemColumns	Columns shared by the line items of Quotes, Agreements and Promotions, Rebate Agreements and Compensation Plans.
CalculableObjectColumns	Header columns shared by Price Lists, Live Price Grids and Calculation Grids, which are calculated as a whole by a background calculation job.
CalculableObjectLineItemColumns	Columns shared by the items of Price Lists, Live Price Grids and Calculation Grids, and by Rebate Records and Compensation Records.
ClicColumns	Deprecated. Use CalculableLineItemColumns instead.
ClicColumns.InputColumns	Deprecated. Use InputsColumns.InputColumns instead.
ClicColumns.OutputColumns	Deprecated. Use OutputsColumns.OutputColumns instead.
InputsColumns	Access to the inputs of the rows of tables whose rows are calculated by a logic with user inputs.
InputsColumns.InputColumns	The columns of one input of a row, as returned by InputsColumns.input(String).
OutputsColumns	Access to the logic outputs (element results) stored on the rows of tables whose rows are calculated by a logic.
OutputsColumns.OutputColumns	The columns of one output of a row, as returned by OutputsColumns.output(String).
PersistedObjectColumns	Columns that every row of a Pricefx table has: its ID, its version and its audit information (who created and last updated it, and when).
PriceCalculableObjectLineItemColumns	Price columns of the items of Price Lists and Live Price Grids, and of Rebate Records and Compensation Records.
QapiActionItem	Table of Action Items, the actions that users are expected to perform, such as creating a quote or checking some prices.
QapiCalculationGrid	Table of Calculation Grid headers.
QapiCalculationGridLineItem	Table of the items of one Calculation Grid.
QapiClaim	Table of Claim headers.
QapiClaimLineItem	Table of the lines of one Claim.
QapiCompanyParameterRow	Table of the rows of one Company Parameter table.
QapiCompanyParameterTable	Table of Company Parameter table headers.
QapiCompensationLineItem	Table of the line items of one Compensation Plan.
QapiCompensationRecord	Table of the Compensation Records of one Compensation Record Set.
QapiConditionRecord	Table of the Condition Records of one Condition Record Set.
QapiContractLineItem	Table of the line items of one Agreement or Promotion (contract).
QapiCustomer	Table of the Customer master data.
QapiCustomerExtensionRow	Table of the rows of one Customer Extension (CX) table.
QapiCustomForm	Table of the Custom Forms of one Custom Form Type.
QapiDataFeed	Table of the rows of one Analytics Data Feed.
QapiDatamart	Table of the rows of one Analytics Datamart.
QapiDatamart.Options	Options of api.queryApi().tables().datamart(String, Map), which convert the values of the Datamart when they are read.
QapiDataSource	Table of the rows of one Analytics Data Source.
QapiHistoricalConditionRecord	Table of the history of the Condition Records of one Condition Record Set.
QapiJobStatusTracker	Table of the job status trackers of the partition.
QapiModelTable	Table of the rows of one table owned by a Model Object.
QapiPriceGrid	Table of Live Price Grid headers.
QapiPriceGridLineItem	Table of the items of one Live Price Grid.
QapiPriceList	Table of Price List headers.
QapiPriceListLineItem	Table of the items of one Price List.
QapiProduct	Table of the Product master data.
QapiProductBillOfMaterial	Table of the Bill of Materials (BoM) data.
QapiProductCompetition	Table of the Competition Data.
QapiProductExtensionRow	Table of the rows of one Product Extension (PX) table.
QapiProductReference	Table of the Product References.
QapiQuoteLineItem	Table of the line items of one Quote.
QapiRebateLineItem	Table of the line items of one Rebate Agreement.
QapiRebateRecord	Table of the Rebate Records of one Rebate Record Set.
QapiRollup	Table of the rows of one Analytics Rollup.
QapiSeller	Table of the Seller master data.
QapiSellerExtensionRow	Table of the rows of one Seller Extension (SX) table.
QapiUser