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

FdoISchemaCapabilities Class Reference

#include <ISchemaCapabilities.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoISchemaCapabilities:

[legend]
List of all members.

Detailed Description

The FdoISchemaCapbilities interface declares the feature provider's level of support for the Feature Schema.

Definition at line 34 of file ISchemaCapabilities.h.


Public Member Functions

virtual FDO_API FdoClassTypeGetClassTypes (FdoInt32 &length)=0
 Returns an array of the FdoClassType objects the feature provider supports.
virtual FDO_API FdoDataTypeGetDataTypes (FdoInt32 &length)=0
 Returns an array of the FdoDataType objects the feature provider supports.
virtual FDO_API FdoInt64 GetMaximumDataValueLength (FdoDataType dataType)=0
 Returns the maximum supported length of String, BLOB, or CLOB data properties. For decimal, it is typically the combination of the maximum scale and precision. For other data types that are not variable in size, the value returned is the byte length.
virtual FDO_API FdoInt32 GetMaximumDecimalPrecision ()=0
 Returns the maximum supported precision for a decimal data property.
virtual FDO_API FdoInt32 GetMaximumDecimalScale ()=0
 Returns the maximum supported scale for a decimal data property.
virtual FDO_API FdoInt32 GetNameSizeLimit (FdoSchemaElementNameType name)=0
 Returns the maximum size of a value of the given type. It includes limits for the data store name, shema name, class name, property name and description.
virtual FDO_API FdoStringGetReservedCharactersForName ()=0
 Returns a string that includes all the reserved characters that cannot be used for the various schema element names for the provider.
virtual FDO_API FdoDataTypeGetSupportedAutoGeneratedTypes (FdoInt32 &length)=0
 Returns an array of the FdoDataType objects the feature provider supports for auto-generation.
virtual FDO_API FdoDataTypeGetSupportedIdentityPropertyTypes (FdoInt32 &length)=0
 Returns a list of property types that can be used for identity properties.
virtual FDO_API bool SupportsAssociationProperties ()=0
 Determines if the provider supports association property.
virtual FDO_API bool SupportsAutoIdGeneration ()=0
 Determines if the provider can auto-generate unique ID values for a class.
virtual FDO_API bool SupportsCompositeId ()=0
 Determines if the provider supports multiple identity properties per class.
virtual FDO_API bool SupportsCompositeUniqueValueConstraints ()=0
 Determines if the provider supports composite unique value constraint.
virtual FDO_API bool SupportsDataStoreScopeUniqueIdGeneration ()=0
 Determines if the provider can auto-generate unique ID values that are unique for the entire datastore, rather than just for a particular class.
virtual FDO_API bool SupportsDefaultValue ()=0
 Returns TRUE if default values can be specified for a data property definition, FALSE otherwise.
virtual FDO_API bool SupportsExclusiveValueRangeConstraints ()=0
 Determines if the provider supports exclusive value range constraints.
virtual FDO_API bool SupportsInclusiveValueRangeConstraints ()=0
 Determines if the provider supports inclusive value range constraints.
virtual FDO_API bool SupportsInheritance ()=0
 Determines if the feature provider supports inheritance.
FDO_API virtual FDO_DEPRECATED
bool 
SupportsInheritence ()
 DOXYGEN-IGNORE DEPRECATED: Use SupportsInheritance() instead. Determines if the feature provider supports inheritance.
virtual FDO_API bool SupportsMultipleSchemas ()=0
 Determines if the provider supports multiple schemas. Returns false if the provider supports only a single schema.
virtual FDO_API bool SupportsNetworkModel ()=0
 Determines if the provider supports the network model.
virtual FDO_API bool SupportsNullValueConstraints ()=0
 Determines if the provider supports nullable value constraint.
virtual FDO_API bool SupportsObjectProperties ()=0
 Determines if the provider supports object properties. Returns false if the provider supports only data and geometric properties.
virtual FDO_API bool SupportsSchemaModification ()=0
 Determines if the provider support update a schema through the ApplySchema command. If False, then an application can only create a schema once for the provider. They can use the ApplySchema command once for a given datastore. Once the schema is defined, it cannot be changed. If True, then the provider supports the ability to modify or add to the schema after it is defined initially.
