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


Classes

class  OSGeo::FDO::Commands::LongTransaction::IActivateLongTransactionCheckpointImp
 The IActivateLongTransactionCheckpointImp class is a concrete implementation of IActivateLongTransactionCheckpoint. The IActivateLongTransactionCheckpoint interface defines the IActivateLongTransactionCheckpointImp command, which allows the user to activate the named checkpoint for the given long transaction. As a result, the long transaction that owns the checkpoint will be activated as well if it is not already the active long transaction. The user requires the access privilege on the long transaction for which the attempt is made to activate a checkpoint. More...
class  OSGeo::FDO::Commands::LongTransaction::IActivateLongTransactionImp
 The IActivateLongTransactionImp class is a concrete implementation of IActivateLongTransaction. The IActivateLongTransaction interface defines the ActivateLongTransaction command, which activates a long transaction where feature manipulation and locking commands operate on it. Input to the activate long transaction command is the long transaction name. The Execute operation activates the identified long transaction if the user has access privileges for it. More...
class  OSGeo::FDO::Commands::LongTransaction::IChangeLongTransactionPrivilegesImp
 The IChangeLongTransactionPrivilegesImp class is a concrete implementation of IChangeLongTransactionPrivileges. The IChangeLongTransactionPrivileges interface defines the ChangeLongTransactionPrivileges command, which grants or revokes long transaction privileges for the named user. The ability to change the privileges might be restricted by the datastore security if the long transaction doesn’t belong to the user executing the command. More...
class  OSGeo::FDO::Commands::LongTransaction::IChangeLongTransactionSetImp
 The IChangeLongTransactionSetImp class is a concrete implementation of IChangeLongTransactionSet. The IChangeLongTransactionSet interface defines the ChangeLongTransactionSet command, which allows the user to add a transaction to, remove a transaction from, or clear the long transaction selection set. Users can add or remove long transactions to the selection set for which they have access privileges. Any attempt to add a long transaction for which the user does not have the access privilege will result in a failure of the command. More...
class  OSGeo::FDO::Commands::LongTransaction::ICommitLongTransactionImp
 The ICommitLongTransactionImp class is a concrete implementation of ICommitLongTransaction. The ICommitLongTransaction interface defines the CommitLongTransaction command, which allows a user to execute commit operations on a long transaction. Two different commit operations are distinguished: full and partial. More...
class  OSGeo::FDO::Commands::LongTransaction::ICreateLongTransactionCheckpointImp
 The ICreateLongTransactionCheckpointImp class is a concrete implementation of ICreateLongTransactionCheckpoint. The ICreateLongTransactionCheckpoint interface defines the CreateLongTransactionCheckpoint command, which allows the user to create a checkpoint for any long transaction to which the user has the access privileges. More...
class  OSGeo::FDO::Commands::LongTransaction::ICreateLongTransactionImp
 The ICreateLongTransactionImp class is a concrete implementation of ICreateLongTransaction. command which creates a long transaction that is based upon the currently active long transaction. If no long transaction is active, then the long transaction is based upon the root data. Input to the create long transaction command includes a name and description for the new long transaction. More...
class  OSGeo::FDO::Commands::LongTransaction::IDeactivateLongTransactionImp
 The IDeactivateLongTransactionImp class is a concrete implementation of IDeactivateLongTransaction. The IDeactivateLongTransaction interface defines the DeactivateLongTransaction command, which deactivates the active long transaction where feature manipulation commands operate on it. If the active long transaction is the root long transaction, then no long transaction will be deactivated. More...
class  OSGeo::FDO::Commands::LongTransaction::IFreezeLongTransactionImp
 The IFreezeLongTransactionImp class is a concrete implementation of IFreezeLongTransaction. The IFreezeLongTransaction interface defines the FreezeLongTransaction command, which freezes or thaws a long transaction. When a long transaction is frozen the user who froze it gains exclusive access to it. Other users can read it, but not apply any updates. Input to the FreezeLongTransaction command is the long transaction name and the operation to perform. The Execute method performs the specified operation on the identified long transaction if the user has access privileges for the indicated long transaction. More...
