ak.err
Interface IF_AppError

All Known Implementing Classes:
AppError

abstract interface IF_AppError

Class AppErr represent any application error. This class is the superclass of any particular application error. It contains the whole functionality of an exception. The derived classes are differ only by constructor. Application error gets the action-information dynamically from a configuration file(e.g. per module/per application).

Version:
V1.1 Copyright(c)2000 Alexej Kupin

Method Summary
 void addComponent(java.lang.String sComponent)
          user may use this function to indicate in which class, which method is the error occured(nested errors)
 void addInfo(java.lang.String sInfo)
          user may use this function to keep tech-information separately. specialy for communication. (e.g.
 void addParam(java.lang.String sParam)
          user may use this function to add the information about the parameters which causes this error(e.g.
 AppErrorItem getErrItem()
          gets the error description object(ErrItem)
 java.lang.String getMessage()
          gets the error message string
 java.lang.String GetPath()
          GetPath of the init-file (default)
 java.lang.String GetPath(java.lang.String sName)
          GetPath of the init-file (for a given name)
 void log()
          logs the error description information
 void log(java.lang.String sMSG)
          logs the message
 java.lang.String ObjectToString()
          In Order to pass this error over CORBA/RMI We need to define two conversion methods: StringToObject(String sObj);ObjectToString();
 void SetEnv(java.lang.String sApp, java.lang.String sSeverity, java.lang.String sCategory)
          Delegate methods to access error Item: Sets error environment: - Application Name (-> config file) - Error severity(e.g.
 void SetMsg(java.lang.String sMsg, java.lang.String sMsgShort, java.lang.String sDoAction)
          Delegate methods to access error Item: Sets error message: - Full message(e.g. for log-file) - Short message(e.g. for user) - Recomended action
 void show()
          shows the information in an message-box (only if DISPLAY_FLG is ON; see config-file)
 void show(java.lang.String sMSG)
          shows the message in an message-box (only if DISPLAY_FLG is ON; see config-file)
 boolean showAsk()
          shows the information in an ask-box (only if DISPLAY_FLG is ON; see config-file)
 boolean showAsk(java.lang.String sMSG)
          shows the message in an ask-box (only if DISPLAY_FLG is ON; see config-file)
 boolean showError()
          shows the information in an error-box (only if DISPLAY_FLG is ON; see config-file)
 boolean showError(java.lang.String sMSG)
          shows the message in an error-box (only if DISPLAY_FLG is ON; see config-file)
 void showInfo()
          shows the information in an info-box (only if DISPLAY_FLG is ON; see config-file)
 void showInfo(java.lang.String sMSG)
          shows the message in an info-box (only if DISPLAY_FLG is ON; see config-file)
 void showWarning()
          shows the information in a warning-box (only if DISPLAY_FLG is ON; see config-file)
 void showWarning(java.lang.String sMSG)
          shows the message in a warning-box (only if DISPLAY_FLG is ON; see config-file)
 void StringToObject(java.lang.String sObj)
          In Order to pass this error over CORBA/RMI We need to define two conversion methods: StringToObject(String sObj);ObjectToString();
 

Method Detail

StringToObject

public void StringToObject(java.lang.String sObj)
In Order to pass this error over CORBA/RMI We need to define two conversion methods: StringToObject(String sObj);ObjectToString();

ObjectToString

public java.lang.String ObjectToString()
In Order to pass this error over CORBA/RMI We need to define two conversion methods: StringToObject(String sObj);ObjectToString();

getErrItem

public AppErrorItem getErrItem()
gets the error description object(ErrItem)

GetPath

public java.lang.String GetPath()
GetPath of the init-file (default)

GetPath

public java.lang.String GetPath(java.lang.String sName)
GetPath of the init-file (for a given name)

SetEnv

public void SetEnv(java.lang.String sApp,
                   java.lang.String sSeverity,
                   java.lang.String sCategory)
Delegate methods to access error Item: Sets error environment: - Application Name (-> config file) - Error severity(e.g. FATAL/MINOR) - Category(e.g. DB/CONN/SYSTEM)

SetMsg

public void SetMsg(java.lang.String sMsg,
                   java.lang.String sMsgShort,
                   java.lang.String sDoAction)
Delegate methods to access error Item: Sets error message: - Full message(e.g. for log-file) - Short message(e.g. for user) - Recomended action

addParam

public void addParam(java.lang.String sParam)
user may use this function to add the information about the parameters which causes this error(e.g. UID expired!)

addComponent

public void addComponent(java.lang.String sComponent)
user may use this function to indicate in which class, which method is the error occured(nested errors)

addInfo

public void addInfo(java.lang.String sInfo)
user may use this function to keep tech-information separately. specialy for communication. (e.g. "ORA-125-09" or "wrong port:8717")

getMessage

public java.lang.String getMessage()
gets the error message string

log

public void log()
logs the error description information

log

public void log(java.lang.String sMSG)
logs the message

show

public void show()
shows the information in an message-box (only if DISPLAY_FLG is ON; see config-file)

show

public void show(java.lang.String sMSG)
shows the message in an message-box (only if DISPLAY_FLG is ON; see config-file)

showInfo

public void showInfo()
shows the information in an info-box (only if DISPLAY_FLG is ON; see config-file)

showInfo

public void showInfo(java.lang.String sMSG)
shows the message in an info-box (only if DISPLAY_FLG is ON; see config-file)

showWarning

public void showWarning()
shows the information in a warning-box (only if DISPLAY_FLG is ON; see config-file)

showWarning

public void showWarning(java.lang.String sMSG)
shows the message in a warning-box (only if DISPLAY_FLG is ON; see config-file)

showError

public boolean showError()
shows the information in an error-box (only if DISPLAY_FLG is ON; see config-file)

showError

public boolean showError(java.lang.String sMSG)
shows the message in an error-box (only if DISPLAY_FLG is ON; see config-file)

showAsk

public boolean showAsk()
shows the information in an ask-box (only if DISPLAY_FLG is ON; see config-file)

showAsk

public boolean showAsk(java.lang.String sMSG)
shows the message in an ask-box (only if DISPLAY_FLG is ON; see config-file)