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

Interface QapiCompanyParameterTable

All Superinterfaces:
Map<String,SelectableExpression>, PersistedObjectColumns, Tables.Columns, Tables.Table
public interface QapiCompanyParameterTable extends Tables.Table, PersistedObjectColumns
Table of Company Parameter table headers. Each row is one Company Parameter table, not one of its rows.

Obtain it with api.queryApi().tables().companyParameterTables(). The table contains only the Company Parameter tables with the status ACTIVE; inactive and simulation-only tables are not included. Several rows can share the same unique name with a different validAfter() date. Besides the columns below, the table offers the ID and audit columns of PersistedObjectColumns. To query the rows of one Company Parameter table, use companyParameterRows(String).

Example: 


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

 return q.source(t, [t.uniqueName(), t.label(), t.validAfter()], t.uniqueName().equal("Countries"))
         .stream { it.collect { it } }
Since:
15.3.13 - Southside, 16.0.4 - Black Cat
See Also:

  • Method Details

    • uniqueName

      SelectableExpression uniqueName()
      Returns the unique name of the Company Parameter table.

      The unique name alone does not identify a table: tables with the same unique name and a different validAfter() date are different versions of the same Company Parameter.

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

    • label

      SelectableExpression label()
      Returns the name of the Company Parameter table as displayed to users.
      Returns:
      the label column as a String expression

    • userGroupEdit

      SelectableExpression userGroupEdit()
      Returns the user group whose members can edit the Company Parameter table.
      Returns:
      the userGroupEdit column as a String expression
      Since:
      15.3.15 - Southside, 16.1.1 - Black Cat
      See Also:

    • userGroupViewDetails

      SelectableExpression userGroupViewDetails()
      Returns the user group whose members can view the details of the Company Parameter table.
      Returns:
      the userGroupViewDetails column as a String expression
      Since:
      15.3.15 - Southside, 16.1.1 - Black Cat
      See Also:

    • validAfter

      SelectableExpression validAfter()
      Returns the date after which the Company Parameter table can be used.

      When several tables share the same unique name, the logic uses the one with the most recent date that is valid for its target date.

      Returns:
      the validAfter column as a DateOnly expression
      Since:
      16.3.16 - Black Cat, 17.0.7 - Paloma
      See Also: