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

FdoILongTransactionReader Class Reference

#include <ILongTransactionReader.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoILongTransactionReader:

[legend]
List of all members.

Detailed Description

The FdoILongTransactionReader interface provides forward only, read-only functionality for enumerating long transactions. A reference to an FdoILongTransactionReader is returned from the GetLongTransactions command. The initial position of the FdoILongTransactionReader is prior to the first item. Thus, you must call ReadNext to begin accessing any data.

Definition at line 36 of file ILongTransactionReader.h.


Public Member Functions

virtual FDO_API void Close ()=0
 Closes the FdoILongTransactionReader object, freeing any resources it may be holding.
virtual FDO_API FdoILongTransactionReaderGetChildren ()=0
 Provides access to the direct descendent long transactions for the long transaction being currently read. The caller can use the returned reader to get to the next level of descendents if required. The returned reader is empty if there are no descendents for the long transction.
virtual FDO_API FdoDateTime GetCreationDate ()=0
 Retrieves the creation date of the long transaction currently being read.
virtual FDO_API FdoStringGetDescription ()=0
 Retrieves the description of the long transaction currently being read.
virtual FDO_API FdoStringGetName ()=0
 Retrieves the name of the long transaction currently being read.
virtual FDO_API FdoStringGetOwner ()=0
 Retrieves the owner of the long transaction currently being read.
virtual FDO_API FdoILongTransactionReaderGetParents ()=0
 Provides access to the direct ascendant long transactions for the long transaction being currently read. The caller can use the returned reader to get to the next level of ascendants if required. The returned reader is empty if there are no ascendants for the long transaction.
virtual FDO_API bool IsActive ()=0
 Returns true if the long transaction currently being read is the active long transaction.
virtual FDO_API bool IsFrozen ()=0
 Returns true if the long transaction currently being read is frozen.
virtual FDO_API bool ReadNext ()=0
 Advances the reader to the next item. The default position of the reader is prior to the first item. Thus, you must call ReadNext to begin accessing any data.

Member Function Documentation

virtual FDO_API void FdoILongTransactionReader::Close  )  [pure virtual]
 

Closes the FdoILongTransactionReader object, freeing any resources it may be holding.

Returns:
Returns nothing

virtual FDO_API FdoILongTransactionReader* FdoILongTransactionReader::GetChildren  )  [pure virtual]
 

Provides access to the direct descendent long transactions for the long transaction being currently read. The caller can use the returned reader to get to the next level of descendents if required. The returned reader is empty if there are no descendents for the long transction.

Returns:
Returns a long transaction reader with the direct descendents for the long transaction currently being read.

virtual FDO_API FdoDateTime FdoILongTransactionReader::GetCreationDate  )  [pure virtual]
 

Retrieves the creation date of the long transaction currently being read.

Returns:
Returns the date when the long transaction was created.

virtual FDO_API FdoString* FdoILongTransactionReader::GetDescription  )  [pure virtual]
 

Retrieves the description of the long transaction currently being read.

Returns:
Returns the description of the long transaction.

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

Retrieves the name of the long transaction currently being read.

Returns:
Returns the name of the long transaction.

virtual FDO_API FdoString* FdoILongTransactionReader::GetOwner  )  [pure virtual]
 

Retrieves the owner of the long transaction currently being read.

Returns:
Returns the owner name.

virtual FDO_API FdoILongTransactionReader* FdoILongTransactionReader::GetParents  )  [pure virtual]
 

Provides access to the direct ascendant long transactions for the long transaction being currently read. The caller can use the returned reader to get to the next level of ascendants if required. The returned reader is empty if there are no ascendants for the long transaction.

Returns:
Returns a long transaction reader with the direct ascendants for the long transaction currently being read.

virtual FDO_API bool FdoILongTransactionReader::IsActive  )  [pure virtual]
 

Returns true if the long transaction currently being read is the active long transaction.

Returns:
Returns true if the long transaction is active.

virtual FDO_API bool FdoILongTransactionReader::IsFrozen  )  [pure virtual]
 

Returns true if the long transaction currently being read is frozen.

Returns:
Returns true if the long transaction is frozen.

virtual FDO_API bool FdoILongTransactionReader::ReadNext  )  [pure virtual]
 

Advances the reader to the next item. The default position of the reader is prior to the first item. Thus, you must call ReadNext to begin accessing any data.

Returns:
Returns true if there is a next item.

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