IParameterMetadata Class Reference

This class exposes an interface for the DSI to interact with parameter metadata. More...

Inherited by IParameterSource, and DSIExtParameterMetadata.

List of all members.

Public Member Functions

virtual EncodingType GetEncoding ()=0
 Returns the char or wchar encoding of the parameter.
virtual simba_int32 GetIntervalPrecision ()=0
 Returns the interval precision of the parameter.
virtual simba_uint32 GetLength ()=0
 Returns the column length of the parameter.
virtual const SqlTypeMetadataGetMetadata () const =0
 Get the parameter's type metadata.
virtual const simba_wstringGetName ()=0
 Returns the name of the parameter.
virtual NumericPrecisionRadix GetNumPrecRadix ()=0
 Returns the NumPrecRadix of the parameter.
virtual simba_uint16 GetParameterNumber ()=0
 Gets the index of this parameter, corresponding to the location of the parameter in the SQL query if it is unnamed.
virtual DSIParameterType GetParameterType ()=0
 Returns the DSIParameterType of the parameter.
virtual simba_int16 GetPrecision ()=0
 Returns the precision of the parameter.
virtual simba_int16 GetScale ()=0
 Returns the scale of the parameter.
virtual simba_int16 GetSqlType ()=0
 Returns the data type of the parameter.
virtual bool IsCaseSensitive ()=0
 Indicates if the parameter is case sensitive or not.
virtual Simba::DSI::DSINullable IsNullable ()=0
 Indicates if the parameter is nullable or not.
virtual bool IsUnnamed ()=0
 Indicates if the parameter is unnamed.
virtual bool IsUnsigned ()=0
 Returns if the data is unsigned or not.
virtual void SetCaseSensitive (bool in_caseSensitive)=0
 Sets the case-sensitivity of the parameter.
virtual void SetEncoding (EncodingType in_encoding)=0
 Sets the char or wchar encoding of the parameter.
virtual void SetIntervalPrecision (simba_int32 in_precision)=0
 Sets the interval precision of the parameter.
virtual void SetLength (simba_uint32 in_length)=0
 Sets the column length of the parameter.
virtual void SetName (const simba_wstring &in_name)=0
 Sets the name field of parameter.
virtual void SetNullable (Simba::DSI::DSINullable in_nullable)=0
 Indicates if the parameter is nullable or not.
virtual void SetParameterType (DSIParameterType in_parameterType)=0
 Sets the DSIParameterType of the parameter.
virtual void SetPrecision (simba_int16 in_precision)=0
 Sets the precision field of the parameter.
virtual void SetScale (simba_int16 in_scale)=0
 Sets the scale field of the parameter.
virtual void SetSQLType (simba_int16 in_sqlType)=0
 Sets the data type of the parameter. This must be one of the SQL types such as SQL_INTEGER and SQL_VARCHAR.
virtual void SetUnnamed (bool in_unnamed)=0
 Indicates if the parameter is unnamed or not.
virtual ~IParameterMetadata ()
 Destructor.

Protected Member Functions

 IParameterMetadata ()
 Constructor.

Detailed Description

This class exposes an interface for the DSI to interact with parameter metadata.


Constructor & Destructor Documentation

virtual ~IParameterMetadata (  )  [inline, virtual]

Destructor.

IParameterMetadata (  )  [inline, protected]

Constructor.


Member Function Documentation

virtual EncodingType GetEncoding (  )  [pure virtual]

Returns the char or wchar encoding of the parameter.

Returns:
Char or wchar encoding of the parameter.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual simba_int32 GetIntervalPrecision (  )  [pure virtual]

Returns the interval precision of the parameter.

Returns:
Interval precision of the parameter.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual simba_uint32 GetLength (  )  [pure virtual]

Returns the column length of the parameter.

Returns:
Column length of the parameter.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual const SqlTypeMetadata& GetMetadata (  )  const [pure virtual]

Get the parameter's type metadata.

Implemented in DSIExtParameterMetadata.

virtual const simba_wstring& GetName (  )  [pure virtual]

Returns the name of the parameter.

Returns:
Name of the parameter.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual NumericPrecisionRadix GetNumPrecRadix (  )  [pure virtual]

Returns the NumPrecRadix of the parameter.

Returns:
NumPrecRadix of the parameter.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual simba_uint16 GetParameterNumber (  )  [pure virtual]

Gets the index of this parameter, corresponding to the location of the parameter in the SQL query if it is unnamed.

Returns:
Index of the parameter.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual DSIParameterType GetParameterType (  )  [pure virtual]

Returns the DSIParameterType of the parameter.

Returns:
DSIParameterType of the parameter.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual simba_int16 GetPrecision (  )  [pure virtual]

Returns the precision of the parameter.

Returns:
Precision of the parameter.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual simba_int16 GetScale (  )  [pure virtual]