class  OSGeo::FDO::Commands::LongTransaction::IGetLongTransactionCheckpointsImp
 The IGetLongTransactionCheckpointsImp class is a concrete implementation of IGetLongTransactionCheckpoints. The IGetLongTransactionCheckpoints interface defines the GetLongTransactionCheckpoints command, which allows the user to enumerate the checkpoints for a given long transaction. To execute the operation, the user must have access privilege to the long transaction. More...
class  OSGeo::FDO::Commands::LongTransaction::IGetLongTransactionPrivilegesImp
 The IGetLongTransactionPrivilegesImp class is a concrete implementation of IGetLongTransactionPrivileges. The IGetLongTransactionPrivileges interface defines the GetLongTransactionPrivileges command, which allows the user to enumerate the privileges of a long transaction established for each user. The ability to successfully execute the command might be restricted by the datastore security if the long transaction doesn’t belong to the user executing the command. More...
class  OSGeo::FDO::Commands::LongTransaction::IGetLongTransactionsImp
 The IGetLongTransactionsImp class is a concrete implementation of IGetLongTransactions. The IGetLongTransactions interface defines the GetLongTransactions command. It allows a user to retrieve long transaction information for all or a specific long transaction. The command returns a ILongTransactionReader object enumerating the identified long transactions. More...
class  OSGeo::FDO::Commands::LongTransaction::IGetLongTransactionsInSetImp
 The IGetLongTransactionsInSetImp class is a concrete implementation of IGetLongTransactionsInSet. The IGetLongTransactionsInSet interface defines the GetLongTransactionsInSet command, which allows the user to enumerate the list of versions participating in the long transaction selection set. More...
class  OSGeo::FDO::Commands::LongTransaction::ILongTransactionCheckpointReaderImp
 The ILongTransactionCheckpointReaderImp class is a concrete implementation of ILongTransactionCheckpointReader. The ILongTransactionCheckpointReader interface provides forward only, read-only functionality for enumerating long transaction checkpoints. A reference to an ILongTransactionCheckpointReader is returned from the GetLongTransactionCheckpoints command. The initial position of the ILongTransactionCheckpointReader is prior to the first item. Thus, you must call ReadNext to begin accessing any data. More...
class  OSGeo::FDO::Commands::LongTransaction::ILongTransactionConflictDirectiveEnumeratorImp
 The ILongTransactionConflictDirectiveEnumeratorImp class is a concrete implementation of ILongTransactionConflictDirectiveEnumerator. The ILongTransactionConflictDirective interface is used to specify how conflict should be resolved for a particular object. More...
class  OSGeo::FDO::Commands::LongTransaction::ILongTransactionPrivilegeReaderImp
 The ILongTransactionPrivilegeReaderImp class is a concrete implementation of ILongTransactionPrivilegeReader. The ILongTransactionPrivilegeReader interface provides forward only, read-only functionality for enumerating long transaction privileges. A reference to an FdoILongTransactionPrivilegeReader is returned from the GetLongTransactionPrivileges command. The initial position of the ILongTransactionPrivilegeReader is prior to the first item. Thus, you must call ReadNext to begin accessing any data. More...
class  OSGeo::FDO::Commands::LongTransaction::ILongTransactionReaderImp
 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. More...
class  OSGeo::FDO::Commands::LongTransaction::ILongTransactionSetReaderImp
 The ILongTransactionSetReaderImp class is a concrete implementation of ILongTransactionSetReader. The ILongTransactionSetReader interface provides forward only, read-only functionality for enumerating the versions in the long transaction selection set. A reference to an ILongTransactionSetReader is returned from the GetLongTransactionsInSet command. The initial position of the ILongTransactionSetReader is prior to the first item. Thus, you must call ReadNext to begin accessing any data. More...
class  OSGeo::FDO::Commands::LongTransaction::IRollbackLongTransactionCheckpointImp
 The IRollbackLongTransactionCheckpointImp class is a concrete implementation of IRollbackLongTransactionCheckpoint. The IRollbackLongTransactionCheckpoint interface defines the RollbackLongTransactionCheckpoint command, which allows the user to roll back changes to a named checkpoint for the given long transaction. The user requires the access privilege on the long transaction for which the user tries to perform the operation. More...
