Skip to main content

Pentaho+ documentation is moving!

The new product documentation portal is here. Check it out now at docs.hitachivantara.com

 

Hitachi Vantara Lumada and Pentaho Documentation

Generic

pentaho.action Generic

The action.Generic class represents a generic model of actions.

AMD Module

require(["pentaho/action/Generic"], function(Generic) { /* code goes here */ });

See also: pentaho.action.spec.IGeneric

Extends

Constructor

Name Description
new Generic(spec)
Abstract

Creates an action instance given its specification.

Members

Name Description
base :  function
Protected

If a method has been overridden, then the base method provides access to the overridden method.

eventName :  string

Gets the event name of the action.

Methods

Name Description
_fillSpec(spec)
Protected

Fills the given specification with this action's attributes' local values, and returns whether any attribute was actually added.

_init(spec)
Protected

Initializes an action instance given its specification.

clone() : pentaho.action.Base

Creates a shallow clone of this action.

extend(source, keyArgs) : object

Extend an object with the properties of another.

toSpec() : pentaho.action.spec.IGeneric

Creates a specification that describes this action.

validate() : Array.<pentaho.lang.UserError>

Determines if the given action is valid.

Constructor Details

new Generic(spec)
Abstract

Creates an action instance given its specification.

Source: javascript/web/pentaho/action/Generic.js, line 43

Parameters:
Name Default Value Summary
spec : pentaho.action.spec.IGeneric
Optional

A generic action specification.

See also: pentaho.action.spec.IGeneric

Members Details

base:  function
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

eventName:  string

Gets the event name of the action.

The default implementation returns the value of pentaho.action.Base.id.

Source: javascript/web/pentaho/action/Base.js, line 82

Inherited From: pentaho.action.Base#eventName

Methods Details

_fillSpec(spec)
Protected

Fills the given specification with this action's attributes' local values, and returns whether any attribute was actually added.

Source: javascript/web/pentaho/action/Generic.js, line 83

Parameters:
Name Default Value Summary
spec : pentaho.action.spec.IGeneric
Optional

A generic action specification.

_init(spec)
Protected

Initializes an action instance given its specification.

Source: javascript/web/pentaho/action/Generic.js, line 54

Parameters:
Name Default Value Summary
spec : pentaho.action.spec.IGeneric
Optional

A generic action specification.

clone() : pentaho.action.Base

Creates a shallow clone of this action.

Source: javascript/web/pentaho/action/Base.js, line 103

Overrides: pentaho.action.Base#clone

Returns:
Name Description
pentaho.action.Base

The action clone.

extend(source, keyArgs) : object

Extend an object with the properties of another.

Methods that are overridden are accessible through this.base.

This object is extended, but its class doesn't change.

Source: javascript/web/pentaho/lang/Base.js, line 1040

Inherited From: pentaho.lang.Base#extend

Parameters:
Name Default Value Summary
source : object

The instance specification.

keyArgs : object
Optional

The keyword arguments.

Parameters:
Name Default Value Summary
exclude : object
Optional

A map of property names to exclude from source.

Returns:
Name Description
object

This object.

toSpec() : pentaho.action.spec.IGeneric

Creates a specification that describes this action.

Source: javascript/web/pentaho/action/Generic.js, line 67

Returns:
Name Description
pentaho.action.spec.IGeneric

A generic action specification.

validate() : Array.<pentaho.lang.UserError>

Determines if the given action is valid.

The default implementation does nothing and considers the instance valid. Override to implement an action's specific validation logic.

Source: javascript/web/pentaho/action/Base.js, line 94

Inherited From: pentaho.action.Base#validate

Returns:
Name Description
Array.<pentaho.lang.UserError> | null

A non-empty array of errors or null.