ConversionResult Struct Reference

Returned error or warning structure from the type conversion methods. More...

List of all members.

Public Member Functions

bool Check (IWarningListener &in_warningListener, simba_int32 in_column=UNKNOWN_COLUMN_NUMBER, simba_signed_native in_row=UNKNOWN_ROW_NUMBER, bool in_throwOnError=true) const
 Processes this object.
 ConversionResult (const ConversionResult &in_other)
 Copy constructor.
 ConversionResult (const simba_wstring &in_msgKey, bool in_isPreformatted, simba_int32 in_componentId, SQLState in_customState, simba_unsigned_native in_rowNumber=0)
 Constructor with custom SQLState.
 ConversionResult (const simba_wstring &in_msgKey, bool in_isPreformatted, simba_int32 in_componentId, TypeConversionState in_conversionState, simba_unsigned_native in_rowNumber=0)
 Constructor.
 ConversionResult ()
 Default constructor.
ConversionResultoperator= (const ConversionResult &in_other)
 Assignment operator.

Static Public Member Functions

static ConversionResultDATETIME_FIELD_OVERFLOW_CONV_RESULT ()
 Type conversion result structure factory for CONV_INVALID_DATETIME_FIELD_OVERFLOW.
static ConversionResultFRACTIONAL_TRUNCATION_CONV_RESULT (TypeConversionFractionalTruncationSpecifier in_fractionalTruncationInfo=CONV_FRACTIONAL_TRUNCATION_INVALID)
 Type conversion result structure factory for CONV_FRAC_TRUNCATION.
static ConversionResultINDICATOR_VAR_NOT_SUPPLIED_CONV_RESULT ()
static ConversionResultINTERVAL_FIELD_OVERFLOW_CONV_RESULT (TypeConversionOverflowSpecifier in_overflowInfo=CONV_OVERFLOW_INVALID)
 Type conversion result structure factory for CONV_INTERVAL_FIELD_OVERFLOW.
static ConversionResultINVALID_CHAR_VAL_FOR_CAST ()
 Type conversion result structure factory for CONV_INVALID_CHAR_VAL_FOR_CAST.
static ConversionResultINVALID_DATA_CONV_RESULT ()
 Type conversion result structure factory for CONV_INVALID_DATA.
static ConversionResultINVALID_DATETIME_FORMAT_CONV_RESULT ()
 Type conversion result structure factory for CONV_INVALID_DATETIME.
static ConversionResultINVALID_DATETIME_VALUE_CONV_RESULT ()
 Type conversion result structure factory for CONV_INVALID_DATETIME_VALUE.
static ConversionResultINVALID_LEADING_PRECISION_CONV_RESULT ()
 Type conversion result structure factory for CONV_INTERVAL_FIELD_OVERFLOW.
static ConversionResultINVALID_MULTI_FIELD_INTERVAL_CONVERSION ()
 Type conversion result structure factory for CONV_RESTRICTED_DATA_TYPE_ATTR_VIOLATION.
static ConversionResultLOGIC_ERROR_CONV_RESULT ()
 Type conversion result structure factory for CONV_LOGIC_ERROR.
static const ConversionResultMAKE_DATETIME_FIELD_OVERFLOW ()
 Type conversion result structure factory for CONV_INVALID_DATETIME_FIELD_OVERFLOW.
static const ConversionResultMAKE_FRACTIONAL_TRUNCATION (TypeConversionFractionalTruncationSpecifier in_fractionalTruncationInfo=CONV_FRACTIONAL_TRUNCATION_INVALID)
 Type conversion result structure factory for CONV_FRAC_TRUNCATION.
static const ConversionResultMAKE_INDICATOR_VAR_NOT_SUPPLIED ()
static const ConversionResultMAKE_INTERVAL_FIELD_OVERFLOW (TypeConversionOverflowSpecifier in_overflowInfo=CONV_OVERFLOW_INVALID)
 Type conversion result structure factory for CONV_INTERVAL_FIELD_OVERFLOW.
static const ConversionResultMAKE_INVALID_CHAR_VAL_FOR_CAST ()
 Type conversion result structure factory for CONV_INVALID_CHAR_VAL_FOR_CAST.
static const ConversionResultMAKE_INVALID_DATA ()
 Type conversion result structure factory for CONV_INVALID_DATA.
static const ConversionResultMAKE_INVALID_DATETIME_FORMAT ()
 Type conversion result structure factory for CONV_INVALID_DATETIME.
