Class: Action

Methods

(static) current() → {$k.Action|undefined}

Returns the current action if set, undefined if not.

Returns:

Type:: $k.Action | undefined

actionType() → {string}

Returns the type of the action (configured or built-in)

Since: 5.2.2

Returns:

Type:: string

addressedElement() → {$k.SemanticElement|undefined}

get the addressed element of the action - usually the same as: receiver().semanticElement()

Since: 5.4.0

Returns:

Type:: $k.SemanticElement | undefined

addressedModel() → {$k.SemanticElement|$k.SemanticElementCollection|$k.HitCollection|any|undefined}

Get the addressed model of the action - usually the same as: receiver().domainModel(), but different e.g. in case of menu actions on table rows

Since: 5.4.0

Returns:

Type:: $k.SemanticElement | $k.SemanticElementCollection | $k.HitCollection | any | undefined

addValidationError(errorMessage)

Add a validation error message

Only supported in the following application environment(s): View-Configuration-Mapper

Parameters:

Name	Type	Description
`errorMessage`	string

Since: 5.4.0
Deprecated: This method is without effect.

configurationElement() → {$k.SemanticElement|undefined}

Get configuration element

Since: 5.2.2

Returns:

Type:: $k.SemanticElement | undefined

dropMarkedAction() → {$k.Action|undefined}

Discard a marked action without execution

Only supported in the following application environment(s): View-Configuration-Mapper

Since: 5.4.0

Returns:

The dropped action

Type:: $k.Action | undefined

getPanelsToActivate() → {Array.<$k.SemanticElement>}

get the panel configurations activated by the action

Only supported in the following application environment(s): View-Configuration-Mapper

Since: 5.4.0

Returns:

Type:: Array.<$k.SemanticElement>

getParameter(parameter) → {any}

Get the value of the given parameter

Parameters:

Name	Type	Description
`parameter`	string

Returns:

Type:: any

getVariable(variable) → {any}

get the value of the given variable

Parameters:

Name	Type	Description
`variable`	string

Returns:

(arrays of) SemanticElements and timestamps are auto-converted to native form

Type:: any

hasValidationErrors() → {boolean}

Returns true if the action has validation errors

Since: 5.3.2

Returns:

Type:: boolean

isFailed() → {boolean}

Returns true if the action is marked as failed

Only supported in the following application environment(s): View-Configuration-Mapper

Since: 5.3.2

Returns:

Type:: boolean

recallingAction() → {$k.Action|undefined}

The action recalling this action

Only supported in the following application environment(s): View-Configuration-Mapper

Since: 5.4.0

Returns:

Type:: $k.Action | undefined

recallMarkedAction() → {$k.ActionResult|undefined}

Activate the recall action marked previously

Only supported in the following application environment(s): View-Configuration-Mapper

Since: 5.4.0

Returns:

Type:: $k.ActionResult | undefined

receiver() → {$k.View}

Get the receiver view of the action

Since: 5.2.0

Returns:

Type:: $k.View

result() → {$k.ActionResult}

Get the action result of the action

Since: 5.4.0

Returns:

Type:: $k.ActionResult

selectedElement() → {$k.SemanticElement|undefined}

Get the selected element of the action - if present

Returns:

Type:: $k.SemanticElement | undefined

session() → {$k.Session}

Get the session of the action

Returns:

Type:: $k.Session

setClosePanel(closePanel)

Specify if the panel shall be closed after the action. Overrides action configuration.

Only supported in the following application environment(s): View-Configuration-Mapper

Parameters:

Name	Type	Description
`closePanel`	boolean

setFailed(failMessage)

Mark the action as failed. The transaction will be aborted and a failure response will be generated.

Only supported in the following application environment(s): View-Configuration-Mapper

Parameters:

Name	Type	Description
`failMessage`	string

setNotification(message, typeopt) → {$k.Action}

Notification function

Only supported in the following application environment(s): View-Configuration-Mapper

Parameters:

Name	Type	Attributes	Description
`message`	string
`type`	string	<optional>

Returns:

Type:: $k.Action

setTransactionCommit(transactionCommit)

Specify if the long running transaction shall be committed after the action. Overrides action configuration.

Only supported in the following application environment(s): View-Configuration-Mapper

Parameters:

Name	Type	Description
`transactionCommit`	boolean

setVariable(variable, value)

set the value of the given variable

Parameters:

Name	Type	Description
`variable`	string
`value`	any	supported variable types include all javascript base types as well as: timestamp, SemanticElement and arrays of the latter