class  OSGeo::FDO::Commands::LongTransaction::IRollbackLongTransactionImp
 The IRollbackLongTransactionImp class is a concrete implementation of IRollbackLongTransaction. The IRollbackLongTransaction interface defines the RollbackLongTransaction command, which allows a user to execute rollback operations on a long transaction. Two different rollback operations are distinguished: full and partial. More...
interface  OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::IActivateLongTransaction
 The IActivateLongTransaction interface defines the ActivateLongTransaction command, which activates a long transaction where feature manipulation and locking commands operate on it. Input to the activate long transaction command is the long transaction name. The Execute operation activates the identified long transaction if the user has access privileges for it. More...
interface  OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::IActivateLongTransactionCheckpoint
 The IActivateLongTransactionCheckpoint interface defines the ActivateLongTransactionCheckpoint command, which allows the user to activate the named checkpoint for the given long transaction. As a result, the long transaction that owns the checkpoint will be activated as well if it is not already the active long transaction. The user requires the access privilege on the long transaction for which the attempt is made to activate a checkpoint. More...
interface  OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::IChangeLongTransactionPrivileges
 The IChangeLongTransactionPrivileges interface defines the ChangeLongTransactionPrivileges command, which grants or revokes long transaction privileges for the named user. The ability to change the privileges might be restricted by the datastore security if the long transaction doesn’t belong to the user executing the command. More...
interface  OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::IChangeLongTransactionSet
 The IChangeLongTransactionSet interface defines the ChangeLongTransactionSet command, which allows the user to add a transaction to, remove a transaction from, or clear the long transaction selection set. Users can add or remove long transactions to the selection set for which they have access privileges. Any attempt to add a long transaction for which the user does not have the access privilege will result in a failure of the command. More...
interface  OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::ICommitLongTransaction
 The ICommitLongTransaction interface defines the CommitLongTransaction command, which allows a user to execute commit operations on a long transaction. Two different commit operations are distinguished: full and partial. More...
interface  OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::ICreateLongTransaction
 The ICreateLongTransaction interface defines the CreateLongTransaction command which creates a long transaction that is based upon the currently active long transaction. If no long transaction is active, then the long transaction is based upon the root data. Input to the create long transaction command includes a name and description for the new long transaction. More...
interface  OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::ICreateLongTransactionCheckpoint
 The ICreateLongTransactionCheckpoint interface defines the CreateLongTransactionCheckpoint command, which allows the user to create a checkpoint for any long transaction to which the user has the access privileges. More...
interface  OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::IDeactivateLongTransaction
 The IDeactivateLongTransaction interface defines the DeactivateLongTransaction command, which deactivates the active long transaction where feature manipulation commands operate on it. If the active long transaction is the root long transaction, then no long transaction will be deactivated. More...
interface  OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::IFreezeLongTransaction
 The IFreezeLongTransaction interface defines the FreezeLongTransaction command, which freezes or thaws a long transaction. When a long transaction is frozen the user who froze it gains exclusive access to it. Other users can read it, but not apply any updates. Input to the FreezeLongTransaction command is the long transaction name and the operation to perform. The Execute method performs the specified operation on the identified long transaction if the user has access privileges for the indicated long transaction. More...
interface  OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::IGetLongTransactionCheckpoints
 The IGetLongTransactionCheckpoints interface defines the GetLongTransactionCheckpoints command, which allows the user to enumerate the checkpoints for a given long transaction. To execute the operation, the user must have access privilege to the long transaction. More...
interface  OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::IGetLongTransactionPrivileges
 The IGetLongTransactionPrivileges interface defines the GetLongTransactionPrivileges command, which allows the user to enumerate the privileges of a long transaction established for each user. The ability to successfully execute the command might be restricted by the datastore security if the long transaction doesn’t belong to the user executing the command. More...
interface  OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::IGetLongTransactions
 The IGetLongTransactions interface defines the GetLongTransactions command. It allows a user to retrieve long transaction information for all or a specific long transaction. The command returns a ILongTransactionReader object enumerating the identified long transactions. More...
