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

Interface QapiCompanyParameterRow

All Superinterfaces:
Map<String,SelectableExpression>, PersistedObjectColumns, Tables.Columns, Tables.Table
public interface QapiCompanyParameterRow extends Tables.Table, PersistedObjectColumns
Table of the rows of one Company Parameter table.

The available columns depend on the type of the Company Parameter:

  • Simple tables: key1() (the name of the row) and value().
  • Range tables: key1(), lowerBound() and upperBound().
  • Matrix and JSON tables: key1() up to the number of keys of the table, and the attribute fields that have a configured name, accessed as properties by that name.
Calling a method for a column that the table does not have, for example lowerBound() on a Simple table, fails with an error. All types also offer the ID and audit columns of PersistedObjectColumns.

Example: 


 def q = api.queryApi()
 def t = q.tables().companyParameterRows("Countries")

 return q.source(t, [t.key1(), t.value()])
         .stream { it.collect { it } }
Since:
14.0 - Caribou Lou
See Also:

  • Method Details

    • value

      SelectableExpression value()
      Returns the value of the row. Only available for Simple tables.
      Returns:
      the value column as an expression (its type will be taken from the company parameter type or from the corresponding attribute meta configuration if it exists)
      See Also:

    • lastUpdateByName

      SelectableExpression lastUpdateByName()
      Returns the name of the user who last updated the row.
      Returns:
      the lastUpdateByName column as a String expression
      See Also:

    • createdByName

      SelectableExpression createdByName()
      Returns the name of the user who created the row.
      Returns:
      the createdByName column as a String expression
      See Also:

    • lowerBound

      SelectableExpression lowerBound()
      Returns the lower bound of the range of the row. Only available for Range tables.
      Returns:
      the lowerBound column as a Real expression
      See Also:

    • upperBound

      SelectableExpression upperBound()
      Returns the upper bound of the range of the row. Only available for Range tables.
      Returns:
      the upperBound column as a Real expression
      See Also:

    • key1

      SelectableExpression key1()
      Returns the first key of the row.

      For Simple, Range and single-key Matrix or JSON tables, this is the name of the row. For Simple tables with an Integer, Real or Date key, the column has the type of the key.

      Returns:
      the key1 column as an expression (its type will be taken from the company parameter type or from the corresponding attribute meta configuration if it exists)

    • key2

      SelectableExpression key2()
      Returns the second key of the row. Only available for Matrix and JSON tables with at least 2 keys.
      Returns:
      the key2 column as an expression (its type will be taken from the corresponding attribute meta configuration if it exists)
      See Also:

    • key3

      SelectableExpression key3()
      Returns the third key of the row. Only available for Matrix tables with at least 3 keys.
      Returns:
      the key3 column as an expression (its type will be taken from the corresponding attribute meta configuration if it exists)
      See Also:

    • key4

      SelectableExpression key4()
      Returns the fourth key of the row. Only available for Matrix tables with at least 4 keys.
      Returns:
      the key4 column as an expression (its type will be taken from the corresponding attribute meta configuration if it exists)
      See Also:

    • key5

      SelectableExpression key5()
      Returns the fifth key of the row. Only available for Matrix tables with at least 5 keys.
      Returns:
      the key5 column as an expression (its type will be taken from the corresponding attribute meta configuration if it exists)
      See Also:

    • key6

      SelectableExpression key6()
      Returns the sixth key of the row. Only available for Matrix tables with 6 keys.
      Returns:
      the key6 column as an expression (its type will be taken from the corresponding attribute meta configuration if it exists)
      See Also: