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::Schema::IDescribeSchemaImp Class Reference

Inherits OSGeo::FDO::Commands::ICommandImp, and OSGeo::FDO::Commands::Schema::OSGeo::FDO::Commands::Schema::IDescribeSchema.

Inheritance diagram for OSGeo::FDO::Commands::Schema::IDescribeSchemaImp:

[legend]
List of all members.

Detailed Description

The IDescribeSchemaImp class is a concrete implementation of IDescribeSchema. The IDescribeSchema interface defines the DescribeSchema command, which describes the feature schemas available from the connection. The DescribeSchema command can describe a single schema or all schemas available from the connection. The Execute operation returns an FeatureSchemaCollection object.


Public Member Functions

OSGeo::FDO::Schema::FeatureSchemaCollectionExecute ()
 Executes the DescribeSchema command and returns a FeatureSchemaCollection. If a schema name is given that has references to another schema, the dependent schemas will be returned as well. If the specified schema name does not exist, the Execute method throws an exception.
__property System::String * get_SchemaName ()
 Gets the name of the schema to describe. This function is optional; if not specified, execution of the command will describe all schemas.
__property System::Void set_SchemaName (System::String *value)
 Sets the name of the schema to describe. This function is optional; if not specified execution of the command will describe all schemas.

Member Function Documentation

OSGeo ::FDO ::Schema ::FeatureSchemaCollection* OSGeo::FDO::Commands::Schema::IDescribeSchemaImp::Execute  ) 
 

Executes the DescribeSchema command and returns a FeatureSchemaCollection. If a schema name is given that has references to another schema, the dependent schemas will be returned as well. If the specified schema name does not exist, the Execute method throws an exception.

Returns:
Returns the schema collection representing the schema created. The element states for all elements will be set to SchemaElementState_Unchanged. Each provider-specific implementation of Execute() can ensure that this is the case by calling FeatureSchema::AcceptChanges() for each feature schema in the returned collection.

__property System::String* OSGeo::FDO::Commands::Schema::IDescribeSchemaImp::get_SchemaName  ) 
 

Gets the name of the schema to describe. This function is optional; if not specified, execution of the command will describe all schemas.

Returns:
Returns the schema name

__property System::Void OSGeo::FDO::Commands::Schema::IDescribeSchemaImp::set_SchemaName System::String *  value  ) 
 

Sets the name of the schema to describe. This function is optional; if not specified execution of the command will describe all schemas.

Parameters:
value Input the schema name
Returns:
Returns nothing

Comments or suggestions? Send us feedback.