interface  OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::IGetLongTransactionsInSet
 The IGetLongTransactionsInSet interface defines the GetLongTransactionsInSet command, which allows the user to enumerate the list of versions participating in the long transaction selection set. More...
interface  OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::ILongTransactionCheckpointReader
 The ILongTransactionCheckpointReader interface provides forward only, read-only functionality for enumerating long transaction checkpoints. A reference to an ILongTransactionCheckpointReader is returned from the GetLongTransactionCheckpoints command. The initial position of the ILongTransactionCheckpointReader is prior to the first item. Thus, you must call ReadNext to begin accessing any data. More...
interface  OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::ILongTransactionConflictDirectiveEnumerator
 The ILongTransactionConflictDirective interface is used to specify how conflict should be resolved for a particular object. More...
interface  OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::ILongTransactionPrivilegeReader
 The ILongTransactionPrivilegeReader interface provides forward only, read-only functionality for enumerating long transaction privileges. A reference to an FdoILongTransactionPrivilegeReader is returned from the GetLongTransactionPrivileges command. The initial position of the ILongTransactionPrivilegeReader is prior to the first item. Thus, you must call ReadNext to begin accessing any data. More...
interface  OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::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. More...
interface  OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::ILongTransactionSetReader
 The ILongTransactionSetReader interface provides forward only, read-only functionality for enumerating the versions in the long transaction selection set. A reference to an ILongTransactionSetReader is returned from the GetLongTransactionsInSet command. The initial position of the ILongTransactionSetReader is prior to the first item. Thus, you must call ReadNext to begin accessing any data. More...
interface  OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::IRollbackLongTransaction
 The IRollbackLongTransaction interface defines the RollbackLongTransaction command, which allows a user to execute rollback operations on a long transaction. Two different rollback operations are distinguished: full and partial. More...
interface  OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::IRollbackLongTransactionCheckpoint
 The IRollbackLongTransactionCheckpoint interface defines the RollbackLongTransactionCheckpoint command, which allows the user to roll back changes to a named checkpoint for the given long transaction. The user requires the access privilege on the long transaction for which the user tries to perform the operation. More...

Enumerations

enum  LongTransactionConflictResolution {
  LongTransactionConflictResolution_Unresolved = FdoLongTransactionConflictResolution_Unresolved,
  LongTransactionConflictResolution_Child = FdoLongTransactionConflictResolution_Child,
  LongTransactionConflictResolution_Parent = FdoLongTransactionConflictResolution_Parent
}
 The LongTransactionConflictResolution enumeration defines the list of available options for resolving conflict. More...
enum  LongTransactionFreezeOperations {
  LongTransactionFreezeOperations_Freeze = FdoLongTransactionFreezeOperations_Freeze,
  LongTransactionFreezeOperations_Thaw = FdoLongTransactionFreezeOperations_Thaw
}
 The LongTransactionFreezeOperations enumeration defines the list of available operations that can be performed by the FreezeLongTransaction command. More...
enum  LongTransactionPrivilegeOperations {
  LongTransactionPrivilegeOperations_Grant = FdoLongTransactionPrivilegeOperations_Grant,
  LongTransactionPrivilegeOperations_Revoke = FdoLongTransactionPrivilegeOperations_Revoke
}
 The LongTransactionPrivilegeOperations enumeration defines the list of available operations that can be performed by the ChangeLongTransactionPrivileges command. More...
enum  LongTransactionPrivileges {
  LongTransactionPrivileges_Access = FdoLongTransactionPrivileges_Access,
  LongTransactionPrivileges_Create = FdoLongTransactionPrivileges_Create,
  LongTransactionPrivileges_Commit = FdoLongTransactionPrivileges_Commit,
  LongTransactionPrivileges_Rollback = FdoLongTransactionPrivileges_Rollback,
  LongTransactionPrivileges_Remove = FdoLongTransactionPrivileges_Remove,
  LongTransactionPrivileges_Freeze = FdoLongTransactionPrivileges_Freeze
}
 The LongTransactionPrivileges enumeration defines the long transaction privilege flags. More...
