CommittedScope

Last updated
Save as PDF

pentaho .type .changes. CommittedScope

The CommittedScope class provides a way for a certain region of code to read the committed values of instances.

Extends

pentaho.type.changes.AbstractTransactionScope

Constructor

Name	Description
new CommittedScope()	Creates a `CommittedScope`.

Members

Name	Description
isCurrent : `boolean`	Gets a value that indicates if this scope is the current scope.
isInside : `boolean`	Gets a value that indicates if this scope has not been exited.
transaction : `pentaho.type.changes.Transaction`	Gets the associated transaction, if any, or `null`.

Methods

Name	Description
_assertInsideAndCurrent() Protected	Throws an error if the scope has been exited from or is not the current scope.
dispose()	Exits the scope, without any warnings in case it is not inside or is not the current scope.
exit(keyArgs) : `pentaho.type.changes.AbstractTransactionScope`	Exits the scope.
using(fun, ctx) : `any`	Calls a given function within the scope and safely exits from the scope.

Constructor Details

new CommittedScope()
Creates a `CommittedScope`. Source: javascript/web/pentaho/type/changes/CommittedScope.js, line 36

new CommittedScope()

Creates a CommittedScope.

Source: javascript/web/pentaho/type/changes/CommittedScope.js, line 36

Members Details

isCurrent: `boolean`
Gets a value that indicates if this scope is the current scope. The current scope is the innermost scope. Source: javascript/web/pentaho/type/changes/AbstractTransactionScope.js, line 136 Inherited From: pentaho.type.changes.AbstractTransactionScope#isCurrent

isCurrent: boolean

Gets a value that indicates if this scope is the current scope.

The current scope is the innermost scope.

Source: javascript/web/pentaho/type/changes/AbstractTransactionScope.js, line 136

Inherited From: pentaho.type.changes.AbstractTransactionScope#isCurrent

isInside: `boolean`
Gets a value that indicates if this scope has not been exited. Source: javascript/web/pentaho/type/changes/AbstractTransactionScope.js, line 124 Inherited From: pentaho.type.changes.AbstractTransactionScope#isInside

isInside: boolean

Gets a value that indicates if this scope has not been exited.

Source: javascript/web/pentaho/type/changes/AbstractTransactionScope.js, line 124

Inherited From: pentaho.type.changes.AbstractTransactionScope#isInside

transaction: `pentaho.type.changes.Transaction`
Gets the associated transaction, if any, or `null`. Source: javascript/web/pentaho/type/changes/AbstractTransactionScope.js, line 49 Inherited From: pentaho.type.changes.AbstractTransactionScope#transaction

transaction: pentaho.type.changes.Transaction

Gets the associated transaction, if any, or null.

Source: javascript/web/pentaho/type/changes/AbstractTransactionScope.js, line 49

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

Methods Details

_assertInsideAndCurrent()

Protected

Throws an error if the scope has been exited from or is not the current scope.

Source: javascript/web/pentaho/type/changes/AbstractTransactionScope.js, line 91

Inherited From: pentaho.type.changes.AbstractTransactionScope#_assertInsideAndCurrent

Throws:
Name	Description
`pentaho.lang.OperationInvalidError`	When the scope has been exited from or it is not the current scope.

dispose()
Exits the scope, without any warnings in case it is not inside or is not the current scope. This method is equivalent to calling `exit` with `keyArgs.sloppy` with value `true`. Source: javascript/web/pentaho/type/changes/AbstractTransactionScope.js, line 225 Inherited From: pentaho.type.changes.AbstractTransactionScope#dispose

dispose()

Exits the scope, without any warnings in case it is not inside or is not the current scope.

This method is equivalent to calling exit with keyArgs.sloppy with value true.

Source: javascript/web/pentaho/type/changes/AbstractTransactionScope.js, line 225

Inherited From: pentaho.type.changes.AbstractTransactionScope#dispose

exit(keyArgs) : pentaho.type.changes.AbstractTransactionScope

Exits the scope.

After this operation, the scope cannot be operated on anymore. However, properties like transaction remain available for reading.

If this method is called and the the scope has already been exited from, or is not the current scope, a warning is logged, unless keyArgs.sloppy is true.

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

Inherited From: pentaho.type.changes.AbstractTransactionScope#exit

Name Default Value Summary

keyArgs : Object

Optional

The keyword arguments.

Parameters:
Name	Default Value	Summary
sloppy : `boolean` Optional		Indicates that no warning should be logged if this method is called when the scope has already been exited from or is not the current scope.

Returns:
Name	Description
`pentaho.type.changes.AbstractTransactionScope`	This scope.

using(fun, ctx) : any

Calls a given function within the scope and safely exits from the scope.

Source: javascript/web/pentaho/type/changes/AbstractTransactionScope.js, line 154

Inherited From: pentaho.type.changes.AbstractTransactionScope#using

Parameters:
Name	Default Value	Summary
fun : `function`		The function to call within the scope. The function is called with the `this` context specified in argument `ctx`. The return value of `fun` is returned back from this method.
ctx : `Object` Optional		The `this` context in which to call `fun`. When unspecified, the function will have a `null` this.

Returns:
Name	Description
`any`	The value returned by `fun`.

Throws:
Name	Description
`Error`	Any error thrown from within `fun`.

pentaho.type.changes. CommittedScope

Constructor

Members

Methods

pentaho .type .changes. CommittedScope