Base
pentaho.type.action. Base
The action.Base
class represents a certain model of actions.
It is expected that the associated type class is used to configure metadata information about actions. Metadata properties such as label
, description
and styleClass
can be used in graphical user interfaces to offer the action to the user.
Synchronous or Asynchronous
An action can be synchronous or asynchronous, as determined by the type property, pentaho.type.action.BaseType#isSync
. The execution of a synchronous action is completed synchronously, while that of an asynchronous action only completes asynchronously.
Execution
Actions are executed at and by target objects, which implement the interface ITarget
, by being passed as the argument to the ITarget#act
method.
Targets control the exact implementation of the execution of an action, which is returned from the act
method, in the form of an Execution
. However, it is the action that imposes whether execution is synchronous or not, and the phases by which execution goes through, which are, for all action types:
- "init" - the execution is being initialized and a chance is given to mutate the action and change what will be done;
- "will" - action is now frozen and the action can be canceled based on what wil be done;
- "do" - the action is executed;
- "finally" - the action execution has finished successfuly or not.
For more information, see Execution
.
AMD Module
require(["pentaho/type/action/Base"], function(Base) { /* code goes here */ });
See also: pentaho.type.action.spec.IBase , pentaho.type.action.spec.IBaseType
Extends
Constructor
Name | Description |
---|---|
new Base(spec) Abstract | Creates an action instance given its specification. |
Members
Name | Description |
---|---|
$isValid : | Determines if this value is a valid. |
$key : | Gets the key of the value. |
$type : | Gets the type of this instance. |
description : | Gets or sets the description of this action. |
label : | Gets or sets the label of this action. |
Methods
Name | Description |
---|---|
_compare(other) : number Protected | Compares this element to a distinct, non-equal element of the same type according to its relative order. |
_configure(config) Protected | Configures this value with a given distinct and non- |
_configureOrCreate(config) : pentaho.type.Element Protected | Configures this value with a given distinct and non- |
_equals(other) : boolean Protected | Gets a value that indicates if a given distinct, non-null value of the same type represents the same entity. |
_init(spec) Protected | Initializes an action instance given its specification. |
assertValid() | Ensures that the value is valid, and throws the first validation error if it is not. |
clone() : pentaho.type.Value | Creates a shallow clone of this value. |
compare(other) : number | Compares this element to another according to its relative order. |
configure(config) | Configures this value with a given configuration. |
configureOrCreate(config) : pentaho.type.Element | Configures this value with a given configuration, if it is possible. Otherwise creates and returns a new value based on this one, but with the configuration applied. |
equals(other) : boolean | Determines if a given value represents the same entity. |
equalsContent(other) : boolean | Gets a value that indicates if a given equal value has the same content as this one. |
toJSON() : JsonValue | Creates a top-level JSON specification that describes this instance. |
toSpec(keyArgs) : pentaho.type.spec.Instance | Creates a specification that describes this value. |
toSpecInContext(keyArgs) : any | Creates a specification that describes this instance. |
validate() : Array.< | Determines if this value is valid. |
Constructor Details
new Base(spec) Abstract | ||||||
---|---|---|---|---|---|---|
Creates an action instance given its specification. Source: javascript/web/pentaho/type/action/Base.js, line 145
See also: pentaho.type.action.spec.IBase , pentaho.type.action.spec.IBaseType |
Members Details
$isValid: |
---|
Determines if this value is a valid. This attribute calls Source: javascript/web/pentaho/type/Value.js, line 168 Inherited From: pentaho.type.Value#$isValid |
$key: |
---|
Gets the key of the value. The key of a value must identify it among values of the same concrete type. Two values of the same concrete type and with the same key represent the same entity. If two values have the same concrete type and their keys are equal, then it must also be the case that The default implementation returns the result of calling Source: javascript/web/pentaho/type/Value.js, line 89 Inherited From: pentaho.type.Value#$key See also: pentaho.type.Value#equals |
$type: |
---|
Gets the type of this instance. Source: javascript/web/pentaho/type/Value.js, line 334 Overrides: pentaho.type.Element#$type |
description: |
---|
Gets or sets the description of this action. When not set to a non-empty local value, the description of the action type, Source: javascript/web/pentaho/type/action/Base.js, line 205 |
label: |
---|
Gets or sets the label of this action. When not set to a non-empty local value, the label of the action type, Source: javascript/web/pentaho/type/action/Base.js, line 189 |
Methods Details
_compare(other) : number Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Compares this element to a distinct, non-equal element of the same type according to its relative order. The default implementation does a lexicographical comparison of the elements' Source: javascript/web/pentaho/type/Element.js, line 105 Inherited From: pentaho.type.Element#_compare
See also: pentaho.type.Element#compare , pentaho.type.Value#equals |
_configure(config) Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Configures this value with a given distinct and non- This method can only be called when there is an ambient transaction. The default implementation throws an error if this value's type is Source: javascript/web/pentaho/type/Value.js, line 264 Inherited From: pentaho.type.Value#_configure
See also: pentaho.type.Value#configure , pentaho.type.Complex#_configure , pentaho.type.List#_configure |
_configureOrCreate(config) : pentaho.type.Element Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Configures this value with a given distinct and non- This method can only be called when there is an ambient transaction. Source: javascript/web/pentaho/type/Element.js, line 175 Inherited From: pentaho.type.Element#_configureOrCreate
See also: pentaho.type.Element#configureOrCreate , pentaho.type.Value#configure |
_equals(other) : boolean Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates if a given distinct, non-null value of the same type represents the same entity. The default implementation considers two values equal if they have the equal keys. Source: javascript/web/pentaho/type/Value.js, line 135 Inherited From: pentaho.type.Value#_equals
See also: pentaho.type.Value#equals , pentaho.type.Value#$key |
_init(spec) Protected | ||||||
---|---|---|---|---|---|---|
Initializes an action instance given its specification. Source: javascript/web/pentaho/type/action/Base.js, line 172
|
assertValid() | ||||
---|---|---|---|---|
Ensures that the value is valid, and throws the first validation error if it is not. This method calls the Source: javascript/web/pentaho/type/Value.js, line 202 Inherited From: pentaho.type.Value#assertValid
|
clone() : pentaho.type.Value | ||||
---|---|---|---|---|
Creates a shallow clone of this value. Source: javascript/web/pentaho/type/Value.js, line 93 Overrides: pentaho.type.Element#clone
|
compare(other) : number | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Compares this element to another according to its relative order. Execution proceeds as follows:
Source: javascript/web/pentaho/type/Element.js, line 76 Inherited From: pentaho.type.Element#compare
See also: pentaho.type.Element#_compare , pentaho.type.Value#equals |
configure(config) | ||
---|---|---|
Configures this value with a given configuration. This method ensures a transaction exists and then delegates to For more information on the semantics of configuration, see Source: javascript/web/pentaho/type/Value.js, line 232 Inherited From: pentaho.type.Value#configure |
Name | Default Value | Summary |
---|---|---|
config : any | The value configuration. |
Name | Description |
---|---|
TypeError | When the value would be changed and its type is |
See also: pentaho.type.Element#configureOrCreate , pentaho.type.Complex#_configure , pentaho.type.List#_configure
configureOrCreate(config) : pentaho.type.Element | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Configures this value with a given configuration, if it is possible. Otherwise creates and returns a new value based on this one, but with the configuration applied. If the given configuration is This method considers configuration to not be possible in the following situations:
If configuration is considered possible, the actual configuration is delegated to the Source: javascript/web/pentaho/type/Element.js, line 141 Inherited From: pentaho.type.Element#configureOrCreate
|
equals(other) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Determines if a given value represents the same entity. This method checks if the given value is identical to this one. Otherwise, if not Source: javascript/web/pentaho/type/Value.js, line 116 Inherited From: pentaho.type.Value#equals
See also: pentaho.type.Value#_equals |
equalsContent(other) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates if a given equal value has the same content as this one. This method must only be called if the The default implementation returns Source: javascript/web/pentaho/type/Value.js, line 152 Inherited From: pentaho.type.Value#equalsContent
See also: pentaho.type.Value#equals |
toJSON() : JsonValue | ||||
---|---|---|---|---|
Creates a top-level JSON specification that describes this instance. Attributes which do not have a JSON-compatible specification are omitted. Specifically, for inline types, attributes with a function value are not supported. This method simply calls Source: javascript/web/pentaho/type/Instance.js, line 197 Inherited From: pentaho.type.Instance#toJSON
See also: pentaho.type.Instance#toSpec |
toSpec(keyArgs) : pentaho.type.spec.Instance | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Creates a specification that describes this value. If an Source: javascript/web/pentaho/type/Value.js, line 272 Inherited From: pentaho.type.Value#toSpec |
Name | Default Value | Summary | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
keyArgs : Object Optional | The keyword arguments object. Passed to every value and type serialized within this scope. Please see the documentation of value subclasses for information on additional, supported keyword arguments.
|
Name | Description |
---|---|
pentaho.type.spec.Instance | A specification of this value. |
toSpecInContext(keyArgs) : any | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates a specification that describes this instance. Source: javascript/web/pentaho/type/Instance.js, line 177 Overrides: pentaho.type.Element#toSpecInContext
See also: pentaho.type.Instance#toSpec |
validate() : Array.< | ||||
---|---|---|---|---|
Determines if this value is valid. The default implementation does nothing and considers the instance valid. Override to implement a type's specific validation logic. You can use the error utilities in Source: javascript/web/pentaho/type/Value.js, line 187 Inherited From: pentaho.type.Value#validate
See also: pentaho.type.Value#$isValid |