enum  LongTransactionSetOperations {
  LongTransactionSetOperations_Add = FdoLongTransactionSetOperations_Add,
  LongTransactionSetOperations_Remove = FdoLongTransactionSetOperations_Remove,
  LongTransactionSetOperations_Clear = FdoLongTransactionSetOperations_Clear
}
 The LongTransactionSetOperations enumeration defines the list of available operations that can be performed by the ChangeLongTransactionSet command. More...

Functions

System::Void Close ()
 Closes the ILongTransactionCheckpointReader object, freeing any resources it may be holding.
System::Void Execute ()
 Executes the activate long transaction command. An exception is thrown if the long transaction does not exist or the user does not have access privileges to the long transaction.
__property System::String * get_CheckpointDescription ()
 Gets the description of the checkpoint to be created for the named long transaction.
__property System::String * get_CheckpointName ()
 Gets the name of the checkpoint to be created for the named long transaction.
__property System::Int32 get_Count ()
 Returns the number of conflicts reported by this enumerator.
__property System::String * get_Description ()
 Gets the description of the long transaction to create as a string.
__property OSGeo::FDO::Commands::PropertyValueCollectionget_Identity ()
 Returns PropertyValueCollection containing the property values that uniquely identify the current feature in conflict.
__property System::String * get_Name ()
 Gets the currently set name of the long transaction for which the long transaction information should be retrieved. If the property is not set, the function returns a NULL pointer.
__property OSGeo::FDO::Commands::LongTransaction::LongTransactionPrivilegeOperations get_Operation ()
 Gets the operation to perform, grant, or revoke.
__property System::Int32 get_Privileges ()
 Gets the privilege flags to grant or revoke.The returned value may be any combination of the values from the LongTransactionPrivileges enumeration combined via a bit-wise or operation.
__property OSGeo::FDO::Commands::LongTransaction::LongTransactionConflictResolution get_Resolution ()
 Gets the LongTransactionConflictResolution value to use for the current feature. The default value is LongTransactionConflictResolution_Child.
__property System::String * get_UserName ()
 Gets the name of the user for which to grant or revoke privileges.
System::String * GetCheckpointDescription ()
 Gets the description of the checkpoint currently being read.
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 ()
 Gets the creation date of the checkpoint currently being read.
System::String * GetDescription ()
 Retrieves the description 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::Int32 GetPrivileges ()
 Gets the privileges granted to the user currently being read. The returned value may be any combination of the values from the LongTransactionPrivileges enumeration combined via a bit-wise or operation.
System::Boolean IsActive ()
 Returns true if the checkpoint currently being read is the active checkpoint.
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.
System::Void Reset ()
 Sets the enumerator to its initial position, which is before the first conflict.
__property System::Void set_CheckpointDescription (System::String *value)
 Sets the description of the checkpoint to be created for the named long transaction.
__property System::Void set_CheckpointName (System::String *value)
 Sets the name of the checkpoint to be activated for the named long transaction. If the property's value is empty the system will activate the most recent checkpoint of the long transaction.
__property System::Void set_Description (System::String *value)
 Sets the description of the long transaction to create as a string.
__property System::Void set_LongTransactionName (System::String *value)
 Sets the name of the long transaction for which privileges should be changed.
__property System::Void set_Name (System::String *value)
 Sets the name of the long transaction to activate as a string.
__property System::Void set_Operation (OSGeo::FDO::Commands::LongTransaction::LongTransactionFreezeOperations value)
 Sets the operation to perform (Freeze or Thaw) on the long transaction.
__property System::Void set_Operation (OSGeo::FDO::Commands::LongTransaction::LongTransactionSetOperations value)
 Sets the operation to perform, add, remove, or clear.
__property System::Void set_Operation (OSGeo::FDO::Commands::LongTransaction::LongTransactionPrivilegeOperations value)
 Sets the operation to perform, grant, or revoke.
__property System::Void set_Privileges (System::Int32 value)
 Sets the privilege flags to grant or revoke. The privileges value may be any combination of the values from the LongTransactionPrivileges enumeration combined via a bit-wise or operation.
__property System::Void set_Resolution (OSGeo::FDO::Commands::LongTransaction::LongTransactionConflictResolution value)
 Sets the LongTransactionConflictResolution value to use for the current feature. The default value is LongTransactionConflictResolution_Child.
