new $k.Action()
Action on a view
Methods
static$k.Action.current()
Returns the current action if set, undefined if not.
actionResponse() : $k.ActionResponse
Get the action response
- Since:
- 5.2.2
Returns:
| Type | Description |
|---|---|
| $k.ActionResponse | returns the action response |
actionType() : string
Returns the type of the action (configured or built-in)
- Since:
- 5.2.2
Returns:
| Type | Description |
|---|---|
| string |
configurationElement() : $k.SemanticElement
Get configuration element
- Since:
- 5.2.2
Returns:
| Type | Description |
|---|---|
| $k.SemanticElement |
getParameter(parameter)
get the value of the given parameter
| Name | Type | Description |
|---|---|---|
parameter |
string |
getVariable(variable)
get the value of the given variable
| Name | Type | Description |
|---|---|---|
variable |
string |
Returns:
(arrays of) SemanticElements and timestamps are auto-converted to native formhasValidationErrors() : boolean
Returns true if the action has validation errors
- Since:
- 5.3.2
Returns:
| Type | Description |
|---|---|
| boolean |
isFailed() : boolean
Returns true if the action is marked as failed
- Since:
- 5.3.2
Returns:
| Type | Description |
|---|---|
| boolean |
receiver()
get the receiver element of the action
selectedElement()
get the selected element of the action - if present
session()
get the session of the action
setClosePanel(closePanel)
Specify if the panel shall be closed after the action. Overrides action configuration.
| Name | Type | Description |
|---|---|---|
closePanel |
boolean |
setFailed(failMessage)
Mark the action as failed. The transaction will be aborted and a failure response will be generated.
| Name | Type | Description |
|---|---|---|
failMessage |
string |
setNotification(jseMessageString, jseTypeString) : $k.ActionResponse
Notification function
| Name | Type | Description |
|---|---|---|
jseMessageString |
string | |
jseTypeString |
string | optional |
Returns:
| Type | Description |
|---|---|
| $k.ActionResponse |
setTransactionCommit(transactionCommit)
Specify if the long running transaction shall be committed after the action. Overrides action configuration.
| Name | Type | Description |
|---|---|---|
transactionCommit |
boolean |
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 |