ActionResult
pentaho.lang. ActionResult
An ActionResult
represents the result from performing an action.
ActionResult
Value
When successful, an action can return a value that represents its final state or undefined
. For example, if you do a Google search using an executeAction
, there is no value to be returned.
ActionResult
Error
When an action is unsuccessful, it will return an error or a string with the reason why it was rejected. This can happen when an event is canceled, or the core components of that action were invalid.
If unsuccessful, the value is always undefined
.
AMD Module
require(["pentaho/lang/ActionResult"], function(ActionResult) { /* code goes here */ });
See also: pentaho.visual.base.model#executeAction , pentaho.visual.base.model#selectAction
Extends
Constructor
Name | Description |
---|---|
new ActionResult() |
Classes
Name | Summary |
---|---|
constructor |
Members
Name | Description |
---|---|
base : Protected | If a method has been overridden, then the base method provides access to the overridden method. |
error : | Gets the error of the |
isCanceled : | Gets a value indicating if the |
isFailed : | Gets a value indicating if the |
isFulfilled : | Gets a value indicating if the |
isRejected : | Gets a value indicating if the |
value : | Gets the value of the |
Methods
Name | Description |
---|---|
fulfill(value) : pentaho.lang.ActionResult Static | Creates an action result that represents a successful action. |
reject(error) : pentaho.lang.ActionResult Static | Creates an action result that represents an unsuccessful action. |
extend(source, keyArgs) : Object | Extend an object with the properties of another. |
Constructor Details
new ActionResult() |
---|
Source: javascript/web/pentaho/lang/ActionResult.js, line 24 See also: pentaho.visual.base.model#executeAction , pentaho.visual.base.model#selectAction |
Members Details
base: Protected |
---|
If a method has been overridden, then the base method provides access to the overridden method. Can also be called from within a constructor function. Source: javascript/web/pentaho/lang/Base.js, line 299 Inherited From: pentaho.lang.Base#base |
error: |
---|
Gets the error of the Source: javascript/web/pentaho/lang/ActionResult.js, line 93 |
isCanceled: |
---|
Gets a value indicating if the Source: javascript/web/pentaho/lang/ActionResult.js, line 103 |
isFailed: |
---|
Gets a value indicating if the Source: javascript/web/pentaho/lang/ActionResult.js, line 114 |
isFulfilled: |
---|
Gets a value indicating if the Source: javascript/web/pentaho/lang/ActionResult.js, line 125 |
isRejected: |
---|
Gets a value indicating if the Source: javascript/web/pentaho/lang/ActionResult.js, line 135 |
value: |
---|
Gets the value of the Source: javascript/web/pentaho/lang/ActionResult.js, line 83 |
Methods Details
fulfill(value) : pentaho.lang.ActionResult Static | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates an action result that represents a successful action. Source: javascript/web/pentaho/lang/ActionResult.js, line 146
|
reject(error) : pentaho.lang.ActionResult Static | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates an action result that represents an unsuccessful action. Source: javascript/web/pentaho/lang/ActionResult.js, line 157
|
extend(source, keyArgs) : Object | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Extend an object with the properties of another. Methods that are overridden are accessible through This object is extended, but its class doesn't change. Source: javascript/web/pentaho/lang/Base.js, line 1037 Inherited From: pentaho.lang.Base#extend
|