com.sap.portal.obn.exceptions

Class OBNException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.sap.portal.obn.exceptions.OBNException

All Implemented Interfaces:

Serializable

public class OBNException
extends Exception

This exception indicates an error that originates from Object Based Navigation framework.
It provides localized error messages that can be used by consumers to report OBN related errors to the user interface.
Only the OBN framework is allowed to instantiate this class.

See Also:

Serialized Form

Constructor Summary

protected	OBNException() Constructor for sub-classes.
	OBNException(Exception e) Deprecated. As of NW7.11 SP1. Only OBN is allowed to instantiate this class
	OBNException(String message) Deprecated. As of NW7.11 SP1. Only OBN is allowed to instantiate this class

Method Summary

String	getDetailedMessage(Locale locale) Gets the detailed error message describing this exception
String	getMessage(Locale locale) Gets the error message describing this exception.
String	getShortMessage(Locale locale) Gets the short error message describing this exception

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, 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

OBNException

protected OBNException()

Constructor for sub-classes.

OBNException

public OBNException(String message)

Deprecated. As of NW7.11 SP1. Only OBN is allowed to instantiate this class

A constructor that sets the error message.

Parameters:

message - Error message

OBNException

public OBNException(Exception e)

Deprecated. As of NW7.11 SP1. Only OBN is allowed to instantiate this class

A constructor that wraps an existing exception in this exception.

Parameters:

e - Existing exception

Method Detail

getMessage

public String getMessage(Locale locale)

Gets the error message describing this exception. The error message could be detailed or short, depending on OBN configuration.

Parameters:

locale - Locale of message

Returns:

Error message

getDetailedMessage

public String getDetailedMessage(Locale locale)

Gets the detailed error message describing this exception

Parameters:

locale - Locale of message

Returns:

Error message if Detailed Error Messaging is enabled, null otherwise

getShortMessage

public String getShortMessage(Locale locale)

Gets the short error message describing this exception

Parameters:

locale - Locale of message

Returns:

Error message

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] tc/ep/navigation/api	api	EP-PIN