FDO .NET API Reference Feature Data Objects
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

OSGeo::FDO::Commands::LongTransaction::ILongTransactionReaderImp Class Reference

Inherits OSGeo::FDO::Runtime::Disposable, and OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::ILongTransactionReader.

Inheritance diagram for OSGeo::FDO::Commands::LongTransaction::ILongTransactionReaderImp:

[legend]
List of all members.

Detailed Description

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


Public Member Functions

System::Void Close ()
 Closes the ILongTransactionReader object, freeing any resources it may be holding.
OSGeo::FDO::Commands::LongTransaction::ILongTransactionReaderGetChildren ()
 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.
System::DateTime GetCreationDate ()
 Retrieves the creation date of the long transaction currently being read.
System::String * GetDescription ()
 Retrieves the description of the long transaction currently being read.
System::String * GetName ()
 Retrieves the name of the long transaction currently being read.
System::String * GetOwner ()
 Retrieves the owner of the long transaction currently being read.
OSGeo::FDO::Commands::LongTransaction::ILongTransactionReaderGetParents ()
 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.
System::Boolean IsActive ()
 Returns true if the long transaction currently being read is the active long transaction.
System::Boolean IsFrozen ()
 Returns true if the long transaction currently being read is frozen.
System::Boolean ReadNext ()
 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.

Protected Member Functions

__sealed System::Void ReleaseUnmanagedObject ()
 DOXYGEN-IGNORE

Member Function Documentation

System::Void OSGeo::FDO::Commands::LongTransaction::ILongTransactionReaderImp::Close  ) 
 

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

Returns:
Returns nothing

OSGeo ::FDO ::Commands ::LongTransaction ::ILongTransactionReader* OSGeo::FDO::Commands::LongTransaction::ILongTransactionReaderImp::GetChildren  ) 
 

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.

System::DateTime OSGeo::FDO::Commands::LongTransaction::ILongTransactionReaderImp::GetCreationDate  ) 
 

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

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

System::String* OSGeo::FDO::Commands::LongTransaction::ILongTransactionReaderImp::GetDescription  ) 
 

Retrieves the description of the long transaction currently being read.

Returns:
Returns the description of the long transaction.

System::String* OSGeo::FDO::Commands::LongTransaction::ILongTransactionReaderImp::GetName  ) 
 

Retrieves the name of the long transaction currently being read.

Returns:
Returns the name of the long transaction.

System::String* OSGeo::FDO::Commands::LongTransaction::ILongTransactionReaderImp::GetOwner  ) 
 

Retrieves the owner of the long transaction currently being read.

Returns:
Returns the owner name.

OSGeo ::FDO ::Commands ::LongTransaction ::ILongTransactionReader* OSGeo::FDO::Commands::LongTransaction::ILongTransactionReaderImp::GetParents  ) 
 

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.

System::Boolean OSGeo::FDO::Commands::LongTransaction::ILongTransactionReaderImp::IsActive  ) 
 

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

Returns:
Returns true if the long transaction is active.

System::Boolean OSGeo::FDO::Commands::LongTransaction::ILongTransactionReaderImp::IsFrozen  ) 
 

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

Returns:
Returns true if the long transaction is frozen.

System::Boolean OSGeo::FDO::Commands::LongTransaction::ILongTransactionReaderImp::ReadNext  ) 
 

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.

__sealed System::Void OSGeo::FDO::Commands::LongTransaction::ILongTransactionReaderImp::ReleaseUnmanagedObject  )  [protected, virtual]
 

DOXYGEN-IGNORE

Reimplemented from OSGeo::FDO::Runtime::Disposable.


Comments or suggestions? Send us feedback.