com.isti.util
Class ErrorMessageMgr

java.lang.Object
  extended by com.isti.util.ErrorMessageMgr
All Implemented Interfaces:
ErrorMsgMgrIntf
Direct Known Subclasses:
AddrPortListMgr, ClientLogViaCfgProps, CubicSpline, FileDataMonitor, IstiXmlUtils, JavaMailUtil, LogFileViaCfgProps

public class ErrorMessageMgr
extends java.lang.Object
implements ErrorMsgMgrIntf

Class ErrorMessageMgr manages an error message string.


Constructor Summary
ErrorMessageMgr()
           
 
Method Summary
 void clearErrorMessageString()
          Clears any current error message.
 void clearFetchedErrorMessage()
          Clears the current error message only if it has been fetched (via the 'getErrorMessageString()' method).
protected  void enterErrorMessageString(java.lang.String str)
          Enters the error message (if the error message is currently clear).
 boolean getErrorMessageFlag()
          Returns the status of the error message.
 java.lang.String getErrorMessageString()
          Returns the current error message (if any).
 boolean getUnfetchedMessageFlag()
          Returns the "unfetched" status of the error message.
protected  void setErrorMessageString(java.lang.String str)
          Sets the error message.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ErrorMessageMgr

public ErrorMessageMgr()
Method Detail

getErrorMessageFlag

public boolean getErrorMessageFlag()
Returns the status of the error message.

Specified by:
getErrorMessageFlag in interface ErrorMsgMgrIntf
Returns:
true if an error message is set; false if not.

getErrorMessageString

public java.lang.String getErrorMessageString()
Returns the current error message (if any).

Specified by:
getErrorMessageString in interface ErrorMsgMgrIntf
Returns:
The current error message, or null if no errors have occurred.

clearErrorMessageString

public void clearErrorMessageString()
Clears any current error message.

Specified by:
clearErrorMessageString in interface ErrorMsgMgrIntf

clearFetchedErrorMessage

public void clearFetchedErrorMessage()
Clears the current error message only if it has been fetched (via the 'getErrorMessageString()' method).

Specified by:
clearFetchedErrorMessage in interface ErrorMsgMgrIntf

getUnfetchedMessageFlag

public boolean getUnfetchedMessageFlag()
Returns the "unfetched" status of the error message.

Specified by:
getUnfetchedMessageFlag in interface ErrorMsgMgrIntf
Returns:
true if an error message is set and it has not been fetched (via the 'getErrorMessageString()' method); false if not.

setErrorMessageString

protected void setErrorMessageString(java.lang.String str)
Sets the error message. Any previously set error message is overwritten.

Parameters:
str - the error message text to set.

enterErrorMessageString

protected void enterErrorMessageString(java.lang.String str)
Enters the error message (if the error message is currently clear).

Parameters:
str - the error message text to set.