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

FdoICommitLongTransaction Class Reference

#include <ICommitLongTransaction.h>

Inherits FdoIFeatureCommand.

Inheritance diagram for FdoICommitLongTransaction:

[legend]
List of all members.

Detailed Description

The FdoICommitLongTransaction interface defines the CommitLongTransaction command, which allows a user to execute commit operations on a long transaction. Two different commit operations are distinguished: full and partial.

Full. A full commit operation is executed on all data within a long transaction. The data is committed to the parent long transaction and the long transaction itself is removed.

Partial. A partial commit operation is executed on a subset of the data within a long transaction (this could be all data). The data is committed to the parent long transaction. However, the long transaction, itself, is not removed. The subset of the data to be committed is defined by a class name and a set of filter criteria.

To perform a commit operation the user requires the access and commit privileges for the long transaction to be committed (in case of a full commit the user also requires the remove privilege for the long transaction) and the access privilege for the parent long transaction. In addition, a full commit can be performed on a leaf long transaction only. A long transaction is a leaf long transaction if it does not have descendent versions.

Definition at line 48 of file ICommitLongTransaction.h.


Public Member Functions

virtual FDO_API FdoILongTransactionConflictDirectiveEnumeratorExecute ()=0
virtual FDO_API FdoILockConflictReaderGetLockConflictReader ()=0
 Gets a reference to the lock conflict reader.
virtual FDO_API FdoStringGetName ()=0
 Gets the name of the long transaction to commit as a string.
virtual FDO_API void SetName (FdoString *value)=0
 Sets the name of the long transaction to commit as a string.

Friends

class FdoIConnection

Member Function Documentation

virtual FDO_API FdoILongTransactionConflictDirectiveEnumerator* FdoICommitLongTransaction::Execute  )  [pure virtual]
 

Executes the commit long transaction command and returns an FdoILongTransactionConflictDirectiveEnumerator. If the returned enumerator's count is 0 then no conflicts were detected and the command was executed successfully. Otherwise conflicts were detected and the user must specify how to resolve them using the enumerator and call Execute again.

virtual FDO_API FdoILockConflictReader* FdoICommitLongTransaction::GetLockConflictReader  )  [pure virtual]
 

Gets a reference to the lock conflict reader.

Returns:
Returns a reference to the lock conflict reader

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

Gets the name of the long transaction to commit as a string.

Returns:
Returns the name of the long transaction

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

Sets the name of the long transaction to commit as a string.

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

Friends And Related Function Documentation

friend class FdoIConnection [friend]
 

Reimplemented from FdoIFeatureCommand.

Definition at line 50 of file ICommitLongTransaction.h.


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