CMSTransactionScope Class

Transaction scope. Ensures that all queries run within single transaction.

Inheritance Hierarchy

System.Object
  CMS.Base.DisposableObject
    CMS.Helpers.Trackable<CMSTransactionScope>
      CMS.DataEngine.CMSTransactionScope

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 8.2.23

Syntax

public class CMSTransactionScope : Trackable<CMSTransactionScope>, 
	ITransactionScope, IDisposable, INotCopyThreadItem

The CMSTransactionScope type exposes the following members.

Constructors

	Name	Description
Public method	CMSTransactionScope	Constructor. Opens the connection and begins the transaction.

Methods

	Name	Description
Public method	CallOnDispose	Adds the given action to the list of actions called when the handler object is disposed (Inherited from DisposableObject.)
Public method	Commit	Commits the transaction (does the same as Complete).
Public method	CommitAndBeginNew	Commits current transaction and begins new transaction.
Public method Static member	CommitRequestScope	Commits the current transaction scope.
Public method	Complete	Completes the transaction (does the same as Commit).
Public method	Dispose	Disposes the object. (Overrides DisposableObject.Dispose().)
Public method Static member	DisposeRequestScope	Disposes the scope for current request.
Public method Static member	EnsureRequestScope	Ensures the transaction scope for current request.
Public method	Lock	Locks the event on the given lock object. The context stays locked until the handler is disposed. (Inherited from DisposableObject.)
Public method	Using	Adds the given object to the list of the allocated objects to dispose (Inherited from DisposableObject.)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	mCloseConnection	This scope closes the connection.
Protected field	mCommitTransaction	This scope commits the transaction.
Protected field	mConnectionScope	Inner connection scope.
Protected field	mRollbackTransaction	This scope should rollback the transaction in case of errors.
Protected field	mTransactionScope	Transaction scope.
Protected field Static member	mUseTransactionScope	If true, .NET transaction scope is used instead of standard transactions.

Properties

	Name	Description
Public property	Connection	Connection of the current scope.
Public property Static member	IsInTransaction	Returns true if the current code executes in a scope of open transaction
Public property Static member	UseTransactionScope	If true, .NET transaction scope is used instead of standard transactions.