com.sap.portal.admin.editor.exception

Class EditorResourceException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.sap.portal.admin.editor.exception.EditorFrameworkException
              com.sap.portal.admin.editor.exception.EditorResourceException

All Implemented Interfaces:

Serializable

public class EditorResourceException
extends EditorFrameworkException

The exception that indicates that an error occurred in the resource being used by the editor. This exception is thrown by loadData, saveData and getLock.
This exception is a showstopper for the editor. The editor framework displays the error message instead of the regular editor user interface.

See Also:

Serialized Form

Constructor Summary

EditorResourceException(String message, String endUserMessageKey, String[] params)
A constructor that sets the error string.

EditorResourceException(String message, String endUserMessageKey, String[] params, Throwable nestedException)
A constructor that wraps an existing exception in this exception and sets the error string.

Method Summary

String	getEndUserMessageKey() Gets a key for an error message that is displayed to the end-user instead of the editor regular user interface.
String[]	getEndUserMessageParams() Gets the end-user parameters entered at runtime.

Methods inherited from class com.sap.portal.admin.editor.exception.EditorFrameworkException

getNestedException, printStackTrace, printStackTrace, printStackTrace

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

EditorResourceException

public EditorResourceException(String message,
                               String endUserMessageKey,
                               String[] params)

A constructor that sets the error string.

Parameters:

message - an error message

endUserMessageKey - the key of the message that is displayed

params - end-user parameters

EditorResourceException

public EditorResourceException(String message,
                               String endUserMessageKey,
                               String[] params,
                               Throwable nestedException)

A constructor that wraps an existing exception in this exception and sets the error string.

Parameters:

message - an error message

endUserMessageKey - the key of the message that is displayed

params - end-user parameters

nestedException - an existing exception

Method Detail

getEndUserMessageKey

public String getEndUserMessageKey()

Gets a key for an error message that is displayed to the end-user instead of the editor regular user interface.

Returns:

a key

getEndUserMessageParams

public String[] getEndUserMessageParams()

Gets the end-user parameters entered at runtime.

Returns:

the end-user message parameters

Access Rights

This class can be accessed from:

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