__property System::Void set_UserName (System::String *value)
 Sets the name of the user for which to grant or revoke privileges.

Variables

public __gc __interface IActivateLongTransaction
public __gc __interface IActivateLongTransactionCheckpoint
public __gc __interface IChangeLongTransactionPrivileges
public __gc __interface IChangeLongTransactionSet
public __gc __interface ICommitLongTransaction
public __gc __interface ICreateLongTransaction
public __gc __interface ICreateLongTransactionCheckpoint
public __gc __interface IDeactivateLongTransaction
public __gc __interface IFreezeLongTransaction
public __gc __interface IGetLongTransactionCheckpoints
public __gc __interface IGetLongTransactionPrivileges
public __gc __interface IGetLongTransactions
public __gc __interface IGetLongTransactionsInSet
public __gc __interface ILongTransactionCheckpointReader
public __gc __interface ILongTransactionConflictDirectiveEnumerator
public __gc __interface ILongTransactionPrivilegeReader
public __gc __interface ILongTransactionReader
public __gc __interface ILongTransactionSetReader
public __gc __interface IRollbackLongTransaction
public __gc __interface IRollbackLongTransactionCheckpoint

Enumeration Type Documentation

enum LongTransactionConflictResolution
 

The LongTransactionConflictResolution enumeration defines the list of available options for resolving conflict.

Enumeration values:
LongTransactionConflictResolution_Unresolved  Indicates that the conflict cannot be resolved.
LongTransactionConflictResolution_Child  Indicates the data is to be kept as defined in the long transaction to be committed, overwriting the data in the long transaction's parent.
LongTransactionConflictResolution_Parent  Indicates the data is to be kept as defined in the versions parent, discarding the data as defined in the long transaction to be committed.

enum LongTransactionFreezeOperations
 

The LongTransactionFreezeOperations enumeration defines the list of available operations that can be performed by the FreezeLongTransaction command.

Enumeration values:
LongTransactionFreezeOperations_Freeze  Freeze the long transaction for exclusive update.
LongTransactionFreezeOperations_Thaw  Thaw the long transaction.

enum LongTransactionPrivilegeOperations
 

The LongTransactionPrivilegeOperations enumeration defines the list of available operations that can be performed by the ChangeLongTransactionPrivileges command.

Enumeration values:
LongTransactionPrivilegeOperations_Grant  Indicates the user is to be granted the specified privileges.
LongTransactionPrivilegeOperations_Revoke  Indicates the specified privileges are to be revoked from the user.

enum LongTransactionPrivileges
 

The LongTransactionPrivileges enumeration defines the long transaction privilege flags.

Enumeration values:
LongTransactionPrivileges_Access  The access privilege is required for a user if the user needs to access a long transaction.
LongTransactionPrivileges_Create  A user must have access and create privileges on the active long transaction if the user wants to create a new long transaction as a descendent of the active long transaction.
LongTransactionPrivileges_Commit  A user must have access and commit privileges on a long transaction in order to commit it. In addition, the user needs access privilege to the long transaction's parent. The user also needs remove privilege on the long transaction to be committed if the operation to be executed is a commit and not a partial commit.
LongTransactionPrivileges_Rollback  A user must have access and rollback privileges on a long transaction in order to roll it back. In addition, the user requires access privilege for each of the descendent versions involved in the operation. The user also requires the remove privilege for each of the versions involved in the operation if a rollback and not a partial rollback operation is executed.
LongTransactionPrivileges_Remove  The long transaction privilege is required if the user should be allowed to remove the long transaction in the progress of a commit or roll back operation.
LongTransactionPrivileges_Freeze  The user requires the access and freeze privileges on a long transaction for which the user wants to gain exclusive access to a long transaction.

enum LongTransactionSetOperations
 

The LongTransactionSetOperations enumeration defines the list of available operations that can be performed by the ChangeLongTransactionSet command.

Enumeration values:
LongTransactionSetOperations_Add  Add the specified long transaction to the selection set.
LongTransactionSetOperations_Remove  Remove the specified long transaction from the selection set.
LongTransactionSetOperations_Clear  Clear the selection set.

