oracle.epm.fm.common.exception

Class HFMException

java.lang.Object

java.lang.Throwable

java.lang.Exception

oracle.epm.fm.common.exception.HFMException

All Implemented Interfaces:

Serializable

public class HFMException
extends Exception

The class HFMException is subclass of java Exception class. Any checked exception in the JOM would be thrown as form of type of HFMException. This Exception class is used to report well-formedness errors as well as unexpected processing conditions in the JOM.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HFMException() The default constructor HFMException class.
HFMException(HFMException ex) Construct an HFM Exception with the assocated exception.
HFMException(String errorCode) Construct an exception with the assocated error code.
HFMException(String errorCode, List<String> params) Construct an exception with the assocated error code and detailed exception message.
HFMException(String message, String localizedMessage) Should be used when server returns back a localized message indicating an error try{ // some server code here.
HFMException(THFMException ex) This exception has the constructor taking the THFMException argument.
HFMException(THFMException ex, String errorCode) This exception has the constructor taking the THFMException argument.
HFMException(THFMException ex, String errorCode, List<String> params) This exception has the constructor taking the THFMException argument.
HFMException(Throwable throwable) This exception has the constructor taking the throwable argument.
HFMException(Throwable throwable, String errorCode) This exception has the constructor taking the throwable argument and ErrorCodeConstants Error code..
HFMException(Throwable throwable, String errorCode, List<String> params) This exception has the constructor taking the throwable argument, ErrorCodeConstants Error code and List of Strings with more message for the exception.

Method Summary

Modifier and Type	Method and Description
String	getErrorCode() get the error code for the current exception.
String	getExceptionType() get the exception type as string.
int	getHResult() get the HR result value.
String	getLocalizedMessage() Returns the localized message for the current exception error code.
String	getLocalizedMessage(Locale locale) get the localized message for the current exception error code for the given locale.
String	getMessage() The current error message for this exception would be returned.
List<String>	getParams() get the error messages as list of string.
List<TraceEntry>	getServerStackTrace()
boolean	hasGlobalErrors()
void	setErrorCode(String errorCode)
void	setExceptionType(String exceptionType) set the exception type as string.
void	setHResult(int hResult) Set the HResult value.
void	setLocalizedMessage(String localizedMessage) set the localised message for the current exception.
void	setMessage(String message) Sets the error message for the current exception.
void	setParams(List<String> params) set the error messages as list of string.
void	setServerStackTrace(List<TraceEntry> stackTrace)

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

HFMException

public HFMException()

The default constructor HFMException class. Constructs a new exception with null as its detail message.

HFMException

public HFMException(HFMException ex)

Construct an HFM Exception with the assocated exception. try{ // some code here }catch(Exception ex){ throw new HFMException(ex); } HFMExcetion can be created by HFMException exception = new HFMException(hfmException); where hfmException is type of HFMException.

Parameters:

ex - - the base exception encountered.

HFMException

public HFMException(String errorCode)

Construct an exception with the assocated error code. The error code should use the constants from ErrorCodeConstants class. HFMExcetion can be created by HFMException exception = new HFMException(ErrorCodeConstants.UNKNOWN_ERROR);

Parameters:

errorCode - - the detailed error message for the exception encountered.

HFMException

public HFMException(String errorCode,
                    List<String> params)

Construct an exception with the assocated error code and detailed exception message. The error code should use the constants from ErrorCodeConstants class. The exception message should be added as List of Strings. HFMExcetion can be created by ArrayList<String> messages = new ArrayList<String>(); list.add("Encountered error in loading the data"); or try{ // some code here. }catch(Exception e){ ArrayList<String> list = new ArrayList<String>(); list.add("Error in loading the data"); list.add(e.getMessage()); throw new HFMException(ErrorCodeConstans.UNKNOWN_ERROR,list); }

Parameters:

errorCode - - the error code message for the exception encountered.

params - - the list of error message encountered.

HFMException

public HFMException(String message,
                    String localizedMessage)

Should be used when server returns back a localized message indicating an error try{ // some server code here. }catch(TException e){ throw new HFMException(ErrorCodeConstans.UNKNOWN_ERROR,e.getMessage()); }

Parameters:

message - - the actual translated message (not a key to resources)

localizedMessage - - the actual localized translated message (not a key to resources)

HFMException

public HFMException(Throwable throwable)

This exception has the constructor taking the throwable argument. Should be used when rethrowing server error or any other encountered exception. try{ // some server code here. }catch(TException e){ throw new HFMException(e.getCause()); }

Parameters:

throwable - - the actual exception encountered.

HFMException

public HFMException(Throwable throwable,
                    String errorCode)

This exception has the constructor taking the throwable argument and ErrorCodeConstants Error code.. Should be used when rethrowing server error or any other encountered exception. try{ // some server code here. }catch(TException e){ throw new HFMException(e.getCause(),ErrorCodeConstants.UNKNOWN_ERROR); }

Parameters:

throwable - - the actual exception encountered.

errorCode - - the error code for the exception encountered.

HFMException

public HFMException(Throwable throwable,
                    String errorCode,
                    List<String> params)

This exception has the constructor taking the throwable argument, ErrorCodeConstants Error code and List of Strings with more message for the exception. Should be used when rethrowing server error or any other encountered exception. try{ // some server code here. }catch(TException e){ ArrayList<String> list = new ArrayList<String>(); list.add("Error in loading the data"); list.add(e.getMessage()); throw new HFMException(e.getCause(),ErrorCodeConstants.UNKNOWN_ERROR,ErrorCodeConstants.UNKNWON_ERROR,list); }

Parameters:

throwable - - the actual exception encountered.

errorCode - - the error code message for the exception.

params - - the detailed messaging for the exception.

HFMException

public HFMException(THFMException ex)

This exception has the constructor taking the THFMException argument. Should be used when rethrowing server error or any other encountered exception. try{ // some server code here. }catch(TException e){ throw new HFMException(e); }

Parameters:

ex - - the actual exception encountered.

HFMException

public HFMException(THFMException ex,
                    String errorCode)

This exception has the constructor taking the THFMException argument. Should be used when rethrowing server error or any other encountered exception. try{ // some server code here. }catch(TException e){ throw new HFMException(e,ErrorCodeConstants.UNKNOWN_ERROR); }

Parameters:

ex - - the actual exception encountered.

errorCode - - the Error code Constant .

HFMException

public HFMException(THFMException ex,
                    String errorCode,
                    List<String> params)

This exception has the constructor taking the THFMException argument. Should be used when rethrowing server error or any other encountered exception. try{ // some server code here. }catch(TException e){ ArrayList<String> list = new ArrayList<String>(); list.add("Error in loading the data"); list.add(e.getMessage()); throw new HFMException(e,ErrorCodeConstants.UNKNOWN_ERROR,list); }

Parameters:

ex - - the actual exception encountered.

errorCode - - the Error code Constant .

params - - the list of error messages .

Method Detail

hasGlobalErrors

public boolean hasGlobalErrors()

setHResult

public void setHResult(int hResult)

Set the HResult value.

Parameters:

hResult - - the hresult message.

getHResult

public int getHResult()

get the HR result value.

Returns:

int

setExceptionType

public void setExceptionType(String exceptionType)

set the exception type as string.

Parameters:

exceptionType - - the exception type as string

getExceptionType

public String getExceptionType()

get the exception type as string.

Returns:

String - the exception type as string.

setParams

public void setParams(List<String> params)

set the error messages as list of string.

Parameters:

params - - the list of error messages encountered.

getParams

public List<String> getParams()

get the error messages as list of string.

Returns:

list.

setLocalizedMessage

public void setLocalizedMessage(String localizedMessage)

set the localised message for the current exception.

Parameters:

localizedMessage - - the localized message for the current exception.

getLocalizedMessage

public String getLocalizedMessage()

Returns the localized message for the current exception error code.

Overrides:

getLocalizedMessage in class Throwable

Returns:

String

getLocalizedMessage

public String getLocalizedMessage(Locale locale)

get the localized message for the current exception error code for the given locale.

Parameters:

locale - if the locale is found, the error message on the given locale would be returned. if the locale is not found message for the default locale would be returned.

Returns:

String

setMessage

public void setMessage(String message)

Sets the error message for the current exception.

Parameters:

message - - the error code message.

getMessage

public String getMessage()

The current error message for this exception would be returned.

Overrides:

getMessage in class Throwable

Returns:

String

setServerStackTrace

public void setServerStackTrace(List<TraceEntry> stackTrace)

getServerStackTrace

public List<TraceEntry> getServerStackTrace()

setErrorCode

public void setErrorCode(String errorCode)

getErrorCode

public String getErrorCode()

get the error code for the current exception.

Returns:

String