IWarningListener Class Reference

An interface for posting warnings. More...

List of all members.

Public Member Functions

virtual const simba_stringGetLocale ()=0
 Get the locale for this IWarningListener.
virtual void PostError (ErrorException &in_error)=0
 Create and add a new error record based on the ErrorException.
virtual void PostError (SQLState in_customState, simba_int32 in_componentID, const simba_wstring &in_msgKey, simba_signed_native in_rowNum=NO_ROW_NUMBER, simba_int32 in_colNum=NO_COLUMN_NUMBER)=0
 Create a new error record based on the given information.
virtual void PostError (SQLState in_customState, simba_int32 in_componentID, const simba_wstring &in_msgKey, const std::vector< simba_wstring > &in_msgParams, simba_signed_native in_rowNum=NO_ROW_NUMBER, simba_int32 in_colNum=NO_COLUMN_NUMBER)=0
 Create a new error record based on the given information.
virtual void PostError (DiagState in_stateKey, simba_int32 in_componentId, const simba_wstring &in_msgKey, simba_signed_native in_rowNum=NO_ROW_NUMBER, simba_int32 in_colNum=NO_COLUMN_NUMBER)=0
 Create a new error record based on the given information.
virtual void PostError (DiagState in_stateKey, simba_int32 in_componentId, const simba_wstring &in_msgKey, const std::vector< simba_wstring > &in_msgParams, simba_signed_native in_rowNum=NO_ROW_NUMBER, simba_int32 in_colNum=NO_COLUMN_NUMBER)=0
 Create a new error record based on the given information.
virtual void PostPreformattedError (SQLState in_customState, simba_int32 in_nativeErrCode, const simba_wstring &in_message, simba_signed_native in_rowNum=NO_ROW_NUMBER, simba_int32 in_colNum=NO_COLUMN_NUMBER)=0
 Sends an error to subscriber(s) of the listener.
virtual void PostPreformattedError (DiagState in_stateKey, simba_int32 in_nativeErrCode, const simba_wstring &in_message, simba_signed_native in_rowNum=NO_ROW_NUMBER, simba_int32 in_colNum=NO_COLUMN_NUMBER)=0
 Sends an error to subscriber(s) of the listener.
virtual void PostPreformattedWarning (SQLState in_customState, simba_int32 in_nativeErrCode, const simba_wstring &in_message, simba_signed_native in_rowNum=NO_ROW_NUMBER, simba_int32 in_colNum=NO_COLUMN_NUMBER)=0
virtual void PostPreformattedWarning (DiagState in_stateKey, simba_int32 in_nativeErrCode, const simba_wstring &in_message, simba_signed_native in_rowNum=NO_ROW_NUMBER, simba_int32 in_colNum=NO_COLUMN_NUMBER)=0
virtual void PostWarning (ErrorException &in_errorAsWarning, SQLState in_customState)=0
 Posts an exception as a warning.
virtual void PostWarning (ErrorException &in_errorAsWarning, DiagState in_stateKey=DIAG_GENERAL_WARNING)=0
 Posts an exception as a warning. The DiagState of the exception is changed to DIAG_GENERAL_WARNING by default.
virtual void PostWarning (SQLState in_customState, simba_int32 in_componentID, const simba_wstring &in_msgKey, const std::vector< simba_wstring > &in_msgParams, simba_signed_native in_rowNum=NO_ROW_NUMBER, simba_int32 in_colNum=NO_COLUMN_NUMBER)=0
 Sends a warning to subscriber(s) of the listener. Requires the caller to pass in a message key and parameters to construct a message.
virtual void PostWarning (DiagState in_stateKey, simba_int32 in_componentID, const simba_wstring &in_msgKey, const std::vector< simba_wstring > &in_msgParams, simba_signed_native in_rowNum=NO_ROW_NUMBER, simba_int32 in_colNum=NO_COLUMN_NUMBER)=0
 Sends a warning to subscriber(s) of the listener. Requires the caller to pass in a message key and parameters to construct a message.
virtual void PostWarning (SQLState in_customState, simba_int32 in_componentID, const simba_wstring &in_msgKey, simba_signed_native in_rowNum=NO_ROW_NUMBER, simba_int32 in_colNum=NO_COLUMN_NUMBER)=0
 Sends a warning to subscriber(s) of the listener. Requires the caller to pass in a message key to construct a message.
virtual void PostWarning (DiagState in_stateKey, simba_int32 in_componentID, const simba_wstring &in_msgKey, simba_signed_native in_rowNum=NO_ROW_NUMBER, simba_int32 in_colNum=NO_COLUMN_NUMBER)=0
 Sends a warning to subscriber(s) of the listener. Requires the caller to pass in a message key to construct a message.
virtual void SetLocale (const simba_string &in_locale)=0
 Sets the locale for this IWarningListener.
virtual ~IWarningListener ()
 Destructor.

Protected Member Functions

 IWarningListener ()
 Default constructor.

Detailed Description

An interface for posting warnings.


Constructor & Destructor Documentation

virtual ~IWarningListener (  )  [inline, virtual]

Destructor.

IWarningListener (  )  [inline, protected]

Default constructor.


Member Function Documentation

virtual const simba_string& GetLocale (  )  [pure virtual]

Get the locale for this IWarningListener.

virtual void PostError ( ErrorException in_error  )  [pure virtual]

Create and add a new error record based on the ErrorException.

Sends a error to subscriber(s) of the listener.

Parameters:
in_error The exception to post to the error records.
virtual void PostError ( SQLState  in_customState,
simba_int32  in_componentID,
const simba_wstring in_msgKey,
simba_signed_native  in_rowNum = NO_ROW_NUMBER,
simba_int32  in_colNum = NO_COLUMN_NUMBER 
) [pure virtual]

Create a new error record based on the given information.

Sends a error to subscriber(s) of the listener.

Parameters:
in_customState SQLSTATE of the error.
in_componentID Component ID for the msgKey.
in_msgKey Key for the error message, to be used with IMessageSource.
in_rowNum Row where the error occurred. May be a non-negative integer, NO_ROW_NUMBER, or ROW_NUMBER_UNKNOWN.
in_colNum Column where the error occurred. May be a non-negative integer, NO_COLUMN_NUMBER, or COLUMN_NUMBER_UNKNOWN.
virtual void PostError ( SQLState  in_customState,
simba_int32  in_componentID,
const simba_wstring in_msgKey,
const std::vector< simba_wstring > &  in_msgParams,
simba_signed_native  in_rowNum = NO_ROW_NUMBER,
simba_int32  in_colNum = NO_COLUMN_NUMBER 
) [pure virtual]

Create a new error record based on the given information.

Sends a error to subscriber(s) of the listener. Requires the caller to pass in a message key and parameters to construct a message.

Parameters:
in_customState SQLSTATE of the error.
in_componentID Component ID for the msgKey.
in_msgKey Key for the error message, to be used with IMessageSource.
in_msgParams Parameters used to fill in message text.
in_rowNum Row where the error occurred. May be a non-negative integer, NO_ROW_NUMBER, or ROW_NUMBER_UNKNOWN.
in_colNum Column where the error occurred. May be a non-negative integer, NO_COLUMN_NUMBER, or COLUMN_NUMBER_UNKNOWN.
virtual void PostError ( DiagState  in_stateKey,
simba_int32  in_componentId,
const simba_wstring in_msgKey,
simba_signed_native  in_rowNum = NO_ROW_NUMBER,
simba_int32  in_colNum = NO_COLUMN_NUMBER 
) [pure virtual]

Create a new error record based on the given information.

Sends a error to subscriber(s) of the listener.

If an error DiagState is given, an assertion is triggered and it is stored as a "general error".

Parameters:
in_stateKey State key for the error.
in_componentID Component ID for the msgKey.
in_msgKey Key for the error message, to be used with IMessageSource.
in_rowNum Row where the error occurred. May be a non-negative integer, NO_ROW_NUMBER, or ROW_NUMBER_UNKNOWN.
in_colNum Column where the error occurred. May be a non-negative integer, NO_COLUMN_NUMBER, or COLUMN_NUMBER_UNKNOWN.
virtual void PostError ( DiagState  in_stateKey,
simba_int32  in_componentId,
const simba_wstring in_msgKey,
const std::vector< simba_wstring > &  in_msgParams,
simba_signed_native  in_rowNum = NO_ROW_NUMBER,
simba_int32  in_colNum = NO_COLUMN_NUMBER 
) [pure virtual]

Create a new error record based on the given information.

Sends a error to subscriber(s) of the listener. Requires the caller to pass in a message key and parameters to construct a message.

If an error DiagState is given, an assertion is triggered and it is stored as a "general error".

