Class: ActionResult

new $k.ActionResult()

Methods

activatePanel(panelView, activateopt) → {$k.ActionResult}

Function to set the panel of the given view as activatedResult

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

Parameters:

Name	Type	Attributes	Description
`panelView`	$k.PanelView
`activate`	boolean	<optional>	The panel can be activated or deactivated (default is true=activate)

Since: 5.4.0

Throws:

If the panel cannot be found
Type $k.exception.ObjectNotFound

Returns:

This object

Type:: $k.ActionResult

activatePanelConfiguration(panelConfiguration, activateopt) → {$k.ActionResult}

Function to set the panel of the given view as activatedResult

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

Parameters:

Name	Type	Attributes	Description
`panelConfiguration`	$k.PanelConfiguration
`activate`	boolean	<optional>	The panel can be activated or deactivated (default is true=activate)

Since: 5.4.0

Throws:

If the panel cannot be found
Type $k.exception.ObjectNotFound

Returns:

This object

Type:: $k.ActionResult

element() → {$k.SemanticElement}

Function to get the result element

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

Since: 5.4.0

Returns:

Type:: $k.SemanticElement

model() → {$k.SemanticElement|$k.SemanticElementCollection|$k.HitCollection}

Function to access the model result of the action

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

Since: 5.4.0

Returns:

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

setElement(element) → {$k.ActionResult}

deprecated: Function to set an element as result - use setModel() instead

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

Parameters:

Name	Type	Description
`element`	$k.SemanticElement

Since: 5.4.0
Deprecated: This function is deprecated and might be removed in future releases

Returns:

This object

Type:: $k.ActionResult

setModel(modelopt) → {$k.ActionResult}

Function to set the model as result of the action

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

Parameters:

Name	Type	Attributes	Description
`model`	$k.SemanticElement \| $k.SemanticElementCollection \| $k.HitCollection	<optional>

Since: 5.4.0

Returns:

This object

Type:: $k.ActionResult

setRecomputePanel(recomputePanel) → {$k.ActionResult}

Use this function to allow or suppress recomputation of views on the action panel. By default, recomputation is allowed.

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

Parameters:

Name	Type	Description
`recomputePanel`	boolean

Since: 5.4.0

Returns:

This object

Type:: $k.ActionResult