Returns the scale of the parameter.

Returns:
Scale of the parameter.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual simba_int16 GetSqlType (  )  [pure virtual]

Returns the data type of the parameter.

Returns:
Data type of the parameter.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual bool IsCaseSensitive (  )  [pure virtual]

Indicates if the parameter is case sensitive or not.

Returns:
True if the parameter is case-sensitive; false otherwise.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual Simba::DSI::DSINullable IsNullable (  )  [pure virtual]

Indicates if the parameter is nullable or not.

Returns:
The type of nullability for the parameter.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual bool IsUnnamed (  )  [pure virtual]

Indicates if the parameter is unnamed.

Returns:
True if the parameter is unnamed; false otherwise.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual bool IsUnsigned (  )  [pure virtual]

Returns if the data is unsigned or not.

Returns:
True if the data is unsigned; false otherwise.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual void SetCaseSensitive ( bool  in_caseSensitive  )  [pure virtual]

Sets the case-sensitivity of the parameter.

Parameters:
in_caseSensitive Set true if it is case-sensitive; false otherwise.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual void SetEncoding ( EncodingType  in_encoding  )  [pure virtual]

Sets the char or wchar encoding of the parameter.

Parameters:
in_encoding Char or wchar encoding to be set.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual void SetIntervalPrecision ( simba_int32  in_precision  )  [pure virtual]

Sets the interval precision of the parameter.

The interval precision field is also affected by calls to SetSQLType() so this function should be used after the type is set to specify the interval precision.

Parameters:
in_precision The interval precision to be set.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual void SetLength ( simba_uint32  in_length  )  [pure virtual]

Sets the column length of the parameter.

The length field is also affected by calls to SetSQLType() so this function should be used after the type is set to specify the length.

Parameters:
in_length The column length to be set.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual void SetName ( const simba_wstring in_name  )  [pure virtual]

Sets the name field of parameter.

The name will be unused if SetUnnamed(true) is/was called.

Parameters:
in_name The name field to be set.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual void SetNullable ( Simba::DSI::DSINullable  in_nullable  )  [pure virtual]

Indicates if the parameter is nullable or not.

Parameters:
in_nullable The type of nullability for the parameter.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual void SetParameterType ( DSIParameterType  in_parameterType  )  [pure virtual]

Sets the DSIParameterType of the parameter.

Parameters:
in_parameterType The DSIParameterType to be set.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual void SetPrecision ( simba_int16  in_precision  )  [pure virtual]

Sets the precision field of the parameter.

The precision is also affected by calls to SetSQLType() so this function should be used after the type is set to specify the precision.

Parameters:
in_precision The precision to be set.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual void SetScale ( simba_int16  in_scale  )  [pure virtual]

Sets the scale field of the parameter.

The scale is also affected by calls to SetSQLType() so this function should be used after the type is set to specify the scale.

Parameters:
in_scale The scale to be set.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual void SetSQLType ( simba_int16  in_sqlType  )  [pure virtual]

Sets the data type of the parameter. This must be one of the SQL types such as SQL_INTEGER and SQL_VARCHAR.

Setting the type has the following side effects on other fields:

  • Setting the type to SQL_CHAR or SQL_VARCHAR sets the length to 1 and precision to 1.
  • Setting the type to SQL_DATETIME sets the precision to 0 if the current SQL_DESC_DATETIME_INTERVAL_CODE is a code without a seconds component.
  • Setting the type to SQL_DATETIME sets the precision to 6 if the current SQL_DESC_DATETIME_INTERVAL_CODE is set to a code with a seconds component.
  • Setting the type to SQL_DECIMAL, SQL_NUMERIC, or SQL_FLOAT sets the scale to 0 and precision to the driver-defined value of 38.
  • Setting the type to SQL_INTERVAL sets the interval precision to 2 if the current SQL_DESC_DATETIME_INTERVAL_CODE is set to an interval.
  • Setting the type to SQL_INTERVAL sets the interval precision to 2 and sets the precision to 6 if the current SQL_DESC_DATETIME_INTERVAL_CODE is set to an interval with a seconds component.

There may be more side effects on length, interval precision, precision, and scale resulting from setting the SQLType so it is safer to set those after setting the type.

Parameters:
in_sqlType The data type to be set.

Implemented in IParameterSource, and DSIExtParameterMetadata.

virtual void SetUnnamed ( bool  in_unnamed  )  [pure virtual]

Indicates if the parameter is unnamed or not.

Parameters:
in_unnamed Set true if the parameter is unnamed; false otherwise.

Implemented in IParameterSource, and DSIExtParameterMetadata.


The documentation for this class was generated from the following file:

Generated on Wed May 17 14:21:15 2017 for SimbaEngine 10.1.3.1011 by simba