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

Interface QapiClaimLineItem

All Superinterfaces:
Map<String,SelectableExpression>, PersistedObjectColumns, Tables.Columns, Tables.Table
public interface QapiClaimLineItem extends Tables.Table, PersistedObjectColumns
Table of the lines of one Claim. Each row is one Claim line, usually one row of the uploaded file, with the results of its validation and calculation.

Example: 


 def q = api.queryApi()
 def t = q.tables().claimLineItems("CL-11")

 return q.source(t, [t.sku(), t.quantity(), t.totalAmount(), t.validationState()],
         t.calculationStatus().notEqual(0))
         .stream { it.collect { it } }
Since:
15.3.14 - Southside, 16.1.1 - Black Cat
See Also:

  • Method Details

    • sku

      SelectableExpression sku()
      Returns the Stock Keeping Unit (SKU) of the product claimed by the distributor.
      Returns:
      the sku column as a String expression

    • endCustomerId

      SelectableExpression endCustomerId()
      Returns the ID of the end customer to whom the distributor sold the product.
      Returns:
      the endCustomerId column as a String expression

    • quoteUniqueName

      SelectableExpression quoteUniqueName()
      Returns the unique name of the Quote that the Claim line is validated against.
      Returns:
      the quoteUniqueName column as a String expression
      See Also:

    • contractUniqueName

      SelectableExpression contractUniqueName()
      Returns the unique name of the Agreement or Promotion that the Claim line is validated against.
      Returns:
      the contractUniqueName column as a String expression
      See Also:

    • quantity

      SelectableExpression quantity()
      Returns the claimed quantity of the product.
      Returns:
      the quantity column as a Real expression

    • totalAmount

      SelectableExpression totalAmount()
      Returns the amount of money claimed by the distributor on the line.
      Returns:
      the totalAmount column as a Real expression

    • calculationStatus

      SelectableExpression calculationStatus()
      Returns the result of the last calculation of the Claim line.

      The value is a bit mask. 0 means the line was calculated without any message. Otherwise the value is the sum of flags such as 1 (error) and 2 (warning).

      Returns:
      the calculationStatus column as an Integer expression

    • validationState

      SelectableExpression validationState()
      Returns whether the Claim line is validated or rejected.

      NOT_VALIDATED marks a line that a user must validate or reject manually; it is the default when the Claim Type does not define a validation state element. AUTO_VALIDATED and AUTO_REJECTED are set by the validation logic, and a user can still change them. VALIDATED and REJECTED are set manually by a user.

      Returns:
      the validationState column as an Enum expression