A2uiExecutionContext
interface A2uiExecutionContext
Provides environment access, dynamic payload evaluation, and function execution capabilities within the scope of a specific component.
Summary
Public functions |
|
|---|---|
Any? |
evaluatePayload(payload: Any?)Evaluates a dynamic payload. |
Any? |
executeFunction(name: String, args: Map<String, Any>)Executes a catalog function by name. |
open A2uiFunctionDefinition? |
getFunctionDefinition(name: String)Returns the definition of a catalog function by name, or null if not found. |
T |
<T : Any> getOrCreateFunctionScopedCache(Gets or creates a component-scoped cache for |
Any? |
resolveValue(path: A2uiDataPath)Resolves a value from the data model at the given path. |
Public properties |
|
|---|---|
A2uiDataPath |
The base data path used to resolve relative paths in this context. |
Public functions
evaluatePayload
fun evaluatePayload(payload: Any?): Any?
Evaluates a dynamic payload.
| Parameters | |
|---|---|
payload: Any? |
payload to evaluate |
| Returns | |
|---|---|
Any? |
evaluated result, or null if evaluation fails |
executeFunction
fun executeFunction(name: String, args: Map<String, Any>): Any?
Executes a catalog function by name.
| Parameters | |
|---|---|
name: String |
name of the function to execute |
args: Map<String, Any> |
arguments to pass to the function |
| Returns | |
|---|---|
Any? |
result of the function execution, or null if execution fails |
getFunctionDefinition
open fun getFunctionDefinition(name: String): A2uiFunctionDefinition?
Returns the definition of a catalog function by name, or null if not found.
| Parameters | |
|---|---|
name: String |
name of the function |
| Returns | |
|---|---|
A2uiFunctionDefinition? |
function definition, or null if the function is not found in the catalog |
getOrCreateFunctionScopedCache
fun <T : Any> getOrCreateFunctionScopedCache(
functionDefinition: A2uiFunctionDefinition,
factory: () -> T
): T
Gets or creates a component-scoped cache for functionDefinition.
Each component and functionDefinition pair gets a separate cache that persists across function invocations and data model updates. Ideal for storing the results of heavy operations that do not rely on data model values (e.g., static metadata, parsed templates, compiled regexes, etc.).
Warning: The cache does not refresh upon data model changes. Caching values that are based on the data model will result in a stale cache.
| Parameters | |
|---|---|
functionDefinition: A2uiFunctionDefinition |
definition identifying the cache |
factory: () -> T |
factory to construct the cache if missing |
| Returns | |
|---|---|
T |
cache instance |
resolveValue
fun resolveValue(path: A2uiDataPath): Any?
Resolves a value from the data model at the given path.
| Parameters | |
|---|---|
path: A2uiDataPath |
data path to resolve |
| Returns | |
|---|---|
Any? |
resolved value, or null if value resolution fails |
Public properties
dataPath
val dataPath: A2uiDataPath
The base data path used to resolve relative paths in this context.