Skip to main content
Pentaho Documentation

ListChangeset

pentaho.type.changes.ListChangeset

The class ListChangeset describes a log of changes in a list value.

AMD Module

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

Extends

Constructor

Name Description
new ListChangeset(transaction, owner)

Creates a new instance.

Members

Name Description
base : function
 
Protected

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

changes : Array.<pentaho.type.change.PrimitiveChange>

Gets the list of contained primitive changes.

hasChanges : boolean

Gets a value that indicates if this changeset contains any changes, whether they are primitive or in contained changesets.

isReadOnly : boolean

Gets a value that indicates if the changeset is in a read-only state and can no longer be modified.

owner : pentaho.type.List

Gets the list value where the changes take place.

ownerVersion : number

Gets the version of the owner at the time when the changeset was created.

transaction : pentaho.type.changes.Transaction

Gets the owning transaction.

type : string

Gets the type of change.

Methods

Name Description
_apply(target)
 
Protected

Applies any local primitive changes.

_assertWritable()
 
Protected

Throws an error if the changeset is read-only.

_clearChanges()
 
Protected

Actually removes all changes in the changeset.

clearChanges()

Removes all changes from this changeset.

extend(source, keyArgs) : Object

Extend an object with the properties of another.

getChange(key) : pentaho.type.changes.ComplexChangeset

Gets the nested changeset for an element with the given key, if any.

Constructor Details

new ListChangeset(transaction, owner)

Creates a new instance.

Source: javascript/web/pentaho/type/changes/ListChangeset.js, line 29

Parameters:
Name Default Value Summary
transaction : pentaho.type.changes.Transaction

The owning transaction.

owner : pentaho.type.List

The list value where the changes take place.

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 265

Inherited From: pentaho.lang.Base#base

changes: Array.<pentaho.type.change.PrimitiveChange>

Gets the list of contained primitive changes.

The returned array should not be modified.

Source: javascript/web/pentaho/type/changes/ListChangeset.js, line 83

hasChanges: boolean

Gets a value that indicates if this changeset contains any changes, whether they are primitive or in contained changesets.

Source: javascript/web/pentaho/type/changes/Changeset.js, line 151

Overrides: pentaho.type.changes.Changeset#hasChanges

isReadOnly: boolean

Gets a value that indicates if the changeset is in a read-only state and can no longer be modified.

Source: javascript/web/pentaho/type/changes/Changeset.js, line 127

Inherited From: pentaho.type.changes.Changeset#isReadOnly

owner: pentaho.type.List

Gets the list value where the changes take place.

Source: javascript/web/pentaho/type/changes/ListChangeset.js, line 56

Overrides: pentaho.type.changes.Changeset#owner

ownerVersion: number

Gets the version of the owner at the time when the changeset was created.

Source: javascript/web/pentaho/type/changes/Changeset.js, line 147

Inherited From: pentaho.type.changes.Changeset#ownerVersion

transaction: pentaho.type.changes.Transaction

Gets the owning transaction.

Source: javascript/web/pentaho/type/changes/Changeset.js, line 51

Inherited From: pentaho.type.changes.Changeset#transaction

type: string

Gets the type of change.

Source: javascript/web/pentaho/type/changes/ListChangeset.js, line 71

Default Value: "list"

Overrides: pentaho.type.changes.Changeset#type

Methods Details

_apply(target)
 
Protected

Applies any local primitive changes.

Source: javascript/web/pentaho/type/changes/Change.js, line 50

Overrides: pentaho.type.changes.Changeset#_apply

Parameters:
Name Default Value Summary
target : pentaho.type.ContainerMixin

The container to which changes are applied.

_assertWritable()
 
Protected

Throws an error if the changeset is read-only.

Source: javascript/web/pentaho/type/changes/Changeset.js, line 116

Inherited From: pentaho.type.changes.Changeset#_assertWritable

Throws:
Name Description
pentaho.lang.OperationInvalidError

When the changeset has been marked read-only.

_clearChanges()
 
Protected

Actually removes all changes in the changeset.

Source: javascript/web/pentaho/type/changes/Changeset.js, line 181

Overrides: pentaho.type.changes.Changeset#_clearChanges

See also:  pentaho.type.changes.Changeset#clearChanges

clearChanges()

Removes all changes from this changeset.

Primitive changes are removed, while contained changesets are cleared.

This method validates that the changeset is in a valid state and then delegates actual work to the _clearChanges method.

Source: javascript/web/pentaho/type/changes/Changeset.js, line 174

Inherited From: pentaho.type.changes.Changeset#clearChanges

Throws:
Name Description
pentaho.lang.OperationInvalidError

When the changeset or any of its contained changesets have been marked read-only.

See also:  pentaho.type.changes.Changeset#_clearChanges

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.

Can be applied to non-Base instances (e.g. using Base.prototype.extend.call(alien, {a: "hello"})).

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

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.

getChange(key) : pentaho.type.changes.ComplexChangeset

Gets the nested changeset for an element with the given key, if any.

Source: javascript/web/pentaho/type/changes/ListChangeset.js, line 108

Parameters:
Name Default Value Summary
key : string

The key of the element.

Returns:
Name Description
pentaho.type.changes.ComplexChangeset

The nested changeset or null.