static const ConversionResultMAKE_INVALID_DATETIME_VALUE ()
 Type conversion result structure factory for CONV_INVALID_DATETIME_VALUE.
static const ConversionResultMAKE_INVALID_LEADING_PRECISION ()
 Type conversion result structure factory for CONV_INTERVAL_FIELD_OVERFLOW.
static const ConversionResultMAKE_INVALID_MULTI_FIELD_INTERVAL_CONVERSION ()
 Type conversion result structure factory for CONV_RESTRICTED_DATA_TYPE_ATTR_VIOLATION.
static const ConversionResultMAKE_LOGIC_ERROR ()
 Type conversion result structure factory for CONV_LOGIC_ERROR.
static const ConversionResultMAKE_NUMERIC_OUT_OF_RANGE (TypeConversionOverflowSpecifier in_overflowInfo=CONV_OVERFLOW_INVALID)
 Type conversion result structure factory for CONV_NUMERIC_OUT_OF_RANGE.
static const ConversionResultMAKE_OUT_OF_MEMORY ()
 Type conversion result structure factory for CONV_OUT_OF_MEMORY.
static const ConversionResultMAKE_RETRIEVAL_ERROR ()
 Type conversion result when the DSII is not able to retrieve a cell during bulk.
static const ConversionResultMAKE_STRING_TRUNCATION ()
 Type conversion result structure factory for CONV_STRING_TRUNCATION.
static const ConversionResultMAKE_STRING_TRUNCATION_ERR ()
 Type conversion result structure factory for CONV_STRING_TRUNCATION_ERR.
static ConversionResultNUMERIC_OUT_OF_RANGE_CONV_RESULT (TypeConversionOverflowSpecifier in_overflowInfo=CONV_OVERFLOW_INVALID)
 Type conversion result structure factory for CONV_NUMERIC_OUT_OF_RANGE.
static ConversionResultOUT_OF_MEMORY_CONV_RESULT ()
 Type conversion result structure factory for CONV_OUT_OF_MEMORY.
static ConversionResultRETRIEVAL_ERROR_CONV_RESULT ()
 Type conversion result when the DSII is not able to retrieve a cell during bulk.
static ConversionResultSTRING_TRUNCATION_CONV_RESULT ()
 Type conversion result structure factory for CONV_STRING_TRUNCATION.
static ConversionResultSTRING_TRUNCATION_ERR_CONV_RESULT ()
 Type conversion result structure factory for CONV_STRING_TRUNCATION_ERR.

Public Attributes

simba_int32 componentId
TypeConversionState conversionState
SQLState customState
TypeConversionFractionalTruncationSpecifier fractionalTruncationInfo
bool isPreformatted
simba_unsigned_native m_rowNumber
simba_wstring msgKey
TypeConversionOverflowSpecifier overflowInfo

Detailed Description

Returned error or warning structure from the type conversion methods.


Constructor & Destructor Documentation

ConversionResult (  )  [inline]

Default constructor.

ConversionResult ( const simba_wstring in_msgKey,
bool  in_isPreformatted,
simba_int32  in_componentId,
TypeConversionState  in_conversionState,
simba_unsigned_native  in_rowNumber = 0 
)

Constructor.

Parameters:
in_msgKey The message or message key.
in_isPreformatted False if in_msgKey is a preformatted message; true if it is a key used to look up the message.
in_componentId The component ID used to look up the message.
in_conversionState The state of the conversion.
in_rowNumber Row number for which this conversion result was created.
ConversionResult ( const simba_wstring in_msgKey,
bool  in_isPreformatted,
simba_int32  in_componentId,
SQLState  in_customState,
simba_unsigned_native  in_rowNumber = 0 
)

Constructor with custom SQLState.

Parameters:
in_msgKey The message or message key.
in_isPreformatted False if in_msgKey is a preformatted message; true if it is a key used to look up the message.
in_componentId The component ID used to look up the message.
in_customState Custom SQLSTATE to use for the error. Should be 5 characters long.
in_rowNumber Row number for which this conversion result was created.
ConversionResult ( const ConversionResult in_other  ) 

Copy constructor.


Member Function Documentation

bool Check ( IWarningListener in_warningListener,
simba_int32  in_column = UNKNOWN_COLUMN_NUMBER,
simba_signed_native  in_row = UNKNOWN_ROW_NUMBER,
bool  in_throwOnError = true 
) const

Processes this object.

Posts warnings when appropriate, and throws exceptions if appropriate.

