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

PrimitiveChange

pentaho.type.action. PrimitiveChange

The PrimitiveChange class is the abstract base class of changes that are the direct consequence of performing primitive operations on a structured value.

Primitive changes always exist in the context of a Changeset.

Example primitive changes are the Replace operation on a Complex value, and the Add and Clear operations on a List value.

AMD Module

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

Extends

Constructor

Name Description
new PrimitiveChange()
Abstract

Creates a PrimitiveChange instance.

Members

Name Description
eventName : string

Gets the event name of the action.

transactionVersion

Methods

Name Description
_cancel(changeset)
Protected

Unregisters reference changes caused by this change.

_prepare(changeset)
Protected

Registers reference changes caused by this change.

_setTransactionVersion(txnVersion)
Protected

Sets the new transaction version of this change.

clone() : pentaho.action.Base

Creates a shallow clone of this action.

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

Determines if the given action is valid.

Constructor Details

new PrimitiveChange()
Abstract

Creates a PrimitiveChange instance.

Source: javascript/web/pentaho/type/action/PrimitiveChange.js, line 25

Members Details

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

transactionVersion:

Source: javascript/web/pentaho/type/action/PrimitiveChange.js, line 49

Methods Details

_cancel(changeset)
Protected

Unregisters reference changes caused by this change.

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

Parameters:
Name Default Value Summary
changeset : pentaho.type.action.Changeset

The changeset.

_prepare(changeset)
Protected

Registers reference changes caused by this change.

Source: javascript/web/pentaho/type/action/PrimitiveChange.js, line 72

Parameters:
Name Default Value Summary
changeset : pentaho.type.action.Changeset

The changeset.

_setTransactionVersion(txnVersion)
Protected

Sets the new transaction version of this change.

Source: javascript/web/pentaho/type/action/PrimitiveChange.js, line 60

Parameters:
Name Default Value Summary
txnVersion : number

The transaction version.

clone() : pentaho.action.Base

Creates a shallow clone of this action.

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

Inherited From: pentaho.action.Base#clone

Returns:
Name Description
pentaho.action.Base

The action clone.

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.