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::Locking::ILockedObjectReaderImp Class Reference

Inherits OSGeo::FDO::Runtime::Disposable, and OSGeo::FDO::Commands::Locking::OSGeo::FDO::Commands::Locking::ILockedObjectReader.

Inheritance diagram for OSGeo::FDO::Commands::Locking::ILockedObjectReaderImp:

[legend]
List of all members.

Detailed Description

The ILockedObjectReaderImp class is a concrete implementation of ILockedObjectReader. The ILockedObjectReader interface provides forward-only, read-only functionality to identify lock information for a set of objects.

Remarks:
A reference to an ILockedObjectReader interface is returned from the GetLockedObjects and GetLockInfo commands. The initial position of the ILockInfoReader is prior to the first item. Thus, you must call ReadNext to begin accessing any data.


Public Member Functions

System::Void Close ()
 Closes the ILockInfoReader object, freeing any resources it may be holding.
System::String * GetFeatureClassName ()
 Gets the class name of the feature currently being read.
OSGeo::FDO::Commands::PropertyValueCollectionGetIdentity ()
 Gets an PropertyValueCollection containing the property values that uniquely identify the feature currently being read.
System::String * GetLockOwner ()
 Gets the name of user who holds the lock on the feature currently being read.
OSGeo::FDO::Commands::Locking::LockType GetLockType ()
 Gets the type of the lock held on the feature currently being read.
System::String * GetLongTransaction ()
 Gets the name of the long transaction in which the feature currently being read is locked.
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

System::Void ReleaseUnmanagedObject ()
 DOXYGEN-IGNORE

Member Function Documentation

System::Void OSGeo::FDO::Commands::Locking::ILockedObjectReaderImp::Close  ) 
 

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

Returns:
Returns nothing

System::String* OSGeo::FDO::Commands::Locking::ILockedObjectReaderImp::GetFeatureClassName  ) 
 

Gets the class name of the feature currently being read.

Remarks:
The value of the class name will be null in the event that the class name could not be resolved. This can happen if the table has no class id field and multiple classes have been written to the table.
Returns:
Returns the name of the class.

OSGeo ::FDO ::Commands ::PropertyValueCollection* OSGeo::FDO::Commands::Locking::ILockedObjectReaderImp::GetIdentity  ) 
 

Gets an PropertyValueCollection containing the property values that uniquely identify the feature currently being read.

Returns:
Returns the property collection identifying the feature.

System::String* OSGeo::FDO::Commands::Locking::ILockedObjectReaderImp::GetLockOwner  ) 
 

Gets the name of user who holds the lock on the feature currently being read.

Returns:
Returns the lock owner

OSGeo ::FDO ::Commands ::Locking ::LockType OSGeo::FDO::Commands::Locking::ILockedObjectReaderImp::GetLockType  ) 
 

Gets the type of the lock held on the feature currently being read.

Returns:
Returns the lock type

System::String* OSGeo::FDO::Commands::Locking::ILockedObjectReaderImp::GetLongTransaction  ) 
 

Gets the name of the long transaction in which the feature currently being read is locked.

Returns:
Returns the name of the long transaction in which the feature currently being read is locked.

System::Boolean OSGeo::FDO::Commands::Locking::ILockedObjectReaderImp::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.

System::Void OSGeo::FDO::Commands::Locking::ILockedObjectReaderImp::ReleaseUnmanagedObject  )  [protected, virtual]
 

DOXYGEN-IGNORE

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


Comments or suggestions? Send us feedback.