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


Classes

class  OSGeo::FDO::Commands::BatchParameterValueCollection
 The BatchParameterValueCollection class represents a collection of parameter value collections that is used for optimized batch inserts. More...
class  OSGeo::FDO::Commands::BatchParameterValueCollection::Enumerator
 DOXYGEN-IGNORE A Nested class defined to provide enumeration of Dictionary elements
class  OSGeo::FDO::Commands::ICommandImp
 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. More...
class  OSGeo::FDO::Commands::IdentifierCollection
 The IdentifierCollection class represents a collection of FDO Identifier objects. More...
class  OSGeo::FDO::Commands::IdentifierCollection::Enumerator
 DOXYGEN-IGNORE A Nested class defined to provide enumeration of Dictionary elements
class  OSGeo::FDO::Commands::IFeatureCommandImp
 The IFeatureCommandImp class is a concrete implementation of IFeatureCommand. IFeatureCommand defines the behavior common to all commands that operate on feature instances. The features to be operated on are identified by their class and a filter. If the feature provider supports inheritance in the schema capabilities, then the command will operate on instances of that class and any derived classes. In addition, feature commands can operate on related features if one or more relation directives are specified. Each relation directive specifies the relation to follow and how many levels of depth to follow it. More...
interface  OSGeo::FDO::Commands::OSGeo::FDO::Commands::ICommand
 The ICommand interface 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. More...
interface  OSGeo::FDO::Commands::OSGeo::FDO::Commands::IFeatureCommand
 The IFeatureCommand interface defines the behavior common to all commands that operate on feature instances. The features to be operated on are identified by their class and a filter. If the feature provider supports inheritance in the schema capabilities, then the command will operate on instances of that class and any derived classes. In addition, feature commands can operate on related features if one or more relation directives are specified. Each relation directive specifies the relation to follow and how many levels of depth to follow it. More...
class  OSGeo::FDO::Commands::ParameterValue
 The ParameterValue class specifies a value for a particular parameter. Instances of this class are used to specify a value to bind to a parameter when a command is executed. More...
class  OSGeo::FDO::Commands::ParameterValueCollection
 The ParameterValueCollection class represents a collection of ParameterValue objects. More...
class  OSGeo::FDO::Commands::ParameterValueCollection::Enumerator
 DOXYGEN-IGNORE A Nested class defined to provide enumeration of Dictionary elements
class  OSGeo::FDO::Commands::PropertyValue
 The PropertyValue class represents a property name/value pair. Instances of this class are used to specify or hold onto a reference to a property name and the properties value. More...
class  OSGeo::FDO::Commands::PropertyValueCollection
 The PropertyValueCollection class represents a collection of PropertyValue objects. More...
class  OSGeo::FDO::Commands::PropertyValueCollection::Enumerator
 DOXYGEN-IGNORE A Nested class defined to provide enumeration of Dictionary elements

Enumerations