Parameters:
in_stateKey State key for the error.
in_componentID Component ID for the msgKey.
in_msgKey Key for the error message, to be used with IMessageSource.
in_msgParams Parameters used to fill in message text.
in_rowNum Row where the error occurred. May be a non-negative integer, NO_ROW_NUMBER, or ROW_NUMBER_UNKNOWN.
in_colNum Column where the error occurred. May be a non-negative integer, NO_COLUMN_NUMBER, or COLUMN_NUMBER_UNKNOWN.
virtual void PostPreformattedError ( SQLState  in_customState,
simba_int32  in_nativeErrCode,
const simba_wstring in_message,
simba_signed_native  in_rowNum = NO_ROW_NUMBER,
simba_int32  in_colNum = NO_COLUMN_NUMBER 
) [pure virtual]

Sends an error to subscriber(s) of the listener.

This function posts errors as if they had been thrown as exceptions.

This function requires the caller to have already constructed the entire error message. It does not use a message source and message key to construct a message.

Parameters:
in_customState SQLSTATE of the error. (Should be 5 characters long)
in_nativeErrCode Native error code.
in_message The error message.
in_rowNum Row where the error occurred. May be a non-negative integer, NO_ROW_NUMBER, or ROW_NUMBER_UNKNOWN.
in_colNum Column where the error occurred. May be a non-negative integer, NO_COLUMN_NUMBER, or COLUMN_NUMBER_UNKNOWN.
virtual void PostPreformattedError ( DiagState  in_stateKey,
simba_int32  in_nativeErrCode,
const simba_wstring in_message,
simba_signed_native  in_rowNum = NO_ROW_NUMBER,
simba_int32  in_colNum = NO_COLUMN_NUMBER 
) [pure virtual]

Sends an error to subscriber(s) of the listener.

This function posts errors as if they had been thrown as exceptions.

This function requires the caller to have already constructed the entire error message. It does not use a message source and message key to construct a message.

Parameters:
in_stateKey The type of error. Must be a DiagState value between FIRST_ERROR and LAST_ERROR.
in_nativeErrCode Native error code.
in_message The error message.
in_rowNum Row where the error occurred. May be a non-negative integer, NO_ROW_NUMBER, or ROW_NUMBER_UNKNOWN.
in_colNum Column where the error occurred. May be a non-negative integer, NO_COLUMN_NUMBER, or COLUMN_NUMBER_UNKNOWN.
virtual void PostPreformattedWarning ( SQLState  in_customState,
simba_int32  in_nativeErrCode,
const simba_wstring in_message,
simba_signed_native  in_rowNum = NO_ROW_NUMBER,
simba_int32  in_colNum = NO_COLUMN_NUMBER 
) [pure virtual]

Sends a warning to subscriber(s) of the listener. This function requires the caller to have already constructed the entire warning message. It does not use a message source and message key to construct a message.

Parameters:
in_customState SQLSTATE of the warning. (Should be 5 characters long)
in_nativeErrCode Native error code.
in_message The warning message.
in_rowNum Row where the warning occurred. May be a non-negative integer, NO_ROW_NUMBER, or ROW_NUMBER_UNKNOWN.
in_colNum Column where the warning occurred. May be a non-negative integer, NO_COLUMN_NUMBER, or COLUMN_NUMBER_UNKNOWN.
virtual void PostPreformattedWarning ( DiagState  in_stateKey,
simba_int32  in_nativeErrCode,
const simba_wstring in_message,
simba_signed_native  in_rowNum = NO_ROW_NUMBER,
simba_int32  in_colNum = NO_COLUMN_NUMBER 
) [pure virtual]

Sends a warning to subscriber(s) of the listener. This function requires the caller to have already constructed the entire warning message. It does not use a message source and message key to construct a message.

Parameters:
in_stateKey The type of warning. Must be a DiagState value between FIRST_WARNING and LAST_WARNING.
in_nativeErrCode Native error code.
in_message The warning message.
in_rowNum Row where the warning occurred. May be a non-negative integer, NO_ROW_NUMBER, or ROW_NUMBER_UNKNOWN.
in_colNum Column where the warning occurred. May be a non-negative integer, NO_COLUMN_NUMBER, or COLUMN_NUMBER_UNKNOWN.
virtual void PostWarning ( ErrorException in_errorAsWarning,
SQLState  in_customState 
) [pure virtual]

Posts an exception as a warning.

