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 Namespace Reference


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::ILockConflictReaderExecute ()
 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::PropertyValueCollectionGetIdentity ()
 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

Enumeration Type Documentation

enum ConflictType
 

The ConflictType enumeration defines conflict types required to identify the lock type of a conflict reported with the lock conflict reader.

Enumeration values:
ConflictType_LockConflict  Identifies a reported conflict in the lock conflict reader as a lock conflict. A conflict represents a lock conflict if an object the user requests to be locked is already locked by a different user.
ConflictType_VersionConflict  Identifies a reported conflict in the lock conflict reader as a version conflict. A conflict represents a version conflict if an object the user requests to be locked has already been versioned.
ConflictType_Unsupported  Indicates that an unsupported or unknown conflict type has been encountered.

enum LockStrategy
 

The LockStrategy enumeration defines how lock acquisition should proceed.

Enumeration values:
LockStrategy_All  Declares that either all of the locks must be acquired or none should be acquired.
LockStrategy_Partial  Declares that all of the locks that can be acquired should be acquired.

enum LockType
 

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.

Enumeration values:
LockType_None  Indicates that an object is unlocked. This type cannot be used with the commands AcquireLock and Select.
LockType_Shared  Indicates a shared lock type. The type can be used with the commands AcquireLock and Select.
LockType_Exclusive  Indicates that only this user can modify this object. In a long transaction situation, any user can modify the object in any other long transaction, including the root long transaction if it is not the current long transaction. The type can be used with the commands AcquireLock and Select.
LockType_Transaction  Indicates that a transaction lock should be applied on an object. This type can be used with the commands AcquireLock and Select.
LockType_Unsupported  Indicates that an unsupported lock type has been encountered. This type cannot be used with the commands AcquireLock and Select.
LockType_AllLongTransactionExclusive  Indicates that only this user can modify this object in this long transaction. No user, not even the user locking the object, can modify the object in any long transaction created as a descendent of the one containing the object being locked. When not in a long transaction situation (for example, if only a root long transaction exists), the lock behaves like an Exclusive lock. This type can be used with the commands AcquireLock and Select.
LockType_LongTransactionExclusive  Indicates that only this user can modify this object in the long transaction containing the object or any long transaction created as a descendent of that one. When not in a long transaction situation (for example, if only a root long transaction exists), the lock behaves like an Exclusive lock. The type can be used with the commands AcquireLock and Select.

Function Documentation

System::Void Close  ) 
 

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

Returns:
Returns nothing

OSGeo ::FDO ::Commands ::Locking ::ILockConflictReader* 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 get_LockStrategy  ) 
 

Gets the LockStrategy value.

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

OSGeo ::FDO ::Commands ::Locking ::ConflictType GetConflictType  ) 
 

Gets the conflict type for the conflict currently being read.

Returns:
Returns 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.

Returns:
Returns the property collection identifying the feature.

System::String* GetLockOwner  ) 
 

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

Returns:
Returns the name of the owner

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

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

Returns:
Returns the lock type

System::String* 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 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.

__property System::Void set_LockOwner System::String *  value  ) 
 

Sets the name of the user whose locked objects you want to list.

Parameters:
value Input the name of the user
Returns:
Returns nothing

__property System::Void 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 set_LockType OSGeo::FDO::Commands::Locking::LockType  value  ) 
 

Sets the LockType value.

Parameters:
value Input the lock type
Returns:
Returns nothing

Variable Documentation

public __gc __interface OSGeo::FDO::Commands::Locking::IAcquireLock
 

public __gc __interface OSGeo::FDO::Commands::Locking::IGetLockedObjects
 

public __gc __interface OSGeo::FDO::Commands::Locking::IGetLockInfo
 

public __gc __interface OSGeo::FDO::Commands::Locking::IGetLockOwners
 

public __gc __interface OSGeo::FDO::Commands::Locking::ILockConflictReader
 

public __gc __interface OSGeo::FDO::Commands::Locking::ILockedObjectReader
 

public __gc __interface OSGeo::FDO::Commands::Locking::ILockOwnersReader
 

public __gc __interface OSGeo::FDO::Commands::Locking::IReleaseLock
 


Comments or suggestions? Send us feedback.