new Session()
Session for visualizing/editing views
Methods
(static) actual() → {$k.Session}
Returns the actual session if set, undefined if not. The actual session may differ from initial session in render phase
Only supported in the following application environment(s): View-Configuration-Mapper
- Since
- 5.3.2
- Type:
- $k.Session
(static) current() → {$k.Session}
Returns the current session if set, undefined if not. The current session does not change throughout action execution and result rendering
Only supported in the following application environment(s): View-Configuration-Mapper
- Since
- 5.3.0
- Deprecated
- Deprecated because of confusing/misleading naming. Use initial() instead.
- Type:
- $k.Session
(static) forPanel(panelName) → {$k.Session}
Returns the session corresponding to the given panel if available, undefined if not. Searches starting from the current session.
Only supported in the following application environment(s): View-Configuration-Mapper
| Name | Type | Description |
|---|---|---|
panelName | string | The configuration name of the panel |
- Version
- Experimental feature, might be removed at any time
- Type:
- $k.Session
(static) initial() → {$k.Session}
Returns the top session on the session stack as found initially at the beginning of the execution of an action. The initial session does not change throughout action execution and result rendering.
Only supported in the following application environment(s): View-Configuration-Mapper
- Since
- 5.3.2
- Type:
- $k.Session
(static) main() → {$k.Session}
Returns the main session if set, undefined if not.
Only supported in the following application environment(s): View-Configuration-Mapper
- Type:
- $k.Session
(static) upcoming() → {$k.Session}
Returns the upcoming session. The upcoming session will be the session used as soon as the session stack grows - e.g. when opening a dialog.
Only supported in the following application environment(s): View-Configuration-Mapper
- Since
- 5.4.0
- Type:
- $k.Session
abort()
Abort the (long running) session transaction.
Only supported in the following application environment(s): View-Configuration-Mapper
element() → {$k.SemanticElement}
get the domain model element of the session
Only supported in the following application environment(s): View-Configuration-Mapper
- Type:
- $k.SemanticElement
flushViewDefaults()
Forget remembered view states for restoration of last used values.
Only supported in the following application environment(s): View-Configuration-Mapper
getVariable(variable)
get the value of the given variable
| Name | Type | Description |
|---|---|---|
variable | string |
(arrays of) SemanticElements and timestamps are auto-converted to native form
onCloseActivate(panelConfiguration, modelopt)
When a session is closed, the given panel shall be refreshed activated
Only supported in the following application environment(s): View-Configuration-Mapper
| Name | Type | Attributes | Description |
|---|---|---|---|
panelConfiguration | $k.PanelConfiguration | The panel to be activated. | |
model | object | <optional> | Optional model to be used for activation (SemanticElement or SemanticElementCollection). If no model is specified, the action result model is used. |
onCommitActivate(panelConfiguration, modelopt)
When a session transaction is commited and the session is closed, the given panel shall be activated.
Only supported in the following application environment(s): View-Configuration-Mapper
| Name | Type | Attributes | Description |
|---|---|---|---|
panelConfiguration | $k.PanelConfiguration | The panel to be activated. | |
model | object | <optional> | Optional model to be used for activation (SemanticElement or SemanticElementCollection). If no model is specified, the action result model is used. |
onCommitRefresh(panelConfiguration)
When a session transaction is commited and the session is closed, the given panel shall be refreshed.
Only supported in the following application environment(s): View-Configuration-Mapper
| Name | Type | Description |
|---|---|---|
panelConfiguration | $k.PanelConfiguration | The panel to be refreshed. |
panelConfiguration() → {$k.SemanticElement}
Returns the panel configuration topic.
Only supported in the following application environment(s): View-Configuration-Mapper
- Since
- 5.3.2
- Type:
- $k.SemanticElement
parent() → {$k.Session}
get the parent session of the session, undefined if it has no parent
Only supported in the following application environment(s): View-Configuration-Mapper
- Type:
- $k.Session
setVariable(variable, value)
set the value of the given variable
| Name | Type | Description |
|---|---|---|
variable | string | |
value | supported variable types include all javascript base types as well as: timestamp, SemanticElement and arrays of the latter |