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

Inherits OSGeo::FDO::Runtime::Disposable, and OSGeo::FDO::Commands::OSGeo::FDO::Commands::ICommand.

Inherited by OSGeo::FDO::Commands::DataStore::ICreateDataStoreImp, OSGeo::FDO::Commands::DataStore::IDestroyDataStoreImp, OSGeo::FDO::Commands::DataStore::IListDataStoresImp, OSGeo::FDO::Commands::Feature::IInsertImp, OSGeo::FDO::Commands::IFeatureCommandImp, OSGeo::FDO::Commands::Locking::IGetLockedObjectsImp, OSGeo::FDO::Commands::Locking::IGetLockOwnersImp, OSGeo::FDO::Commands::LongTransaction::IActivateLongTransactionCheckpointImp, OSGeo::FDO::Commands::LongTransaction::IActivateLongTransactionImp, OSGeo::FDO::Commands::LongTransaction::IChangeLongTransactionPrivilegesImp, OSGeo::FDO::Commands::LongTransaction::IChangeLongTransactionSetImp, OSGeo::FDO::Commands::LongTransaction::ICreateLongTransactionCheckpointImp, OSGeo::FDO::Commands::LongTransaction::ICreateLongTransactionImp, OSGeo::FDO::Commands::LongTransaction::IDeactivateLongTransactionImp, OSGeo::FDO::Commands::LongTransaction::IFreezeLongTransactionImp, OSGeo::FDO::Commands::LongTransaction::IGetLongTransactionCheckpointsImp, OSGeo::FDO::Commands::LongTransaction::IGetLongTransactionPrivilegesImp, OSGeo::FDO::Commands::LongTransaction::IGetLongTransactionsImp, OSGeo::FDO::Commands::LongTransaction::IGetLongTransactionsInSetImp, OSGeo::FDO::Commands::LongTransaction::IRollbackLongTransactionCheckpointImp, OSGeo::FDO::Commands::Schema::IApplySchemaImp, OSGeo::FDO::Commands::Schema::IDescribeSchemaImp, OSGeo::FDO::Commands::Schema::IDescribeSchemaMappingImp, OSGeo::FDO::Commands::Schema::IDestroySchemaImp, OSGeo::FDO::Commands::SpatialContext::IActivateSpatialContextImp, OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp, OSGeo::FDO::Commands::SpatialContext::IDestroySpatialContextImp, OSGeo::FDO::Commands::SpatialContext::IGetSpatialContextsImp, OSGeo::FDO::Commands::SQL::ISQLCommandImp, OSGeo::FDO::Commands::UnitOfMeasure::ICreateMeasureUnitImp, OSGeo::FDO::Commands::UnitOfMeasure::IDestroyMeasureUnitImp, and OSGeo::FDO::Commands::UnitOfMeasure::IGetMeasureUnitsImp.

Inheritance diagram for OSGeo::FDO::Commands::ICommandImp:

[legend]
List of all members.

Detailed Description

The ICommandImp class is a concrete instantiation of interface ICommand. ICommand defines behavior common to all commands in FDO. In order to be executed, commands must have an association to a connection. Commands can also be optionally associated with a transaction if the connection supports transactions. The parameter values collection allows values to be specified for commands that support expressions and/or filters.


Public Member Functions

System::Void Cancel ()
 Attempts to cancel command execution. Cancel may be called on a separate thread after the commands Execute method has been called and before Execute has returned. If successful, an exception is thrown from the Execute method. If there is nothing to cancel, nothing happens. If command execution is in process, and the attempt to cancel fails or is not supported, an exception is thrown.
__property System::Int32 get_CommandTimeOut ()
 Gets the number of milliseconds to wait before terminating the attempt to execute a command and generating an error. If the provider does not support the timeout capability, 0 is returned.
__property OSGeo::FDO::Connections::IConnectionget_Connection ()
 Gets the IConnection that this command will operate on.
__property OSGeo::FDO::Commands::ParameterValueCollectionget_ParameterValues ()
 Returns an ParameterValueCollection. If the command requires parameters, the literal values to bind to each of those named parameters must be added to this collection.
__property OSGeo::FDO::Connections::ITransactionget_Transaction ()
 Gets the transaction in which the command executes.
System::Void Prepare ()
 Validates and optimizes the command for execution. Calling this method is optional, but recommended if bound to different sets of parameters and executed multiple times.
__property System::Void set_CommandTimeOut (System::Int32 value)
 Sets the number of milliseconds to wait before terminating the attempt to execute a command and generating an error. If the provider does not support the timeout capability, then attempting to set a timeout will result in an exception.
__property System::Void set_Transaction (OSGeo::FDO::Connections::ITransaction *value)
 Sets the transaction in which the command executes.

Protected Member Functions

 ICommandImp (System::IntPtr unmanaged, System::Boolean autoDelete)
 
System::Void ReleaseUnmanagedObject ()
 DOXYGEN-IGNORE

Constructor & Destructor Documentation

OSGeo::FDO::Commands::ICommandImp::ICommandImp System::IntPtr  unmanaged,
System::Boolean  autoDelete
[protected]
 


Member Function Documentation

System::Void OSGeo::FDO::Commands::ICommandImp::Cancel  ) 
 

Attempts to cancel command execution. Cancel may be called on a separate thread after the commands Execute method has been called and before Execute has returned. If successful, an exception is thrown from the Execute method. If there is nothing to cancel, nothing happens. If command execution is in process, and the attempt to cancel fails or is not supported, an exception is thrown.

Returns:
Returns nothing

__property System::Int32 OSGeo::FDO::Commands::ICommandImp::get_CommandTimeOut  ) 
 

Gets the number of milliseconds to wait before terminating the attempt to execute a command and generating an error. If the provider does not support the timeout capability, 0 is returned.

Returns:
Returns the time (in milliseconds)

__property OSGeo ::FDO ::Connections ::IConnection* OSGeo::FDO::Commands::ICommandImp::get_Connection  ) 
 

Gets the IConnection that this command will operate on.

Returns:
Returns the connection object

__property OSGeo ::FDO ::Commands ::ParameterValueCollection* OSGeo::FDO::Commands::ICommandImp::get_ParameterValues  ) 
 

Returns an ParameterValueCollection. If the command requires parameters, the literal values to bind to each of those named parameters must be added to this collection.

Returns:
Returns the list of parameters and their respective values

__property OSGeo ::FDO ::Connections ::ITransaction* OSGeo::FDO::Commands::ICommandImp::get_Transaction  ) 
 

Gets the transaction in which the command executes.

Returns:
Returns the transaction object

System::Void OSGeo::FDO::Commands::ICommandImp::Prepare  ) 
 

Validates and optimizes the command for execution. Calling this method is optional, but recommended if bound to different sets of parameters and executed multiple times.

Returns:
Returns nothing

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

DOXYGEN-IGNORE

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

__property System::Void OSGeo::FDO::Commands::ICommandImp::set_CommandTimeOut System::Int32  value  ) 
 

Sets the number of milliseconds to wait before terminating the attempt to execute a command and generating an error. If the provider does not support the timeout capability, then attempting to set a timeout will result in an exception.

Parameters:
value Input the time (in milliseconds)
Returns:
Returns nothing

__property System::Void OSGeo::FDO::Commands::ICommandImp::set_Transaction OSGeo::FDO::Connections::ITransaction value  ) 
 

Sets the transaction in which the command executes.

Parameters:
value Input the transaction object
Returns:
Returns nothing

Comments or suggestions? Send us feedback.