enum  CommandType {
  CommandType_Select = FdoCommandType_Select,
  CommandType_Insert = FdoCommandType_Insert,
  CommandType_Delete = FdoCommandType_Delete,
  CommandType_Update = FdoCommandType_Update,
  CommandType_DescribeSchema = FdoCommandType_DescribeSchema,
  CommandType_DescribeSchemaMapping = FdoCommandType_DescribeSchemaMapping,
  CommandType_ApplySchema = FdoCommandType_ApplySchema,
  CommandType_DestroySchema = FdoCommandType_DestroySchema,
  CommandType_ActivateSpatialContext = FdoCommandType_ActivateSpatialContext,
  CommandType_CreateSpatialContext = FdoCommandType_CreateSpatialContext,
  CommandType_DestroySpatialContext = FdoCommandType_DestroySpatialContext,
  CommandType_GetSpatialContexts = FdoCommandType_GetSpatialContexts,
  CommandType_CreateMeasureUnit = FdoCommandType_CreateMeasureUnit,
  CommandType_DestroyMeasureUnit = FdoCommandType_DestroyMeasureUnit,
  CommandType_GetMeasureUnits = FdoCommandType_GetMeasureUnits,
  CommandType_SQLCommand = FdoCommandType_SQLCommand,
  CommandType_AcquireLock = FdoCommandType_AcquireLock,
  CommandType_GetLockInfo = FdoCommandType_GetLockInfo,
  CommandType_GetLockedObjects = FdoCommandType_GetLockedObjects,
  CommandType_GetLockOwners = FdoCommandType_GetLockOwners,
  CommandType_ReleaseLock = FdoCommandType_ReleaseLock,
  CommandType_ActivateLongTransaction = FdoCommandType_ActivateLongTransaction,
  CommandType_DeactivateLongTransaction = FdoCommandType_DeactivateLongTransaction,
  CommandType_CommitLongTransaction = FdoCommandType_CommitLongTransaction,
  CommandType_CreateLongTransaction = FdoCommandType_CreateLongTransaction,
  CommandType_GetLongTransactions = FdoCommandType_GetLongTransactions,
  CommandType_FreezeLongTransaction = FdoCommandType_FreezeLongTransaction,
  CommandType_RollbackLongTransaction = FdoCommandType_RollbackLongTransaction,
  CommandType_ActivateLongTransactionCheckpoint = FdoCommandType_ActivateLongTransactionCheckpoint,
  CommandType_CreateLongTransactionCheckpoint = FdoCommandType_CreateLongTransactionCheckpoint,
  CommandType_GetLongTransactionCheckpoints = FdoCommandType_GetLongTransactionCheckpoints,
  CommandType_RollbackLongTransactionCheckpoint = FdoCommandType_RollbackLongTransactionCheckpoint,
  CommandType_ChangeLongTransactionPrivileges = FdoCommandType_ChangeLongTransactionPrivileges,
  CommandType_GetLongTransactionPrivileges = FdoCommandType_GetLongTransactionPrivileges,
  CommandType_ChangeLongTransactionSet = FdoCommandType_ChangeLongTransactionSet,
  CommandType_GetLongTransactionsInSet = FdoCommandType_GetLongTransactionsInSet,
  CommandType_NetworkShortestPath = FdoCommandType_NetworkShortestPath,
  CommandType_NetworkAllPaths = FdoCommandType_NetworkAllPaths,
  CommandType_NetworkReachingNodes = FdoCommandType_NetworkReachingNodes,
  CommandType_NetworkReachableNodes = FdoCommandType_NetworkReachableNodes,
  CommandType_NetworkNearestNeighbors = FdoCommandType_NetworkNearestNeighbors,
  CommandType_NetworkWithinCost = FdoCommandType_NetworkWithinCost,
  CommandType_NetworkTSP = FdoCommandType_NetworkTSP,
  CommandType_ActivateTopologyArea = FdoCommandType_ActivateTopologyArea,
  CommandType_DeactivateTopologyArea = FdoCommandType_DeactivateTopologyArea,
  CommandType_ActivateTopologyInCommandResult = FdoCommandType_ActivateTopologyInCommandResult,
  CommandType_DeactivateTopologyInCommandResults = FdoCommandType_DeactivateTopologyInCommandResults,
  CommandType_SelectAggregates = FdoCommandType_SelectAggregates,
  CommandType_CreateDataStore = FdoCommandType_CreateDataStore,
  CommandType_DestroyDataStore = FdoCommandType_DestroyDataStore,
  CommandType_ListDataStores = FdoCommandType_ListDataStores,
  CommandType_FirstProviderCommand = FdoCommandType_FirstProviderCommand
}
 The CommandType enumeration defines the list of abstract commands a feature provider can support. More...
enum  OrderingOption {
  OrderingOption_Ascending = FdoOrderingOption_Ascending,
  OrderingOption_Descending = FdoOrderingOption_Descending
}
 The OrderingOption enumeration defines the list acceptable values that can be specified as order by clause to the select and select aggregate commands. More...

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::Filter::Filterget_Filter ()
 Gets the filter as a filter tree.
__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_FeatureClassName (OSGeo::FDO::Expression::Identifier *value)
 Sets the name of the class to be operated upon as an identifier.
__property System::Void set_Filter (OSGeo::FDO::Filter::Filter *value)
 Sets the filter as a Filter tree.
__property System::Void set_Transaction (OSGeo::FDO::Connections::ITransaction *value)
 Sets the transaction in which the command executes.
System::Void SetFeatureClassName (System::String *value)
 Sets the name of the class to be operated upon as an identifier.
System::Void SetFilter (System::String *value)
 Sets the filter as a Filter tree.

Variables

public __gc __interface ICommand
public __gc __interface IFeatureCommand

Enumeration Type Documentation

enum CommandType
 

The CommandType enumeration defines the list of abstract commands a feature provider can support.

