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::IAcquireLockImp Class Reference

Inherits OSGeo::FDO::Commands::IFeatureCommandImp, and OSGeo::FDO::Commands::Locking::OSGeo::FDO::Commands::Locking::IAcquireLock.

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

[legend]
List of all members.

Detailed Description

The IAcquireLockImp class is a concrete implementation of IAcquireLock. The IAcquireLock interface locks feature instances of a given class that match the specified criteria. Input to the acquire lock command includes the name of the class, the lock type, the lock strategy, and filter criteria by which to identify the instances to be locked. The filter may be specified either as text or as an expression tree (most likely produced by a query builder). The lock type value is one of

- LockType_Shared

- LockType_Exclusive

- LockType_Transaction

- LockType_LongTransactionExclusive

- LockType_AllLongTransactionExclusive.

Remarks:
If the lock strategy has a value of all and at least one of the feature instances specified in the filter is locked by someone else, the command returns an ILockConflictReader list which contains all of the feature instances specified in the filter.
If the lock strategy has a value of partial, the command returns an ILockConflictReader list which contains all of the feature instances specified in the filter that are already locked by someone else. The command returns an empty ILockConflictReader list if all of the feature instances specified in the filter were successfully locked.


Public Member Functions

OSGeo::FDO::Commands::Locking::ILockConflictReaderExecute ()
 Executes the AcquireLock command, returning an ILockConflictReader.
__property OSGeo::FDO::Commands::Locking::LockStrategy get_LockStrategy ()
 Gets the LockStrategy value.
__property OSGeo::FDO::Commands::Locking::LockType get_LockType ()
 Gets the LockType value.
__property System::Void set_LockStrategy (OSGeo::FDO::Commands::Locking::LockStrategy value)
 Sets the LockStrategy value (all or partial).
__property System::Void set_LockType (OSGeo::FDO::Commands::Locking::LockType value)
 Sets the LockType value.

Member Function Documentation

OSGeo ::FDO ::Commands ::Locking ::ILockConflictReader* OSGeo::FDO::Commands::Locking::IAcquireLockImp::Execute  ) 
 

Executes the AcquireLock command, returning an ILockConflictReader.

Returns:
Returns a list of feature instances which could not be locked. The list could be empty indicating that all of the feature instances specified in the filter have been locked, or it could contain the list of feature instances that could not be locked because they are already locked by someone or because the locking strategy is all and at least one of the feature instances specified in the filter is already locked by someone else.

__property OSGeo ::FDO ::Commands ::Locking ::LockStrategy OSGeo::FDO::Commands::Locking::IAcquireLockImp::get_LockStrategy  ) 
 

Gets the LockStrategy value.

Returns:
Returns the strategy value (all or partial).

__property OSGeo ::FDO ::Commands ::Locking ::LockType OSGeo::FDO::Commands::Locking::IAcquireLockImp::get_LockType  ) 
 

Gets the LockType value.

Returns:
Returns the lock type.

__property System::Void OSGeo::FDO::Commands::Locking::IAcquireLockImp::set_LockStrategy OSGeo::FDO::Commands::Locking::LockStrategy  value  ) 
 

Sets the LockStrategy value (all or partial).

Parameters:
value Input the lock strategy used for locking objects
Returns:
Returns nothing

__property System::Void OSGeo::FDO::Commands::Locking::IAcquireLockImp::set_LockType OSGeo::FDO::Commands::Locking::LockType  value  ) 
 

Sets the LockType value.

Parameters:
value Input the lock type
Returns:
Returns nothing

Comments or suggestions? Send us feedback.