virtual FDO_API bool SupportsSchemaOverrides ()=0
 Determines if the provider supports Schema Mapping Overrides (overrides to the default rules for mapping Feature Schemas to provider-specific physical schemas).
virtual FDO_API bool SupportsUniqueValueConstraints ()=0
 Determines if the provider supports unique value constraint.
virtual FDO_API bool SupportsValueConstraintsList ()=0
 Determines if the provider supports value constraints list.

Member Function Documentation

virtual FDO_API FdoClassType* FdoISchemaCapabilities::GetClassTypes FdoInt32 length  )  [pure virtual]
 

Returns an array of the FdoClassType objects the feature provider supports.

Parameters:
length Output the number of class types.
Returns:
Returns the list of class types.

virtual FDO_API FdoDataType* FdoISchemaCapabilities::GetDataTypes FdoInt32 length  )  [pure virtual]
 

Returns an array of the FdoDataType objects the feature provider supports.

Parameters:
length Output the number of data types.
Returns:
Returns the list of data types

virtual FDO_API FdoInt64 FdoISchemaCapabilities::GetMaximumDataValueLength FdoDataType  dataType  )  [pure virtual]
 

Returns the maximum supported length of String, BLOB, or CLOB data properties. For decimal, it is typically the combination of the maximum scale and precision. For other data types that are not variable in size, the value returned is the byte length.

Parameters:
dataType The data type for which the information is to retrieved.
Returns:
Returns the maximum data value length for the identified data type.

virtual FDO_API FdoInt32 FdoISchemaCapabilities::GetMaximumDecimalPrecision  )  [pure virtual]
 

Returns the maximum supported precision for a decimal data property.

Returns:
Returns the maximum supported precision for a decimal data property.

virtual FDO_API FdoInt32 FdoISchemaCapabilities::GetMaximumDecimalScale  )  [pure virtual]
 

Returns the maximum supported scale for a decimal data property.

Returns:
Returns the maximum supported scale for a decimal data property.

virtual FDO_API FdoInt32 FdoISchemaCapabilities::GetNameSizeLimit FdoSchemaElementNameType  name  )  [pure virtual]
 

Returns the maximum size of a value of the given type. It includes limits for the data store name, shema name, class name, property name and description.

Parameters:
name The schema element name type identifier for which the information is to be retrieved. Can be any of the following options: FdoSchemaElementNameType_Datastore, FdoSchemaElementNameType_Schema, FdoSchemaElementNameType_Class, FdoSchemaElementNameType_Property or FdoSchemaElementNameType_Description
Returns:
Returns the size limitation for the identified schema element.

virtual FDO_API FdoString* FdoISchemaCapabilities::GetReservedCharactersForName  )  [pure virtual]
 

Returns a string that includes all the reserved characters that cannot be used for the various schema element names for the provider.

Returns:
Returns a string with the reserved characters for the identified schema element.

virtual FDO_API FdoDataType* FdoISchemaCapabilities::GetSupportedAutoGeneratedTypes FdoInt32 length  )  [pure virtual]
 

Returns an array of the FdoDataType objects the feature provider supports for auto-generation.

Parameters:
length Output the number of data types.
Returns:
Returns the list of data types

virtual FDO_API FdoDataType* FdoISchemaCapabilities::GetSupportedIdentityPropertyTypes FdoInt32 length  )  [pure virtual]
 

Returns a list of property types that can be used for identity properties.

Parameters:
length Output the number of data types.
Returns:
Returns a string with the reserved characters for the identified schema element.

virtual FDO_API bool FdoISchemaCapabilities::SupportsAssociationProperties  )  [pure virtual]
 

Determines if the provider supports association property.

Returns:
Returns true if the provider support the association property.

virtual FDO_API bool FdoISchemaCapabilities::SupportsAutoIdGeneration  )  [pure virtual]
 

Determines if the provider can auto-generate unique ID values for a class.

Returns:
Returns true if the provider supports id autogeneration.

virtual FDO_API bool FdoISchemaCapabilities::SupportsCompositeId  )  [pure virtual]
 

