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

Interface QapiCompensationLineItem

All Superinterfaces:
CalculableLineItemColumns, ClicColumns, InputsColumns, Map<String,SelectableExpression>, OutputsColumns, PersistedObjectColumns, Tables.Columns, Tables.Table
public interface QapiCompensationLineItem extends Tables.Table, PersistedObjectColumns, ClicColumns
Table of the line items of one Compensation Plan. Each row is one line item or folder.

Example: 


 def q = api.queryApi()
 def t = q.tables().compensationLineItems("MyCompensationPlan")

 return q.source(t, [t.lineId(), t.compensationConditionTypeUniqueName(), t.startDate(), t.endDate()],
         t.compensationConditionTypeUniqueName().isNotNull())
         .stream { it.collect { it } }
Since:
14.0 - Caribou Lou
See Also:

  • Method Details

    • compensationConditionTypeUniqueName

      SelectableExpression compensationConditionTypeUniqueName()
      Returns the unique name of the Compensation Condition Type that the line item represents and calculates.

      Folders have no Compensation Condition Type.

      Returns:
      the compensationConditionTypeUniqueName column as a String expression
      See Also:

    • compensationConditionTypeLabel

      SelectableExpression compensationConditionTypeLabel()
      Returns the label of the Compensation Condition Type of the line item.
      Returns:
      the compensationConditionTypeLabel column as a String expression
      See Also:

    • customerGroup

      SelectableExpression customerGroup()
      Returns the group of customers for whom the compensation conditions on the line item are negotiated.

      The value is a customer group object, not a String.

      Returns:
      the customerGroup column as a Pojo expression
      See Also:

    • productGroup

      SelectableExpression productGroup()
      Returns the group of products for which the compensation conditions on the line item are negotiated.

      The value is a product group object, not a String.

      Returns:
      the productGroup column as a Pojo expression
      See Also:

    • startDate

      SelectableExpression startDate()
      Returns the first day of validity of the conditions on the line item.

      By default, the value is copied from the start date of the Compensation Plan.

      Returns:
      the startDate column as a DateOnly expression
      See Also:

    • endDate

      SelectableExpression endDate()
      Returns the last day of validity of the conditions on the line item.

      By default, the value is copied from the end date of the Compensation Plan.

      Returns:
      the endDate column as a DateOnly expression
      See Also:

    • payoutDate

      SelectableExpression payoutDate()
      Returns the date on which the compensation is expected to be paid out.

      By default, the value is copied from the payout date of the Compensation Plan.

      Returns:
      the payoutDate column as a DateOnly expression

    • calculationBaseJson

      SelectableExpression calculationBaseJson()
      Returns the Datamart data slice that defines the calculation base of the line item.

      The value is the data slice serialized as JSON.

      Returns:
      the calculationBaseJson column as a String expression

    • simulationType

      SelectableExpression simulationType()
      Returns the simulation type of the line item, copied from the Compensation Plan when the line item is calculated.
      Returns:
      the simulationType column as a String expression