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

Interface QapiClaim

All Superinterfaces:
ApprovableColumns, Map<String,SelectableExpression>, PersistedObjectColumns, Tables.Columns, Tables.Table
public interface QapiClaim extends Tables.Table, PersistedObjectColumns, ApprovableColumns
Table of Claim headers. Each row is one Claim document, not one of its lines.

Example: 


 def q = api.queryApi()
 def t = q.tables().claims()

 return q.source(t, [t.uniqueName(), t.label(), t.customerId(), t.claimStatus(), t.workflowStatus()],
         t.claimStatus().equal(net.pricefx.common.api.ClaimStatus.APPROVED))
         .stream { it.collect { it } }
Since:
15.3.17 - Southside, 16.2.2 - Black Cat
See Also:

  • Method Details

    • uniqueName

      SelectableExpression uniqueName()
      Returns:
      the uniqueName column (the unique name, or document ID, of the Claim) as a String expression

    • label

      SelectableExpression label()
      Returns:
      the label column (the label of the Claim, the name displayed to users) as a String expression

    • claimTypeUniqueName

      SelectableExpression claimTypeUniqueName()
      Returns:
      the claimTypeUniqueName column (the unique name of the Claim Type used to process the Claim) as a String expression

    • customerId

      SelectableExpression customerId()
      Returns:
      the customerId column (the ID of the customer or distributor who submitted the Claim) as a String expression
      See Also:

    • customerName

      SelectableExpression customerName()
      Returns:
      the customerName column (the name of the customer or distributor who submitted the Claim) as a String expression
      See Also:

    • fileName

      SelectableExpression fileName()
      Returns:
      the fileName column (the name of the file the Claim data was uploaded from) as a String expression

    • externalRef

      SelectableExpression externalRef()
      Returns:
      the externalRef column (the external reference of the Claim) as a String expression

    • claimRecordUniqueName

      SelectableExpression claimRecordUniqueName()
      Returns:
      the claimRecordUniqueName column (the unique name of the Claim Record generated for the Claim after it was approved) as a String expression
      See Also:

    • claimStatus

      SelectableExpression claimStatus()
      To filter on the status, pass the enum constant, as in the example of this class: t.claimStatus().equal(net.pricefx.common.api.ClaimStatus.APPROVED).
      Returns:
      the claimStatus column (the status of the Claim document) as an Enum expression
      See Also:

    • sourceContractUniqueName

      SelectableExpression sourceContractUniqueName()
      Returns:
      the sourceContractUniqueName column (the unique name of the Agreement or Promotion the Claim was created from) as a String expression
      See Also:

    • sourceQuoteUniqueName

      SelectableExpression sourceQuoteUniqueName()
      Returns:
      the sourceQuoteUniqueName column (the unique name of the Quote the Claim was created from) as a String expression
      See Also:

    • progress

      SelectableExpression progress()
      The value is the number of processed lines over all lines, for example 40/100.
      Returns:
      the progress column (the progress of the calculation of the Claim lines) as a String expression
      See Also:

    • status

      SelectableExpression status()
      The value is the name of one of the CalculationStatus values.
      Returns:
      the status column (the status of the calculation job of the Claim) as an Enum expression
      See Also:

    • calculationStartDate

      SelectableExpression calculationStartDate()
      Returns:
      the calculationStartDate column (the date and time when the last calculation of the Claim started) as a DateTime expression
      See Also:

    • calculationDate

      SelectableExpression calculationDate()
      Returns:
      the calculationDate column (the date and time when the last calculation of the Claim ended) as a DateTime expression
      See Also:

    • targetDate

      SelectableExpression targetDate()
      Returns:
      the targetDate column (the target date of the Claim, used as the target date of the calculation) as a DateOnly expression

    • locale

      SelectableExpression locale()
      Returns:
      the locale column (the locale of the Claim) as a String expression

    • calculationMessages

      SelectableExpression calculationMessages()
      The value is a JSON array of message strings.
      Returns:
      the calculationMessages column (the messages, such as errors, produced by the last calculation of the Claim) as a String expression
      See Also:

    • submitDate

      SelectableExpression submitDate()
      Returns:
      the submitDate column (the date and time when the Claim was submitted for approval) as a DateTime expression
      See Also: