DSIExtParameterValue Class Reference

A class that represents a value for a stored procedure. More...

Inherits Simba::SQLEngine::DSIExtInputParameterValue.

List of all members.

Public Member Functions

 DSIExtParameterValue (SqlTypeMetadata *in_metadata, Simba::SQLEngine::ETValueExpr *in_dataNode, bool in_isDefaultValue)
 Constructor.
void SetBinaryValue (const simba_byte *in_value, simba_unsigned_native in_length)
 Set the parameter value as a binary array.
void SetBitValue (simba_byte in_value)
 Set the parameter value as a simba_byte.
void SetDateValue (const TDWDate &in_value)
 Set the parameter value as a TDWDate.
void SetDayHourValue (TDWDayHourInterval in_value)
 Set the parameter value as a TDWDayHourInterval.
void SetDayMinuteValue (TDWDayMinuteInterval in_value)
 Set the parameter value as a TDWDayMinuteInterval.
void SetDaySecondValue (TDWDaySecondInterval in_value)
 Set the parameter value as a TDWDaySecondInterval.
void SetDayValue (TDWSingleFieldInterval in_value)
 Set the parameter value as a TDWSingleFieldInterval.
void SetDoubleValue (simba_double64 in_value)
 Set the parameter value as a simba_double64.
void SetGuidValue (const TDWGuid &in_value)
 Set the parameter value as a TDWGuid.
void SetHourMinuteValue (TDWHourMinuteInterval in_value)
 Set the parameter value as a TDWHourMinuteInterval.
void SetHourSecondValue (TDWHourSecondInterval in_value)
 Set the parameter value as a TDWHourSecondInterval.
void SetHourValue (TDWSingleFieldInterval in_value)
 Set the parameter value as a TDWSingleFieldInterval.
void SetInt16Value (simba_int16 in_value)
 Set the parameter value as a simba_int16.
void SetInt32Value (simba_int32 in_value)
 Set the parameter value as a simba_int32.
void SetInt64Value (simba_int64 in_value)
 Set the parameter value as a simba_int64.
void SetInt8Value (simba_int8 in_value)
 Set the parameter value as a simba_int8.
void SetMinuteSecondValue (TDWMinuteSecondInterval in_value)
 Set the parameter value as a TDWMinuteSecondInterval.
void SetMinuteValue (TDWSingleFieldInterval in_value)
 Set the parameter value as a TDWSingleFieldInterval.
void SetMonthValue (TDWSingleFieldInterval in_value)
 Set the parameter value as a TDWSingleFieldInterval.
void SetNull (bool in_isNull)
 Set if the parameter is NULL.
void SetNumericValue (const TDWExactNumericType &in_value)
 Set the parameter value as a TDWExactNumericType.
void SetSecondValue (TDWSecondInterval in_value)
 Set the parameter value as a TDWSecondInterval.
void SetSingleValue (simba_double32 in_value)
 Set the parameter value as a simba_double32.
void SetStringValue (const simba_string &in_value)
 Set the parameter value as a string.
void SetTimestampValue (const TDWTimestamp &in_value)
 Set the parameter value as a TDWTimestamp.
void SetTimeValue (const TDWTime &in_value)
 Set the parameter value as a TDWTime.
void SetUInt16Value (simba_uint16 in_value)
 Set the parameter value as a simba_uint16.
void SetUInt32Value (simba_uint32 in_value)
 Set the parameter value as a simba_uint32.
void SetUInt64Value (simba_uint64 in_value)
 Set the parameter value as a simba_uint64.
void SetUInt8Value (simba_uint8 in_value)
 Set the parameter value as a simba_uint8.
void SetWideStringValue (const simba_wstring &in_value)
 Set the parameter value as a wide character string.
void SetYearMonthValue (TDWYearMonthInterval in_value)
 Set the parameter value as a TDWYearMonthInterval.
void SetYearValue (TDWSingleFieldInterval in_value)
 Set the parameter value as a TDWSingleFieldInterval.
 ~DSIExtParameterValue ()
 Destructor.

Detailed Description

A class that represents a value for a stored procedure.

The parameter value types will correspond exactly to the types that are specified via DSIExtProcedure::GetParameters().


Constructor & Destructor Documentation

DSIExtParameterValue ( SqlTypeMetadata in_metadata,
Simba::SQLEngine::ETValueExpr *  in_dataNode,
bool  in_isDefaultValue 
)

Constructor.

Parameters:
in_metadata The metadata about the node. (NOT OWN)
in_dataNode The node to retrieve data from. (NOT OWN)
in_isDefaultValue True if the default value for this parameter should be used; false otherwise.

Destructor.


Member Function Documentation

void SetBinaryValue ( const simba_byte *  in_value,
simba_unsigned_native  in_length 
)

Set the parameter value as a binary array.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a binary array.
in_length The length of the returned binary array.
Exceptions:
SEInvalidOperationException if the value is not a binary value.
void SetBitValue ( simba_byte  in_value  ) 

Set the parameter value as a simba_byte.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a simba_byte.
Exceptions:
SEInvalidOperationException if the value is not a simba_byte.
void SetDateValue ( const TDWDate in_value  ) 

Set the parameter value as a TDWDate.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a TDWDate.
Exceptions:
SEInvalidOperationException if the value is not a TDWDate.
void SetDayHourValue ( TDWDayHourInterval  in_value  ) 

Set the parameter value as a TDWDayHourInterval.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a TDWDayHourInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWDayHourInterval.
void SetDayMinuteValue ( TDWDayMinuteInterval  in_value  ) 

Set the parameter value as a TDWDayMinuteInterval.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a TDWDayMinuteInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWDayMinuteInterval.
void SetDaySecondValue ( TDWDaySecondInterval  in_value  ) 

