FDO .NET API Reference | Feature Data Objects |
Classes | |
class | OSGeo::FDO::Commands::Locking::IAcquireLockImp |
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. More... | |
class | OSGeo::FDO::Commands::Locking::IGetLockedObjectsImp |
The IGetLockedObjectsImp class is a concrete implementation of IGetLockedObjects. The IGetLockedObjects interface defines the GetLockedObjects command, which gets a list of all objects that are currently locked by a particular user. More... | |
class | OSGeo::FDO::Commands::Locking::IGetLockInfoImp |
The IGetLockInfoImp class is a concrete implementation of IGetLockedObjects. The IGetLockInfo interface defines the GetLockInfo command, which gets a lock information for the feature instances of a given class that match the specified filter. If the filter is empty, all feature instances of the given class are selected. More... | |
class | OSGeo::FDO::Commands::Locking::IGetLockOwnersImp |
The IGetLockOwnersImp class is a concrete implementation of IGetLockedObjects. The IGetLockOwners interface defines the GetLockOwners command, which gets a list of all lock owners. A connected user has the status of being a lock owner as does a user who has released all of his locks. More... | |
class | OSGeo::FDO::Commands::Locking::ILockConflictReaderImp |
The ILockConflictReaderImp class is a concrete implementation of ILockConflictReaderImp. The ILockConflictReader interface provides forward only, read-only functionality for identifying features that have a lock conflict. Features with a lock conflict are those that the caller is attempting to modify that are already locked by someone else. More... | |
class | OSGeo::FDO::Commands::Locking::ILockedObjectReaderImp |
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. More... | |
class | OSGeo::FDO::Commands::Locking::ILockOwnersReaderImp |
The ILockOwnersReaderImp class is a concrete implementation of ILockOwnersReader. The ILockOwnersReader interface provides forward-only, read-only functionality for identifying users. A connected user has status of lock owner even if he has no locks or has released his locks. More... | |
class | OSGeo::FDO::Commands::Locking::IReleaseLockImp |
The IReleaseLockImp class is a concrete implementation of IReleaseLock. The IReleaseLock interface defines the ReleaseLock command, which releases locks from feature instances of a given class that match the specified criteria. Input to the release lock command includes the name of the class and filter criteria by which to identify the instances to be unlocked. The filter may be specified either as text or as an expression tree (most likely produced by a query builder). The ability to successfully execute the command might be restricted by the datastore security if the lock doesn’t belong to the user executing the command. More... | |
interface | OSGeo::FDO::Commands::Locking::OSGeo::FDO::Commands::Locking::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. More... | |
interface | OSGeo::FDO::Commands::Locking::OSGeo::FDO::Commands::Locking::IGetLockedObjects |
The IGetLockedObjects interface defines the GetLockedObjects command, which gets a list of all objects that are currently locked by a particular user. More... | |
interface | OSGeo::FDO::Commands::Locking::OSGeo::FDO::Commands::Locking::IGetLockInfo |
The IGetLockInfo interface defines the GetLockInfo command, which gets a lock information for the feature instances of a given class that match the specified filter. If the filter is empty, all feature instances of the given class are selected. More... | |
interface | OSGeo::FDO::Commands::Locking::OSGeo::FDO::Commands::Locking::IGetLockOwners |
The IGetLockOwners interface defines the GetLockOwners command, which gets a list of all lock owners. A connected user has the status of being a lock owner as does a user who has released all of his locks. More... | |
interface | OSGeo::FDO::Commands::Locking::OSGeo::FDO::Commands::Locking::ILockConflictReader |
The ILockConflictReader interface provides forward only, read-only functionality for identifying features that have a lock conflict. Features with a lock conflict are those that the caller is attempting to modify that are already locked by someone else. More... | |
interface | OSGeo::FDO::Commands::Locking::OSGeo::FDO::Commands::Locking::ILockedObjectReader |
The ILockedObjectReader interface provides forward-only, read-only functionality to identify lock information for a set of objects. More... | |
interface | OSGeo::FDO::Commands::Locking::OSGeo::FDO::Commands::Locking::ILockOwnersReader |
The ILockOwnersReader interface provides forward-only, read-only functionality for identifying users. A connected user has status of lock owner even if he has no locks or has released his locks. More... | |
interface | OSGeo::FDO::Commands::Locking::OSGeo::FDO::Commands::Locking::IReleaseLock |
The IReleaseLock interface defines the ReleaseLock command, which releases locks from feature instances of a given class that match the specified criteria. Input to the release lock command includes the name of the class and filter criteria by which to identify the instances to be unlocked. The filter may be specified either as text or as an expression tree (most likely produced by a query builder). The ability to successfully execute the command might be restricted by the datastore security if the lock doesn’t belong to the user executing the command. More... | |
Enumerations | |
enum | ConflictType { ConflictType_LockConflict = FdoConflictType_LockConflict, ConflictType_VersionConflict = FdoConflictType_VersionConflict, ConflictType_Unsupported = FdoConflictType_Unsupported } |
The ConflictType enumeration defines conflict types required to identify the lock type of a conflict reported with the lock conflict reader. More... | |
enum | LockStrategy { LockStrategy_All = FdoLockStrategy_All, LockStrategy_Partial = FdoLockStrategy_Partial } |
The LockStrategy enumeration defines how lock acquisition should proceed. More... | |
enum | LockType { LockType_None = FdoLockType_None, LockType_Shared = FdoLockType_Shared, LockType_Exclusive = FdoLockType_Exclusive, LockType_Transaction = FdoLockType_Transaction, LockType_Unsupported = FdoLockType_Unsupported, LockType_AllLongTransactionExclusive = FdoLockType_AllLongTransactionExclusive, LockType_LongTransactionExclusive = FdoLockType_LongTransactionExclusive } |
The LockType enumeration defines lock types. The lock type for a locked object indicates a user's access privileges (including the user who applied the persistent lock) to an object. The enumeration values are used with the AcquireLock, Select and GetLockInfo commands. With the command AcquireLock or Select, the specified value indicates the lock type to be used when applying a lock on an object. With the command IGetLockInfo, the enumaration values are used to report lock types back to the user.
The enumeration contains some special lock types (LockType_None and LockType_Unsupported) that are used only when reporting lock type information. These special lock types cannot be used to specify a lock type to be applied to an object. More... | |
Functions | |
System::Void | Close () |
Closes the ILockConflictReader object, freeing any resources it may be holding. | |
OSGeo::FDO::Commands::Locking::ILockConflictReader * | Execute () |
Executes the AcquireLock command, returning an ILockConflictReader. | |
__property OSGeo::FDO::Commands::Locking::LockStrategy | get_LockStrategy () |
Gets the LockStrategy value. | |
OSGeo::FDO::Commands::Locking::ConflictType | GetConflictType () |
Gets the conflict type for the conflict currently being read. | |
OSGeo::FDO::Commands::PropertyValueCollection * | GetIdentity () |
Returns an PropertyValueCollection containing the property values that uniquely identify the feature currently being read. | |
System::String * | GetLockOwner () |
Gets the name of the owner who holds a 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. | |
__property System::Void | set_LockOwner (System::String *value) |
Sets the name of the user whose locked objects you want to list. | |
__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. | |
Variables | |
public __gc __interface | IAcquireLock |
public __gc __interface | IGetLockedObjects |
public __gc __interface | IGetLockInfo |
public __gc __interface | IGetLockOwners |
public __gc __interface | ILockConflictReader |
public __gc __interface | ILockedObjectReader |
public __gc __interface | ILockOwnersReader |
public __gc __interface | IReleaseLock |
|
|
The LockStrategy enumeration defines how lock acquisition should proceed.
|
|
The LockType enumeration defines lock types. The lock type for a locked object indicates a user's access privileges (including the user who applied the persistent lock) to an object. The enumeration values are used with the AcquireLock, Select and GetLockInfo commands. With the command AcquireLock or Select, the specified value indicates the lock type to be used when applying a lock on an object. With the command IGetLockInfo, the enumaration values are used to report lock types back to the user. The enumeration contains some special lock types (LockType_None and LockType_Unsupported) that are used only when reporting lock type information. These special lock types cannot be used to specify a lock type to be applied to an object.
|
|
Closes the ILockConflictReader object, freeing any resources it may be holding.
|
|
Executes the AcquireLock command, returning an ILockConflictReader.
|
|
Gets the LockStrategy value.
|
|
Gets the conflict type for the conflict currently being read.
|
|
Returns an PropertyValueCollection containing the property values that uniquely identify the feature currently being read.
|
|
Gets the name of the owner who holds a lock on the feature currently being read.
|
|
Gets the type of the lock held on the feature currently being read.
|
|
Gets the name of the long transaction in which the feature currently being read is locked.
|
|
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.
|
|
Sets the name of the user whose locked objects you want to list.
|
|
Sets the LockStrategy value (all or partial).
|
|
Sets the LockType value.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Comments or suggestions? Send us feedback. |