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

Interface OutputsColumns.OutputColumns

All Superinterfaces:

Map<String,SelectableExpression>, Tables.Columns

All Known Subinterfaces:

ClicColumns.OutputColumns

Enclosing interface:

OutputsColumns

public static interface OutputsColumns.OutputColumns
extends Tables.Columns

The columns of one output of a row, as returned by OutputsColumns.output(String).

It is also a map of column name to column, so the columns can be accessed as properties, for example t.output("Price").result.

Since:

15.0.6 - Southside

Nested Class Summary

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method	Description
SelectableExpression	isOverridden()	Returns whether a user overrode the result of the logic element manually.
SelectableExpression	result()	Returns the result of the logic element.
SelectableExpression	userGroup()	Returns the user group set on the logic element, which restricts which users can see its result.

Methods inherited from interface Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Details

result

SelectableExpression result()

Returns the result of the logic element.

The value is always returned as text: numbers are converted to their string representation, and structured values such as maps or lists are returned as JSON. Use castAsReal(), castAsInteger() or a similar cast to compare the result with a number. Unless you set an alias with as(), the result column is named after the output, for example Price_result.

Returns:

the result column as a String expression (this string may contain json serialized data)

See Also:

• isOverridden()

isOverridden

SelectableExpression isOverridden()

Returns whether a user overrode the result of the logic element manually.

Example:

 def q = api.queryApi()
 def t = q.tables().quoteLineItems("P-1168")
 def price = t.output("Price")

 return q.source(t, [t.lineId(), price.result().as("Price")], price.isOverridden().isTrue())
         .stream { it.collect { it } }
 

Returns:

the isOverridden column as a Boolean expression

userGroup

SelectableExpression userGroup()

Returns the user group set on the logic element, which restricts which users can see its result.

Returns:

the userGroup column as a String expression