Parameters:
in_warningListener The IWarningListener to use for posting warnings.
in_column The column where the error happened. 1-based index.
in_row The row where the error happened. 1-based index.
in_throwOnError If true, and this object represents an error, an ErrorException describing this error will be thrown. Otherwise, it will only be posted to the given warning listener.
Exceptions:
SupportException if the result indicates that a failure has occurred and in_throwOnError is true.
Returns:
True if this object represents an error, False otherwise.
static ConversionResult* DATETIME_FIELD_OVERFLOW_CONV_RESULT (  )  [static]

Type conversion result structure factory for CONV_INVALID_DATETIME_FIELD_OVERFLOW.

Returns:
New instance of a ConversionResult. (OWN)
static ConversionResult* FRACTIONAL_TRUNCATION_CONV_RESULT ( TypeConversionFractionalTruncationSpecifier  in_fractionalTruncationInfo = CONV_FRACTIONAL_TRUNCATION_INVALID  )  [static]

Type conversion result structure factory for CONV_FRAC_TRUNCATION.

Parameters:
in_fractionalTruncationInfo Which way the result was rounded.
Returns:
New instance of a ConversionResult. (OWN)
static ConversionResult* INDICATOR_VAR_NOT_SUPPLIED_CONV_RESULT (  )  [static]
Returns:
New instance of a ConversionResult. (OWN)
static ConversionResult* INTERVAL_FIELD_OVERFLOW_CONV_RESULT ( TypeConversionOverflowSpecifier  in_overflowInfo = CONV_OVERFLOW_INVALID  )  [static]

Type conversion result structure factory for CONV_INTERVAL_FIELD_OVERFLOW.

Parameters:
in_overflowInfo Cause of overflow (CONV_OVERFLOW_INVALID if not caused by target type range)
Returns:
New instance of a ConversionResult. (OWN)
static ConversionResult* INVALID_CHAR_VAL_FOR_CAST (  )  [static]

Type conversion result structure factory for CONV_INVALID_CHAR_VAL_FOR_CAST.

Returns:
New instance of a ConversionResult. (OWN)
static ConversionResult* INVALID_DATA_CONV_RESULT (  )  [static]

Type conversion result structure factory for CONV_INVALID_DATA.

Returns:
New instance of a ConversionResult. (OWN)
static ConversionResult* INVALID_DATETIME_FORMAT_CONV_RESULT (  )  [static]

Type conversion result structure factory for CONV_INVALID_DATETIME.

Returns:
New instance of a ConversionResult. (OWN)
static ConversionResult* INVALID_DATETIME_VALUE_CONV_RESULT (  )  [static]

Type conversion result structure factory for CONV_INVALID_DATETIME_VALUE.

Returns:
New instance of a ConversionResult. (OWN)
static ConversionResult* INVALID_LEADING_PRECISION_CONV_RESULT (  )  [static]

Type conversion result structure factory for CONV_INTERVAL_FIELD_OVERFLOW.

Returns:
New instance of a ConversionResult. (OWN)
static ConversionResult* INVALID_MULTI_FIELD_INTERVAL_CONVERSION (  )  [static]

Type conversion result structure factory for CONV_RESTRICTED_DATA_TYPE_ATTR_VIOLATION.

Returns:
New instance of a ConversionResult. (OWN)
static ConversionResult* LOGIC_ERROR_CONV_RESULT (  )  [static]

Type conversion result structure factory for CONV_LOGIC_ERROR.

Returns:
New instance of a ConversionResult. (OWN)
static const ConversionResult& MAKE_DATETIME_FIELD_OVERFLOW (  )  [static]

Type conversion result structure factory for CONV_INVALID_DATETIME_FIELD_OVERFLOW.

Returns:
A ConversionResult object.
static const ConversionResult& MAKE_FRACTIONAL_TRUNCATION ( TypeConversionFractionalTruncationSpecifier  in_fractionalTruncationInfo = CONV_FRACTIONAL_TRUNCATION_INVALID  )  [static]

Type conversion result structure factory for CONV_FRAC_TRUNCATION.

Parameters:
in_fractionalTruncationInfo Which way the result was rounded.
Returns:
A ConversionResult object.
static const ConversionResult& MAKE_INDICATOR_VAR_NOT_SUPPLIED (  )  [static]
Returns:
Reference to a constant ConversionResult. (NOT OWN)
static const ConversionResult& MAKE_INTERVAL_FIELD_OVERFLOW ( TypeConversionOverflowSpecifier  in_overflowInfo = CONV_OVERFLOW_INVALID  )  [static]

