$k. ActionResult

new 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:
NameTypeAttributesDescription
panelView$k.PanelView
activateboolean<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:
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:
NameTypeAttributesDescription
panelConfiguration$k.PanelConfiguration
activateboolean<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:
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() → {object}

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:

SemanticElement or TopicCollection

Type: 
object

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:
NameTypeDescription
element$k.SemanticElement
Since
  • 5.4.0
Deprecated
  • This function is deprecated and might be removed in future releases
Returns:
Type: 
$k.ActionResult

setModel(model) → {$k.ActionResult}

Function to set the model as result of the action

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

Parameters:
NameTypeDescription
modelobject

SemanticElement or SemanticElementCollection

Since
  • 5.4.0
Returns:
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:
NameTypeDescription
recomputePanelboolean
Since
  • 5.4.0
Returns:
Type: 
$k.ActionResult