Skip to main content
Hitachi Vantara Lumada and Pentaho Documentation

Replace

pentaho.type.action Replace

The Replace class describes the primitive operation that replaces the value of an element property of a complex instance.

This type of change is always part of a pentaho.type.action.ComplexChangeset.

AMD Module

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

Extends

Constructor

Name Description
new Replace(propType, valueNew, stateNew)

Creates an instance.

Members

Name Description
id
Static
eventName
property :  pentaho.type.PropertyType

Gets the property whose value is replaced.

state :  number

Gets the state that will replace the current state of the property.

transactionVersion
type :  string

Gets the type of change.

value :  pentaho.type.Element

Gets the value that will replace the current value of the property.

Methods

Name Description
_apply()
_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.

Constructor Details

new Replace(propType, valueNew, stateNew)

Creates an instance.

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

Parameters:
Name Default Value Summary
propType : pentaho.type.PropertyType

The property type.

valueNew : pentaho.type.Element

The proposed value of the property.

stateNew : number

The proposed state of the property.

Members Details

id:
Static

Source: javascript/web/pentaho/type/action/Replace.js, line 154

eventName:

Source: javascript/web/pentaho/type/action/Change.js, line 40

Inherited From: pentaho.type.action.Change#eventName

property:  pentaho.type.PropertyType

Gets the property whose value is replaced.

Source: javascript/web/pentaho/type/action/Replace.js, line 50

state:  number

Gets the state that will replace the current state of the property.

Source: javascript/web/pentaho/type/action/Replace.js, line 142

transactionVersion:

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

Inherited From: pentaho.type.action.PrimitiveChange#transactionVersion

type:  string

Gets the type of change.

Source: javascript/web/pentaho/type/action/Replace.js, line 122

Default Value: "replace"

See also: pentaho.type.action.Change#type

value:  pentaho.type.Element

Gets the value that will replace the current value of the property.

Source: javascript/web/pentaho/type/action/Replace.js, line 132

Methods Details

_apply()

Source: javascript/web/pentaho/type/action/Replace.js, line 147

_cancel(changeset)
Protected

Unregisters reference changes caused by this change.

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

Overrides: pentaho.type.action.PrimitiveChange#_cancel

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

Overrides: pentaho.type.action.PrimitiveChange#_prepare

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

Inherited From: pentaho.type.action.PrimitiveChange#_setTransactionVersion

Parameters:
Name Default Value Summary
txnVersion : number

The transaction version.