Function Documentation

System::Void Close  ) 
 

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

Returns:
Returns nothing

System::Void Execute  ) 
 

Executes the activate long transaction command. An exception is thrown if the long transaction does not exist or the user does not have access privileges to the long transaction.

Returns:
Returns nothing

__property System::String* get_CheckpointDescription  ) 
 

Gets the description of the checkpoint to be created for the named long transaction.

Returns:
Returns the description of the checkpoint

__property System::String* get_CheckpointName  ) 
 

Gets the name of the checkpoint to be created for the named long transaction.

Returns:
Returns the checkpoint name

__property System::Int32 get_Count  ) 
 

Returns the number of conflicts reported by this enumerator.

Returns:
Returns the number of conflicts

__property System::String* get_Description  ) 
 

Gets the description of the long transaction to create as a string.

Returns:
Returns the description of the long transaction

__property OSGeo ::FDO ::Commands ::PropertyValueCollection* get_Identity  ) 
 

Returns PropertyValueCollection containing the property values that uniquely identify the current feature in conflict.

Returns:
Returns PropertyValueCollection

__property System::String* get_Name  ) 
 

Gets the currently set name of the long transaction for which the long transaction information should be retrieved. If the property is not set, the function returns a NULL pointer.

Returns:
Returns a long transaction name.

__property OSGeo ::FDO ::Commands ::LongTransaction ::LongTransactionPrivilegeOperations get_Operation  ) 
 

Gets the operation to perform, grant, or revoke.

Returns:
Returns the operation to perform

__property System::Int32 get_Privileges  ) 
 

Gets the privilege flags to grant or revoke.The returned value may be any combination of the values from the LongTransactionPrivileges enumeration combined via a bit-wise or operation.

Returns:
Returns the privileges as a bit masked value based on LongTransactionPrivileges enumeration

__property OSGeo ::FDO ::Commands ::LongTransaction ::LongTransactionConflictResolution get_Resolution  ) 
 

Gets the LongTransactionConflictResolution value to use for the current feature. The default value is LongTransactionConflictResolution_Child.

Returns:
Returns LongTransactionConflictResolution value

__property System::String* get_UserName  ) 
 

Gets the name of the user for which to grant or revoke privileges.

Returns:
Returns the user name

System::String* GetCheckpointDescription  ) 
 

Gets the description of the checkpoint currently being read.

Returns:
Returns the checkpoint description

OSGeo ::FDO ::Commands ::LongTransaction ::ILongTransactionReader* 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 GetCreationDate  ) 
 

Gets the creation date of the checkpoint currently being read.

Returns:
Returns the creation date

System::String* GetDescription  ) 
 

Retrieves the description of the long transaction currently being read.

Returns:
Returns the description of the long transaction.

System::String* GetOwner  ) 
 

Retrieves the owner of the long transaction currently being read.

Returns:
Returns the owner name.

OSGeo ::FDO ::Commands ::LongTransaction ::ILongTransactionReader* 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::Int32 GetPrivileges  ) 
 

Gets the privileges granted to the user currently being read. The returned value may be any combination of the values from the LongTransactionPrivileges enumeration combined via a bit-wise or operation.

Returns:
Returns the privileges as a bit masked value based on LongTransactionPrivileges enumeration

System::Boolean IsActive  ) 
 

Returns true if the checkpoint currently being read is the active checkpoint.

Returns:
Returns true if the checkpoint is active.

System::Boolean IsFrozen  ) 
 

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

Returns:
Returns true if the long transaction 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.

Returns:
Returns true if there is a next item.

System::Void Reset  ) 
 

Sets the enumerator to its initial position, which is before the first conflict.

Returns:
Returns nothing

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

Sets the description of the checkpoint to be created for the named long transaction.

Parameters:
value Input the description of the checkpoint
Returns:
Returns nothing

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

Sets the name of the checkpoint to be activated for the named long transaction. If the property's value is empty the system will activate the most recent checkpoint of the long transaction.

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

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

Sets the description of the long transaction to create as a string.

Parameters:
value Input the description of the long transaction
Returns:
Returns nothing

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

