DSIExtParameterMetadata Class Reference

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

Inherits Simba::DSI::IParameterMetadata.

List of all members.

Public Member Functions

 DSIExtParameterMetadata (simba_uint16 in_index, Simba::DSI::DSIParameterType in_paramType, simba_int16 in_sqlType, bool in_isUnsigned=false, bool in_hasDefaultValue=false)
 Constructor.
virtual EncodingType GetEncoding ()
 Returns the char or wchar encoding of the parameter.
virtual simba_int32 GetIntervalPrecision ()
 Returns the interval precision of the parameter.
virtual simba_uint32 GetLength ()
 Returns the column length of the parameter.
virtual const SqlTypeMetadataGetMetadata () const
 Get the parameter's type metadata.
virtual SqlTypeMetadataGetMetadata ()
 Accessor for the SqlTypeMetadata.
virtual const simba_wstringGetName ()
 Returns the name of the parameter.
virtual NumericPrecisionRadix GetNumPrecRadix ()
 Returns the NumPrecRadix of the parameter.
virtual simba_uint16 GetParameterNumber ()
 Gets the index of this parameter, corresponding to the location of the parameter in the SQL query if it is unnamed.
virtual
Simba::DSI::DSIParameterType 
GetParameterType ()
 Returns the DSIParameterType of the parameter.
virtual simba_int16 GetPrecision ()
 Returns the precision of the parameter.
virtual simba_int16 GetScale ()
 Returns the scale of the parameter.
virtual simba_int16 GetSqlType ()
 Returns the data type of the parameter.
virtual simba_uint16 GetUserDataType ()
 Returns the user data type of the parameter.
virtual bool HasDefaultValue ()
 Indicates whether this parameter has a default value.
virtual bool IsCaseSensitive ()
 Indicates if the parameter is case sensitive or not.
virtual Simba::DSI::DSINullable IsNullable ()
 Indicates if the parameter is nullable or not.
virtual bool IsUnnamed ()
 Indicates if the parameter is unnamed.
virtual bool IsUnsigned ()
 Returns if the data is unsigned or not.
virtual void SetCaseSensitive (bool in_caseSensitive)
 Sets the case-sensitivity of the parameter.
virtual void SetEncoding (EncodingType in_encoding)
 Sets the char or wchar encoding of the parameter.
virtual void SetIntervalPrecision (simba_int32 in_precision)
 Sets the interval precision of the parameter.
virtual void SetLength (simba_uint32 in_length)
 Sets the column length of the parameter.
virtual void SetName (const simba_wstring &in_name)
 Sets the name field of parameter.
virtual void SetNullable (Simba::DSI::DSINullable in_nullable)
 Indicates if the parameter is nullable or not.
virtual void SetParameterType (Simba::DSI::DSIParameterType in_parameterType)
 Sets the DSIParameterType of the parameter.
virtual void SetPrecision (simba_int16 in_precision)
 Sets the precision field of the parameter.
virtual void SetScale (simba_int16 in_scale)
 Sets the scale field of the parameter.
virtual void SetSQLType (simba_int16 in_sqlType)
 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_isUnnamed)
 Indicates if the parameter is unnamed or not.
virtual ~DSIExtParameterMetadata ()
 Destructor.

Detailed Description

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


Constructor & Destructor Documentation

DSIExtParameterMetadata ( simba_uint16  in_index,
Simba::DSI::DSIParameterType  in_paramType,
simba_int16  in_sqlType,
bool  in_isUnsigned = false,
bool  in_hasDefaultValue = false 
)

Constructor.

Parameters:
in_index The index of the parameter, starting at 0.
in_paramType The type of the parameter.
in_sqlType The SQL type of the parameter.
in_isUnsigned True if the type is unsigned; false otherwise.
in_hasDefaultValue True if this parameter has a default value; false otherwise.
virtual ~DSIExtParameterMetadata (  )  [virtual]

Destructor.


Member Function Documentation

virtual EncodingType GetEncoding (  )  [virtual]

Returns the char or wchar encoding of the parameter.

Returns:
Char or wchar encoding of the parameter.

Implements IParameterMetadata.

virtual simba_int32 GetIntervalPrecision (  )  [virtual]

Returns the interval precision of the parameter.

Returns:
Interval precision of the parameter.

