com.plumtree.uiinfrastructure.interpreter
Class InterpreterException

java.lang.Object
  XPException
      com.plumtree.uiinfrastructure.interpreter.InterpreterException

Direct Known Subclasses:

UnauthorizedAccessException

public class InterpreterException
extends XPException

This class is used to convey an error or exception information back to the Interpreter. Upon receiving this exception, the Interpreter will display an error page containing a (localized) error message from this exception, if there is any.

Author:

William Adjie-Winoto

Field Summary

static int	INVALID_HTTP_STATUS_CODE
static int	INVALID_ID

Constructor Summary

InterpreterException()
Default Constructor

InterpreterException(int _nMessageStringID, java.lang.String _strResourceFileName, java.lang.String _strNonLocalizedMessage)
Contructor.

InterpreterException(int _nMessageStringID, java.lang.String _strResourceFileName, java.lang.String _strNonLocalizedMessage, int _nHttpStatusCode)
Contructor.

Method Summary

int	GetHTTPStatusCode()
int	GetMessageStringID()
java.lang.String	GetNonLocalizedMessage()
java.lang.String	GetResourceFileName()
void	GetResourceFileName(java.lang.String _strFilename)
void	SetHTTPStatusCode(int _nStatusCode)
void	SetMessageStringID(int _nId)
void	SetNonLocalizedMessage(java.lang.String _strNonLocalizedMessage)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INVALID_ID

public static final int INVALID_ID

See Also:

Constant Field Values

INVALID_HTTP_STATUS_CODE

public static final int INVALID_HTTP_STATUS_CODE

See Also:

Constant Field Values

Constructor Detail

InterpreterException

public InterpreterException()

Default Constructor

InterpreterException

public InterpreterException(int _nMessageStringID,
                            java.lang.String _strResourceFileName,
                            java.lang.String _strNonLocalizedMessage)

Contructor.

Parameters:

_nMessageStringID - the message string ID in the resource file

_strResourceFileName - the name of the resource file

_strNonLocalizedMessage - the non-localized version of the message

InterpreterException

public InterpreterException(int _nMessageStringID,
                            java.lang.String _strResourceFileName,
                            java.lang.String _strNonLocalizedMessage,
                            int _nHttpStatusCode)

Contructor.

Parameters:

_nMessageStringID - the message string ID in the resource file

_strResourceFileName - the name of the resource file

_strNonLocalizedMessage - the non-localized version of the message

_nHttpStatusCode - the HTTP status code for the HTTP response

Method Detail

GetMessageStringID

public int GetMessageStringID()

SetMessageStringID

public void SetMessageStringID(int _nId)

GetResourceFileName

public java.lang.String GetResourceFileName()

GetResourceFileName

public void GetResourceFileName(java.lang.String _strFilename)

GetNonLocalizedMessage

public java.lang.String GetNonLocalizedMessage()

SetNonLocalizedMessage

public void SetNonLocalizedMessage(java.lang.String _strNonLocalizedMessage)

GetHTTPStatusCode

public int GetHTTPStatusCode()

SetHTTPStatusCode

public void SetHTTPStatusCode(int _nStatusCode)