Sets the name of the long transaction for which privileges should be changed.

Parameters:
value Input the name of the long transaction
Returns:
Returns nothing

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

Sets the name of the long transaction to activate as a string.

Parameters:
value Input the name of the long transaction
Returns:
Returns nothing

__property System::Void set_Operation OSGeo::FDO::Commands::LongTransaction::LongTransactionFreezeOperations  value  ) 
 

Sets the operation to perform (Freeze or Thaw) on the long transaction.

Parameters:
value Input the operation to perform
Returns:
Returns nothing

__property System::Void set_Operation OSGeo::FDO::Commands::LongTransaction::LongTransactionSetOperations  value  ) 
 

Sets the operation to perform, add, remove, or clear.

Parameters:
value Input the operation to perform
Returns:
Returns nothing

__property System::Void set_Operation OSGeo::FDO::Commands::LongTransaction::LongTransactionPrivilegeOperations  value  ) 
 

Sets the operation to perform, grant, or revoke.

Parameters:
value Input the operation to perform
Returns:
Returns nothing

__property System::Void set_Privileges System::Int32  value  ) 
 

Sets the privilege flags to grant or revoke. The privileges value may be any combination of the values from the LongTransactionPrivileges enumeration combined via a bit-wise or operation.

Parameters:
value Input the privileges as a bit masked value based on LongTransactionPrivileges enumeration
Returns:
Returns nothing

__property System::Void set_Resolution OSGeo::FDO::Commands::LongTransaction::LongTransactionConflictResolution  value  ) 
 

Sets the LongTransactionConflictResolution value to use for the current feature. The default value is LongTransactionConflictResolution_Child.

Parameters:
value Input the LongTransactionConflictResolution value
Returns:
Returns nothing

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

Sets the name of the user for which to grant or revoke privileges.

Parameters:
value Input the user name
Returns:
Returns nothing

Variable Documentation

public __gc __interface OSGeo::FDO::Commands::LongTransaction::IActivateLongTransaction
 

public __gc __interface OSGeo::FDO::Commands::LongTransaction::IActivateLongTransactionCheckpoint
 

public __gc __interface OSGeo::FDO::Commands::LongTransaction::IChangeLongTransactionPrivileges
 

public __gc __interface OSGeo::FDO::Commands::LongTransaction::IChangeLongTransactionSet
 

public __gc __interface OSGeo::FDO::Commands::LongTransaction::ICommitLongTransaction
 

public __gc __interface OSGeo::FDO::Commands::LongTransaction::ICreateLongTransaction
 

public __gc __interface OSGeo::FDO::Commands::LongTransaction::ICreateLongTransactionCheckpoint
 

public __gc __interface OSGeo::FDO::Commands::LongTransaction::IDeactivateLongTransaction
 

public __gc __interface OSGeo::FDO::Commands::LongTransaction::IFreezeLongTransaction
 

public __gc __interface OSGeo::FDO::Commands::LongTransaction::IGetLongTransactionCheckpoints
 

public __gc __interface OSGeo::FDO::Commands::LongTransaction::IGetLongTransactionPrivileges
 

public __gc __interface OSGeo::FDO::Commands::LongTransaction::IGetLongTransactions
 

public __gc __interface OSGeo::FDO::Commands::LongTransaction::IGetLongTransactionsInSet
 

public __gc __interface OSGeo::FDO::Commands::LongTransaction::ILongTransactionCheckpointReader
 

public __gc __interface OSGeo::FDO::Commands::LongTransaction::ILongTransactionConflictDirectiveEnumerator
 

public __gc __interface OSGeo::FDO::Commands::LongTransaction::ILongTransactionPrivilegeReader
 

public __gc __interface OSGeo::FDO::Commands::LongTransaction::ILongTransactionReader
 

public __gc __interface OSGeo::FDO::Commands::LongTransaction::ILongTransactionSetReader
 

public __gc __interface OSGeo::FDO::Commands::LongTransaction::IRollbackLongTransaction
 

public __gc __interface OSGeo::FDO::Commands::LongTransaction::IRollbackLongTransactionCheckpoint
 


Comments or suggestions? Send us feedback.