Implements IParameterMetadata.

virtual simba_uint32 GetLength (  )  [virtual]

Returns the column length of the parameter.

Returns:
Column length of the parameter.

Implements IParameterMetadata.

virtual const SqlTypeMetadata& GetMetadata (  )  const [virtual]

Get the parameter's type metadata.

Implements IParameterMetadata.

virtual SqlTypeMetadata* GetMetadata (  )  [virtual]

Accessor for the SqlTypeMetadata.

Returns:
The SqlTypeMetadata for this parameter. (NOT OWN)
virtual const simba_wstring& GetName (  )  [virtual]

Returns the name of the parameter.

Returns:
Name of the parameter.

Implements IParameterMetadata.

virtual NumericPrecisionRadix GetNumPrecRadix (  )  [virtual]

Returns the NumPrecRadix of the parameter.

Returns:
NumPrecRadix of the parameter.

Implements IParameterMetadata.

virtual simba_uint16 GetParameterNumber (  )  [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, starting from 1.

Implements IParameterMetadata.

virtual Simba::DSI::DSIParameterType GetParameterType (  )  [virtual]

Returns the DSIParameterType of the parameter.

Returns:
DSIParameterType of the parameter.

Implements IParameterMetadata.

virtual simba_int16 GetPrecision (  )  [virtual]

Returns the precision of the parameter.

Returns:
Precision of the parameter.

Implements IParameterMetadata.

virtual simba_int16 GetScale (  )  [virtual]

Returns the scale of the parameter.

Returns:
Scale of the parameter.

Implements IParameterMetadata.

virtual simba_int16 GetSqlType (  )  [virtual]

Returns the data type of the parameter.

Returns:
Data type of the parameter.

Implements IParameterMetadata.

virtual simba_uint16 GetUserDataType (  )  [virtual]

Returns the user data type of the parameter.

Returns:
User data type of the parameter.
virtual bool HasDefaultValue (  )  [virtual]

Indicates whether this parameter has a default value.

Returns:
True if this parameter has a default value; false otherwise.
virtual bool IsCaseSensitive (  )  [virtual]

Indicates if the parameter is case sensitive or not.

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

Implements IParameterMetadata.

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

Indicates if the parameter is nullable or not.

Returns:
The type of nullability for the parameter.

Implements IParameterMetadata.

virtual bool IsUnnamed (  )  [virtual]

Indicates if the parameter is unnamed.

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

Implements IParameterMetadata.

virtual bool IsUnsigned (  )  [virtual]

Returns if the data is unsigned or not.

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

Implements IParameterMetadata.

virtual void SetCaseSensitive ( bool  in_caseSensitive  )  [virtual]

Sets the case-sensitivity of the parameter.

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

Implements IParameterMetadata.

virtual void SetEncoding ( EncodingType  in_encoding  )  [virtual]

Sets the char or wchar encoding of the parameter.

Parameters:
in_encoding Char or wchar encoding to be set.

Implements IParameterMetadata.

virtual void SetIntervalPrecision ( simba_int32  in_precision  )  [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.

Implements IParameterMetadata.

virtual void SetLength ( simba_uint32  in_length  )  [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.

Implements IParameterMetadata.

virtual void SetName ( const simba_wstring in_name  )  [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.

Implements IParameterMetadata.

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

Indicates if the parameter is nullable or not.

Parameters:
in_nullable The type of nullability for the parameter.

Implements IParameterMetadata.

virtual void SetParameterType ( Simba::DSI::DSIParameterType  in_parameterType  )  [virtual]

Sets the DSIParameterType of the parameter.

Parameters:
in_parameterType The DSIParameterType to be set.

Implements IParameterMetadata.

virtual void SetPrecision ( simba_int16  in_precision  )  [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.

Implements IParameterMetadata.

virtual void SetScale ( simba_int16  in_scale  )  [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.

Implements IParameterMetadata.

virtual void SetSQLType ( simba_int16  in_sqlType  )  [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.

Implements IParameterMetadata.

virtual void SetUnnamed ( bool  in_isUnnamed  )  [virtual]

Indicates if the parameter is unnamed or not.

Parameters:
in_isUnnamed True if the parameter is unnamed; false otherwise.

Implements IParameterMetadata.


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

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