AbstractTransactionScope

Last updated
Save as PDF

pentaho .type .changes. AbstractTransactionScope

The AbstractTransactionScope class is the abstract base class of classes that control the ambient/current transaction.

Constructor

Name	Description
new AbstractTransactionScope(context, transaction)	Creates a `CommittedScope`.

Members

Name	Description
context : `pentaho.type.Context`	Gets the associated context.
isCurrent : `boolean`	Gets a value that indicates if this scope is the current scope of its context.
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 AbstractTransactionScope(context, transaction)

Creates a CommittedScope.

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

Parameters:
Name	Default Value	Summary
context : `pentaho.type.Context`		The associated context.
transaction : `pentaho.type.changes.Transaction` Optional		The associated transaction.

Throws:
Name	Description
`pentaho.lang.OperationInvalidError`	When the specified transaction is resolved.
`pentaho.type.changes.TransactionRejectedError`	When this is the root scope of the specified transaction and the transaction is automatically rejected due to a concurrency error.

Members Details

context: `pentaho.type.Context`
Gets the associated context. Source: javascript/web/pentaho/type/changes/AbstractTransactionScope.js, line 51

context: pentaho.type.Context

Gets the associated context.

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

isCurrent: `boolean`
Gets a value that indicates if this scope is the current scope of its context. A context's current scope is its innermost scope. Source: javascript/web/pentaho/type/changes/AbstractTransactionScope.js, line 148

isCurrent: boolean

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

A context's current scope is its innermost scope.

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

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

isInside: boolean

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

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

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

transaction: pentaho.type.changes.Transaction

Gets the associated transaction, if any, or null.

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

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 103

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

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 238

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 238

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

Exits the scope.

After this operation, the scope cannot be operated on anymore. However, properties like context and 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 194

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 166

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. AbstractTransactionScope

Constructor

Members

Methods

pentaho .type .changes. AbstractTransactionScope