Skip to main content
Pentaho Documentation

Changeset

pentaho.type.changes.Changeset

The Changeset class describes a set of changes occurring in a structured value, the owner value.

A changeset is a container for a set of PrimitiveChange instances.

AMD Module

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

Extends

Constructor

Name Description
new Changeset(transaction, owner)
 
Abstract

Creates an empty Changeset for a given owner value.

Members

Name Description
base : function
 
Protected

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

hasChanges : boolean
 
Abstract

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.mixins.Container

Gets the container 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
 
Abstract

Gets the type of change.

Methods

Name Description
_apply(target)
 
Abstract
 
Protected

Applies any local primitive changes.

_assertWritable()
 
Protected

Throws an error if the changeset is read-only.

_clearChanges()
 
Abstract
 
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.

Constructor Details

new Changeset(transaction, owner)
 
Abstract

Creates an empty Changeset for a given owner value.

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

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

The owning transaction.

owner : pentaho.type.UContainer

The container instance 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 299

Inherited From: pentaho.lang.Base#base

hasChanges: boolean
 
Abstract

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 161

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 136

owner: pentaho.type.mixins.Container

Gets the container where the changes take place.

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

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 157

transaction: pentaho.type.changes.Transaction

Gets the owning transaction.

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

type: string
 
Abstract

Gets the type of change.

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

Inherited From: pentaho.type.changes.Change#type

Methods Details

_apply(target)
 
Abstract
 
Protected

Applies any local primitive changes.

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

Inherited From: pentaho.type.changes.Change#_apply

Parameters:
Name Default Value Summary
target : pentaho.type.mixins.Container

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 125

Throws:
Name Description
pentaho.lang.OperationInvalidError

When the changeset has been marked read-only.

_clearChanges()
 
Abstract
 
Protected

Actually removes all changes in the changeset.

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

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 184

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.

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

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.