Set the parameter value as a TDWDaySecondInterval.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a TDWDaySecondInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWDaySecondInterval.
void SetDayValue ( TDWSingleFieldInterval  in_value  ) 

Set the parameter value as a TDWSingleFieldInterval.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a TDWSingleFieldInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWSingleFieldInterval.
void SetDoubleValue ( simba_double64  in_value  ) 

Set the parameter value as a simba_double64.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a simba_double64.
Exceptions:
SEInvalidOperationException if the value is not a simba_double64.
void SetGuidValue ( const TDWGuid in_value  ) 

Set the parameter value as a TDWGuid.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a TDWGuid.
Exceptions:
SEInvalidOperationException if the value is not a TDWGuid.
void SetHourMinuteValue ( TDWHourMinuteInterval  in_value  ) 

Set the parameter value as a TDWHourMinuteInterval.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a TDWHourMinuteInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWHourMinuteInterval.
void SetHourSecondValue ( TDWHourSecondInterval  in_value  ) 

Set the parameter value as a TDWHourSecondInterval.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a TDWHourSecondInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWHourSecondInterval.
void SetHourValue ( TDWSingleFieldInterval  in_value  ) 

Set the parameter value as a TDWSingleFieldInterval.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a TDWSingleFieldInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWSingleFieldInterval.
void SetInt16Value ( simba_int16  in_value  ) 

Set the parameter value as a simba_int16.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a simba_int16.
Exceptions:
SEInvalidOperationException if the value is not a simba_int16.
void SetInt32Value ( simba_int32  in_value  ) 

Set the parameter value as a simba_int32.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a simba_int32.
Exceptions:
SEInvalidOperationException if the value is not a simba_int32.
void SetInt64Value ( simba_int64  in_value  ) 

Set the parameter value as a simba_int64.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a simba_int64.
Exceptions:
SEInvalidOperationException if the value is not a simba_int64.
void SetInt8Value ( simba_int8  in_value  ) 

Set the parameter value as a simba_int8.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a simba_int8.
Exceptions:
SEInvalidOperationException if the value is not a simba_int8.
void SetMinuteSecondValue ( TDWMinuteSecondInterval  in_value  ) 

Set the parameter value as a TDWMinuteSecondInterval.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a TDWMinuteSecondInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWMinuteSecondInterval.
void SetMinuteValue ( TDWSingleFieldInterval  in_value  ) 

Set the parameter value as a TDWSingleFieldInterval.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a TDWSingleFieldInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWSingleFieldInterval.
void SetMonthValue ( TDWSingleFieldInterval  in_value  ) 

Set the parameter value as a TDWSingleFieldInterval.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a TDWSingleFieldInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWSingleFieldInterval.
void SetNull ( bool  in_isNull  ) 

Set if the parameter is NULL.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_isNull True if the parameter is NULL; false otherwise.
void SetNumericValue ( const TDWExactNumericType in_value  ) 

Set the parameter value as a TDWExactNumericType.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a TDWExactNumericType.
Exceptions:
SEInvalidOperationException if the value is not a TDWExactNumericType.
void SetSecondValue ( TDWSecondInterval  in_value  ) 

Set the parameter value as a TDWSecondInterval.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a TDWSecondInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWSecondInterval.
void SetSingleValue ( simba_double32  in_value  ) 

Set the parameter value as a simba_double32.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a simba_double32.
Exceptions:
SEInvalidOperationException if the value is not a simba_double32.
void SetStringValue ( const simba_string &  in_value  ) 

Set the parameter value as a string.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a string.
Exceptions:
SEInvalidOperationException if the value is not a string value.
void SetTimestampValue ( const TDWTimestamp in_value  ) 

Set the parameter value as a TDWTimestamp.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a TDWTimestamp.
Exceptions:
SEInvalidOperationException if the value is not a TDWTimestamp.
void SetTimeValue ( const TDWTime in_value  ) 

Set the parameter value as a TDWTime.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a TDWTime.
Exceptions:
SEInvalidOperationException if the value is not a TDWTime.
void SetUInt16Value ( simba_uint16  in_value  ) 

Set the parameter value as a simba_uint16.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a simba_uint16.
Exceptions:
SEInvalidOperationException if the value is not a simba_uint16.
void SetUInt32Value ( simba_uint32  in_value  ) 

Set the parameter value as a simba_uint32.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a simba_uint32.
Exceptions:
SEInvalidOperationException if the value is not a simba_uint32.
void SetUInt64Value ( simba_uint64  in_value  ) 

Set the parameter value as a simba_uint64.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a simba_uint64.
Exceptions:
SEInvalidOperationException if the value is not a simba_uint64.
void SetUInt8Value ( simba_uint8  in_value  ) 

Set the parameter value as a simba_uint8.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a simba_uint8.
Exceptions:
SEInvalidOperationException if the value is not a simba_uint8.
void SetWideStringValue ( const simba_wstring in_value  ) 

Set the parameter value as a wide character string.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a wide character string.
Exceptions:
SEInvalidOperationException if the value is not a wide string value.
void SetYearMonthValue ( TDWYearMonthInterval  in_value  ) 

Set the parameter value as a TDWYearMonthInterval.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a TDWYearMonthInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWYearMonthInterval.
void SetYearValue ( TDWSingleFieldInterval  in_value  ) 

Set the parameter value as a TDWSingleFieldInterval.

Note that if the value is not a return, output, or input/output parameter this call will have no effect.

Parameters:
in_value The value as a TDWSingleFieldInterval.
Exceptions:
SEInvalidOperationException if the value is not a TDWSingleFieldInterval.

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