Interface QapiContractLineItem

All Superinterfaces:
CalculableLineItemColumns, ClicColumns, InputsColumns, Map<String,SelectableExpression>, OutputsColumns, PersistedObjectColumns, Tables.Columns, Tables.Table

public interface QapiContractLineItem extends Tables.Table, PersistedObjectColumns, ClicColumns
Table of the line items of one Agreement or Promotion (contract). Each row is one line item, which holds the conditions negotiated for one Condition Type, or one folder.

Example:


 def q = api.queryApi()
 def t = q.tables().contractLineItems("MyAgreement")

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

    • contractTermTypeUniqueName

      SelectableExpression contractTermTypeUniqueName()
      Returns the unique name of the Condition Type (formerly Contract Term Type) of the line item.

      Folders have no Condition Type.

      Returns:
      the contractTermTypeUniqueName column as a String expression
      See Also:
    • contractTermTypeLabel

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

      SelectableExpression customerGroup()
      Returns the group of customers for whom the 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 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

      Returns the first day of validity of the conditions on the line item.

      The date is inherited from the Agreement or Promotion header, but can be set on the line item.

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

      Returns the last day of validity of the conditions on the line item.

      The date is inherited from the Agreement or Promotion header, but can be set on the line item.

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

      SelectableExpression priceRecordId()
      Returns the ID of the Price Record generated from the line item.
      Returns:
      the priceRecordId column as an Integer 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