Type conversion result structure factory for CONV_INTERVAL_FIELD_OVERFLOW.

Parameters:
in_overflowInfo Cause of overflow (CONV_OVERFLOW_INVALID if not caused by target type range)
Returns:
A ConversionResult object.
static const ConversionResult& MAKE_INVALID_CHAR_VAL_FOR_CAST (  )  [static]

Type conversion result structure factory for CONV_INVALID_CHAR_VAL_FOR_CAST.

Returns:
A ConversionResult object.
static const ConversionResult& MAKE_INVALID_DATA (  )  [static]

Type conversion result structure factory for CONV_INVALID_DATA.

Returns:
A ConversionResult object.
static const ConversionResult& MAKE_INVALID_DATETIME_FORMAT (  )  [static]

Type conversion result structure factory for CONV_INVALID_DATETIME.

Returns:
A ConversionResult object.
static const ConversionResult& MAKE_INVALID_DATETIME_VALUE (  )  [static]

Type conversion result structure factory for CONV_INVALID_DATETIME_VALUE.

Returns:
A ConversionResult object.
static const ConversionResult& MAKE_INVALID_LEADING_PRECISION (  )  [static]

Type conversion result structure factory for CONV_INTERVAL_FIELD_OVERFLOW.

Returns:
A ConversionResult object.
static const ConversionResult& MAKE_INVALID_MULTI_FIELD_INTERVAL_CONVERSION (  )  [static]

Type conversion result structure factory for CONV_RESTRICTED_DATA_TYPE_ATTR_VIOLATION.

Returns:
A ConversionResult object.
static const ConversionResult& MAKE_LOGIC_ERROR (  )  [static]

Type conversion result structure factory for CONV_LOGIC_ERROR.

Returns:
A ConversionResult object.
static const ConversionResult& MAKE_NUMERIC_OUT_OF_RANGE ( TypeConversionOverflowSpecifier  in_overflowInfo = CONV_OVERFLOW_INVALID  )  [static]

Type conversion result structure factory for CONV_NUMERIC_OUT_OF_RANGE.

Parameters:
in_overflowInfo Cause of overflow (CONV_OVERFLOW_INVALID if not caused by target type range)
Returns:
A ConversionResult object.
static const ConversionResult& MAKE_OUT_OF_MEMORY (  )  [static]

Type conversion result structure factory for CONV_OUT_OF_MEMORY.

Returns:
A ConversionResult object.
static const ConversionResult& MAKE_RETRIEVAL_ERROR (  )  [static]

Type conversion result when the DSII is not able to retrieve a cell during bulk.

Returns:
Reference to a constant ConversionResult. (NOT OWN)
static const ConversionResult& MAKE_STRING_TRUNCATION (  )  [static]

Type conversion result structure factory for CONV_STRING_TRUNCATION.

Returns:
A ConversionResult object.
static const ConversionResult& MAKE_STRING_TRUNCATION_ERR (  )  [static]

Type conversion result structure factory for CONV_STRING_TRUNCATION_ERR.

Returns:
A ConversionResult object.
static ConversionResult* NUMERIC_OUT_OF_RANGE_CONV_RESULT ( TypeConversionOverflowSpecifier  in_overflowInfo = CONV_OVERFLOW_INVALID  )  [static]

Type conversion result structure factory for CONV_NUMERIC_OUT_OF_RANGE.

Parameters:
in_overflowInfo Cause of overflow (CONV_OVERFLOW_INVALID if not caused by target type range)
Returns:
New instance of a ConversionResult. (OWN)
ConversionResult& operator= ( const ConversionResult in_other  ) 

Assignment operator.

static ConversionResult* OUT_OF_MEMORY_CONV_RESULT (  )  [static]

Type conversion result structure factory for CONV_OUT_OF_MEMORY.

Returns:
New instance of a ConversionResult. (OWN)
static ConversionResult* RETRIEVAL_ERROR_CONV_RESULT (  )  [static]

Type conversion result when the DSII is not able to retrieve a cell during bulk.

Returns:
New instance of a ConversionResult. (OWN)
static ConversionResult* STRING_TRUNCATION_CONV_RESULT (  )  [static]

Type conversion result structure factory for CONV_STRING_TRUNCATION.

Returns:
New instance of a ConversionResult. (OWN)
static ConversionResult* STRING_TRUNCATION_ERR_CONV_RESULT (  )  [static]

Type conversion result structure factory for CONV_STRING_TRUNCATION_ERR.

Returns:
New instance of a ConversionResult. (OWN)

Member Data Documentation


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

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