FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoIFreezeLongTransaction Class Reference

#include <IFreezeLongTransaction.h>

Inherits FdoICommand.

Inheritance diagram for FdoIFreezeLongTransaction:

[legend]
List of all members.

Detailed Description

The FdoIFreezeLongTransaction interface defines the FreezeLongTransaction command, which freezes or thaws a long transaction. When a long transaction is frozen the user who froze it gains exclusive access to it. Other users can read it, but not apply any updates. Input to the FreezeLongTransaction command is the long transaction name and the operation to perform. The Execute method performs the specified operation on the identified long transaction if the user has access privileges for the indicated long transaction.

Definition at line 39 of file IFreezeLongTransaction.h.


Public Member Functions

virtual FDO_API void Execute ()=0
 Executes the command.
virtual FDO_API FdoStringGetName ()=0
 Gets the name of the long transaction to freeze or unfreeze as a string.
virtual FDO_API FdoLongTransactionFreezeOperations GetOperation ()=0
 Gets the operation to perform (Freeze or Thaw) on the long transaction.
virtual FDO_API void SetName (FdoString *value)=0
 Sets the name of the long transaction to freeze or unfreeze as a string.
virtual FDO_API void SetOperation (FdoLongTransactionFreezeOperations value)=0
 Sets the operation to perform (Freeze or Thaw) on the long transaction.

Member Function Documentation

virtual FDO_API void FdoIFreezeLongTransaction::Execute  )  [pure virtual]
 

Executes the command.

Returns:
Returns nothing

virtual FDO_API FdoString* FdoIFreezeLongTransaction::GetName  )  [pure virtual]
 

Gets the name of the long transaction to freeze or unfreeze as a string.

Returns:
Returns the name of the long transaction

virtual FDO_API FdoLongTransactionFreezeOperations FdoIFreezeLongTransaction::GetOperation  )  [pure virtual]
 

Gets the operation to perform (Freeze or Thaw) on the long transaction.

Returns:
Returns the operation to perform

virtual FDO_API void FdoIFreezeLongTransaction::SetName FdoString value  )  [pure virtual]
 

Sets the name of the long transaction to freeze or unfreeze as a string.

Parameters:
value Input the name of the long transaction
Returns:
Returns nothing

virtual FDO_API void FdoIFreezeLongTransaction::SetOperation FdoLongTransactionFreezeOperations  value  )  [pure virtual]
 

Sets the operation to perform (Freeze or Thaw) on the long transaction.

Parameters:
value Input the operation to perform
Returns:
Returns nothing

The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.