com.essbase.api.session

Interface IEssCustomMessageHandler

All Superinterfaces:

java.io.Serializable

public interface IEssCustomMessageHandler
extends java.io.Serializable

Author:

sramanav

Method Summary

Modifier and Type	Method and Description
int	processMessage(int messageNumber, int messageLevel, java.lang.String messageString) This is the call back method that is invoked by JAPI lower level for processing the message.

Method Detail

processMessage

int processMessage(int messageNumber,
                   int messageLevel,
                   java.lang.String messageString)

This is the call back method that is invoked by JAPI lower level for processing the message.

Parameters:

messageNumber - : the message number returned by Essbase server.

messageLevel - : the message level, it can hold one of following values.
NET_MSG_NONE = 0 : not a valid message level
NET_MSG_DEBUG = 1 : debug message (DEBUG only)
NET_MSG_INFO = 2 : information message
NET_MSG_WARNING = 3 : warning message
NET_MSG_ERROR = 4 : error message - abort operation
NET_MSG_SILENT = 5 : error message - don't display
NET_MSG_INTERNAL = 6 : internal error (DEBUG ONLY)
NET_MSG_SERIOUS = 7 : serious error - abort operation
NET_MSG_FATAL = 8 : fatal error - abort server

messageString - : the message string returned by Essbase server.

Returns:

the messageNumber : an integer data type value, which will indicate the messageNumber that is to be used by JAPI for processing the message returned by Essbase