Enumeration values:
CommandType_Select  Represents the Select command.
CommandType_Insert  Represents the Insert command.
CommandType_Delete  Represents the Delete command.
CommandType_Update  Represents the Update command.
CommandType_DescribeSchema  Represents the DescribeSchema command.
CommandType_DescribeSchemaMapping  Represents the DescribeSchemaMapping command.
CommandType_ApplySchema  Represents the ApplySchema command.
CommandType_DestroySchema  Represents the DestroySchema command.
CommandType_ActivateSpatialContext  Represents the ActivateSpatialContext command.
CommandType_CreateSpatialContext  Represents the CreateSpatialContext command.
CommandType_DestroySpatialContext  Represents the DestroySpatialContext command.
CommandType_GetSpatialContexts  Represents the GetSpatialContexts command.
CommandType_CreateMeasureUnit  Represents the CreateMeasureUnit command.
CommandType_DestroyMeasureUnit  Represents the DestroyMeasureUnit command.
CommandType_GetMeasureUnits  Represents the GetMeasureUnits command.
CommandType_SQLCommand  Represents the SQLCommand command.
CommandType_AcquireLock  Represents the AcquireLock command.
CommandType_GetLockInfo  Represents the GetLockInfo command.
CommandType_GetLockedObjects  Represents the GetLockedObjects command.
CommandType_GetLockOwners  Represents the GetLockOwners command.
CommandType_ReleaseLock  Represents the ReleaseLock command.
CommandType_ActivateLongTransaction  Represents the ActivateLongTransaction command.
CommandType_DeactivateLongTransaction  Represents the DeactivateLongTransaction command.
CommandType_CommitLongTransaction  Represents the CommitLongTransaction command.
CommandType_CreateLongTransaction  Represents the CreateLongTransaction command.
CommandType_GetLongTransactions  Represents the GetLongTransactions command.
CommandType_FreezeLongTransaction  Represents the FreezeLongTransaction command.
CommandType_RollbackLongTransaction  Represents the RollbackLongTransaction command.
CommandType_ActivateLongTransactionCheckpoint  Represents the ActivateLongTransactionCheckpoint command.
CommandType_CreateLongTransactionCheckpoint  Represents the CreateLongTransactionCheckpoint command.
CommandType_GetLongTransactionCheckpoints  Represents the GetLongTransactionCheckpoints command.
CommandType_RollbackLongTransactionCheckpoint  Represents the RollbackLongTransactionCheckpoint command.
CommandType_ChangeLongTransactionPrivileges  Represents the ChangeLongTransactionPrivileges command.
CommandType_GetLongTransactionPrivileges  Represents the GetLongTransactionPrivileges command.
CommandType_ChangeLongTransactionSet  Represents the ChangeLongTransactionSet command.
CommandType_GetLongTransactionsInSet  Represents the GetLongTransactionsInSet command.
CommandType_NetworkShortestPath  Represents the NetworkShortestPath command.
CommandType_NetworkAllPaths  Represents the NetworkAllPaths command.
CommandType_NetworkReachingNodes  Represents the NetworkReachingNodes command.
CommandType_NetworkReachableNodes  Represents the NetworkReachableNodes command.
CommandType_NetworkNearestNeighbors  Represents the NetworkNearestNeighbors command.
CommandType_NetworkWithinCost  Represents the NetworkWithinCost command.
CommandType_NetworkTSP  Represents the NetworkTSP command.
CommandType_ActivateTopologyArea  Represents the ActivateTopologyArea command.
CommandType_DeactivateTopologyArea  Represents the DeactivateTopologyArea command.
CommandType_ActivateTopologyInCommandResult  Represents the ActivateTopologyInCommandResult command.
CommandType_DeactivateTopologyInCommandResults  Represents the DeactivateTopologyInCommandResults command.
CommandType_SelectAggregates  Represents the SelectAggregate command.
CommandType_CreateDataStore  Represents the CreateDataStore command.
CommandType_DestroyDataStore  Represents the DestroyDataStore command.
CommandType_ListDataStores  Represents the ListDataStores command.
CommandType_FirstProviderCommand  Represents the index of the first provider specific command.

enum OrderingOption
 

The OrderingOption enumeration defines the list acceptable values that can be specified as order by clause to the select and select aggregate commands.

Enumeration values:
OrderingOption_Ascending  Used for ascending option.
OrderingOption_Descending  Used for descending option.

Function Documentation

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.

Returns:
Returns nothing

__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.

Returns:
Returns the time (in milliseconds)

__property OSGeo ::FDO ::Filter ::Filter* get_Filter  ) 
 

Gets the filter as a filter tree.

Returns:
Returns the filter object

__property OSGeo ::FDO ::Commands ::ParameterValueCollection* 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* get_Transaction  ) 
 

Gets the transaction in which the command executes.

Returns:
Returns the transaction object

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.

Returns:
Returns nothing

__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.

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

__property System::Void set_FeatureClassName OSGeo::FDO::Expression::Identifier value  ) 
 

Sets the name of the class to be operated upon as an identifier.

Parameters:
value Input the class identifier
Returns:
Returns nothing

__property System::Void set_Filter OSGeo::FDO::Filter::Filter value  ) 
 

Sets the filter as a Filter tree.

Parameters:
value Input the filter object
Returns:
Returns nothing

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

Sets the transaction in which the command executes.

Parameters:
value Input the transaction object
Returns:
Returns nothing

System::Void SetFeatureClassName System::String *  value  ) 
 

Sets the name of the class to be operated upon as an identifier.

Parameters:
value Input the class name
Returns:
Returns nothing

System::Void SetFilter System::String *  value  ) 
 

Sets the filter as a Filter tree.

Parameters:
value Input the filter expression string
Returns:
Returns nothing

Variable Documentation

public __gc __interface OSGeo::FDO::Commands::ICommand
 

public __gc __interface OSGeo::FDO::Commands::IFeatureCommand
 


Comments or suggestions? Send us feedback.