Determines if the provider supports multiple identity properties per class.

Returns:
Returns true if the provider supports multiple identity properties per class.

virtual FDO_API bool FdoISchemaCapabilities::SupportsCompositeUniqueValueConstraints  )  [pure virtual]
 

Determines if the provider supports composite unique value constraint.

Returns:
Returns true if the provider supports composite unique value constraint.

virtual FDO_API bool FdoISchemaCapabilities::SupportsDataStoreScopeUniqueIdGeneration  )  [pure virtual]
 

Determines if the provider can auto-generate unique ID values that are unique for the entire datastore, rather than just for a particular class.

Returns:
Returns true if the provider supports id autogeneration unique across an datastore.

virtual FDO_API bool FdoISchemaCapabilities::SupportsDefaultValue  )  [pure virtual]
 

Returns TRUE if default values can be specified for a data property definition, FALSE otherwise.

Returns:
Returns TRUE if default values can be specified for a data property definition, FALSE otherwise.

virtual FDO_API bool FdoISchemaCapabilities::SupportsExclusiveValueRangeConstraints  )  [pure virtual]
 

Determines if the provider supports exclusive value range constraints.

Returns:
Returns true if the provider supports exclusive value range constraints.

virtual FDO_API bool FdoISchemaCapabilities::SupportsInclusiveValueRangeConstraints  )  [pure virtual]
 

Determines if the provider supports inclusive value range constraints.

Returns:
Returns true if the provider supports inclusive value range constraints.

virtual FDO_API bool FdoISchemaCapabilities::SupportsInheritance  )  [pure virtual]
 

Determines if the feature provider supports inheritance.

Returns:
Returns true if the feature provider supports inheritance

FDO_API virtual FDO_DEPRECATED bool FdoISchemaCapabilities::SupportsInheritence  )  [virtual]
 

DOXYGEN-IGNORE DEPRECATED: Use SupportsInheritance() instead. Determines if the feature provider supports inheritance.

Returns:
Returns true if the feature provider supports inheritance

virtual FDO_API bool FdoISchemaCapabilities::SupportsMultipleSchemas  )  [pure virtual]
 

Determines if the provider supports multiple schemas. Returns false if the provider supports only a single schema.

Returns:
Returns true if the provider supports multiple schemas.

virtual FDO_API bool FdoISchemaCapabilities::SupportsNetworkModel  )  [pure virtual]
 

Determines if the provider supports the network model.

Returns:
Returns true if the provider supports the network model.

virtual FDO_API bool FdoISchemaCapabilities::SupportsNullValueConstraints  )  [pure virtual]
 

Determines if the provider supports nullable value constraint.

Returns:
Returns true if the provider supports nullable value constraint.

virtual FDO_API bool FdoISchemaCapabilities::SupportsObjectProperties  )  [pure virtual]
 

Determines if the provider supports object properties. Returns false if the provider supports only data and geometric properties.

Returns:
Returns true if the provider supports object properties.

virtual FDO_API bool FdoISchemaCapabilities::SupportsSchemaModification  )  [pure virtual]
 

Determines if the provider support update a schema through the ApplySchema command. If False, then an application can only create a schema once for the provider. They can use the ApplySchema command once for a given datastore. Once the schema is defined, it cannot be changed. If True, then the provider supports the ability to modify or add to the schema after it is defined initially.

Returns:
Returns true if the provider supports the update of the schema.

virtual FDO_API bool FdoISchemaCapabilities::SupportsSchemaOverrides  )  [pure virtual]
 

Determines if the provider supports Schema Mapping Overrides (overrides to the default rules for mapping Feature Schemas to provider-specific physical schemas).

Returns:
Returns true if the provider supports Schema Overrides

virtual FDO_API bool FdoISchemaCapabilities::SupportsUniqueValueConstraints  )  [pure virtual]
 

Determines if the provider supports unique value constraint.

Returns:
Returns true if the provider supports unique value constraint.

virtual FDO_API bool FdoISchemaCapabilities::SupportsValueConstraintsList  )  [pure virtual]
 

Determines if the provider supports value constraints list.

Returns:
Returns true if the provider supports value constraints list.

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