FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoIBaseSelect Class Reference

#include <IBaseSelect.h>

Inherits FdoIFeatureCommand.

Inherited by FdoISelect, and FdoISelectAggregates.

Inheritance diagram for FdoIBaseSelect:

[legend]
List of all members.

Detailed Description

The FdoISelect interface defines the Select command, which queries for features of a given class that match the specified criteria. Input to the select command includes the name of the class, the list of properties to be returned, and a filter. All but the class name is optional. If the list of properties to be returned is empty then all properties are returned. The filter may be specified either as text or as an expression tree (most likely produced by a query builder). The result of executing a select command is an FdoIFeatureReader reference (see "Reading Features"). If the feature provider supports locking, then the select command can optionally lock all of the features selected, via the ExecuteWithLock method (see "Locking Commands" for more information on locking features).

Definition at line 48 of file IBaseSelect.h.


Public Member Functions

virtual FDO_API FdoIdentifierCollectionGetOrdering ()=0
 Gets the FdoIdentifierCollection that holds the list of order by property names. If empty no ordering is used. This list is initially empty and the caller need to add the property that the command should use as a order by criteria.
virtual FDO_API FdoOrderingOption GetOrderingOption ()=0
 Gets the ordering option.
virtual FDO_API FdoIdentifierCollectionGetPropertyNames ()=0
 Gets the FdoIdentifierCollection that holds the list of property names to return with the result. If empty all properties of the specified class are returned.
virtual FDO_API void SetOrderingOption (FdoOrderingOption option)=0
 Set the ordering option of the selection. This is only used if the ordering collection is not empty.

Friends

class FdoIConnection

Member Function Documentation

virtual FDO_API FdoIdentifierCollection* FdoIBaseSelect::GetOrdering  )  [pure virtual]
 

Gets the FdoIdentifierCollection that holds the list of order by property names. If empty no ordering is used. This list is initially empty and the caller need to add the property that the command should use as a order by criteria.

Returns:
Returns the list of group by property names.

virtual FDO_API FdoOrderingOption FdoIBaseSelect::GetOrderingOption  )  [pure virtual]
 

Gets the ordering option.

Returns:
Returns the ordering option.

virtual FDO_API FdoIdentifierCollection* FdoIBaseSelect::GetPropertyNames  )  [pure virtual]
 

Gets the FdoIdentifierCollection that holds the list of property names to return with the result. If empty all properties of the specified class are returned.

Returns:
Returns the list of property names.

virtual FDO_API void FdoIBaseSelect::SetOrderingOption FdoOrderingOption  option  )  [pure virtual]
 

Set the ordering option of the selection. This is only used if the ordering collection is not empty.

Parameters:
option Is the ordering option and should be set to one of FdoOrderingOption_Ascending or FdoOrderingOption_Descending. FdoOrderingOption_Ascending is the default value.
Returns:
Returns nothing

Friends And Related Function Documentation

friend class FdoIConnection [friend]
 

Reimplemented from FdoIFeatureCommand.

Reimplemented in FdoISelect, and FdoISelectAggregates.

Definition at line 50 of file IBaseSelect.h.


The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.