Parameters:
in_errorAsWarning Error exception to use as a warning.
in_customState SQLSTATE of the warning. (Should be 5 characters long)
virtual void PostWarning ( ErrorException in_errorAsWarning,
DiagState  in_stateKey = DIAG_GENERAL_WARNING 
) [pure virtual]

Posts an exception as a warning. The DiagState of the exception is changed to DIAG_GENERAL_WARNING by default.

Parameters:
in_errorAsWarning Error exception to use as a warning.
in_stateKey Warning state to use instead of state in the exception.
virtual void PostWarning ( SQLState  in_customState,
simba_int32  in_componentID,
const simba_wstring in_msgKey,
const std::vector< simba_wstring > &  in_msgParams,
simba_signed_native  in_rowNum = NO_ROW_NUMBER,
simba_int32  in_colNum = NO_COLUMN_NUMBER 
) [pure virtual]

Sends a warning to subscriber(s) of the listener. Requires the caller to pass in a message key and parameters to construct a message.

Parameters:
in_customState SQLSTATE of the warning. (Should be 5 characters long)
in_componentID Component ID for the msgKey.
in_msgKey Key for the warning message, to be used with IMessageSource.
in_msgParams Parameters used to fill in message text.
in_rowNum Row where the warning occurred. May be a non-negative integer, NO_ROW_NUMBER, or ROW_NUMBER_UNKNOWN.
in_colNum Column where the warning occurred. May be a non-negative integer, NO_COLUMN_NUMBER, or COLUMN_NUMBER_UNKNOWN.
virtual void PostWarning ( DiagState  in_stateKey,
simba_int32  in_componentID,
const simba_wstring in_msgKey,
const std::vector< simba_wstring > &  in_msgParams,
simba_signed_native  in_rowNum = NO_ROW_NUMBER,
simba_int32  in_colNum = NO_COLUMN_NUMBER 
) [pure virtual]

Sends a warning to subscriber(s) of the listener. Requires the caller to pass in a message key and parameters to construct a message.

Parameters:
in_stateKey The type of warning. Must be a DiagState value between FIRST_WARNING and LAST_WARNING.
in_componentID Component ID for the msgKey.
in_msgKey Key for the warning message, to be used with IMessageSource.
in_msgParams Parameters used to fill in message text.
in_rowNum Row where the warning occurred. May be a non-negative integer, NO_ROW_NUMBER, or ROW_NUMBER_UNKNOWN.
in_colNum Column where the warning occurred. May be a non-negative integer, NO_COLUMN_NUMBER, or COLUMN_NUMBER_UNKNOWN.
virtual void PostWarning ( SQLState  in_customState,
simba_int32  in_componentID,
const simba_wstring in_msgKey,
simba_signed_native  in_rowNum = NO_ROW_NUMBER,
simba_int32  in_colNum = NO_COLUMN_NUMBER 
) [pure virtual]

Sends a warning to subscriber(s) of the listener. Requires the caller to pass in a message key to construct a message.

Parameters:
in_customState SQLSTATE of the warning. (Should be 5 characters long)
in_componentID Component ID for the msgKey.
in_msgKey Key for the warning message, to be used with IMessageSource.
in_rowNum Row where the warning occurred. May be a non-negative integer, NO_ROW_NUMBER, or ROW_NUMBER_UNKNOWN.
in_colNum Column where the warning occurred. May be a non-negative integer, NO_COLUMN_NUMBER, or COLUMN_NUMBER_UNKNOWN.
virtual void PostWarning ( DiagState  in_stateKey,
simba_int32  in_componentID,
const simba_wstring in_msgKey,
simba_signed_native  in_rowNum = NO_ROW_NUMBER,
simba_int32  in_colNum = NO_COLUMN_NUMBER 
) [pure virtual]

Sends a warning to subscriber(s) of the listener. Requires the caller to pass in a message key to construct a message.

Parameters:
in_stateKey The type of warning. Must be a DiagState value between FIRST_WARNING and LAST_WARNING.
in_componentID Component ID for the msgKey.
in_msgKey Key for the warning message, to be used with IMessageSource.
in_rowNum Row where the warning occurred. May be a non-negative integer, NO_ROW_NUMBER, or ROW_NUMBER_UNKNOWN.
in_colNum Column where the warning occurred. May be a non-negative integer, NO_COLUMN_NUMBER, or COLUMN_NUMBER_UNKNOWN.
virtual void SetLocale ( const simba_string in_locale  )  [pure virtual]

Sets the locale for this IWarningListener.

Parameters:
in_locale The locale.

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

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