com.sapportals.portal.prt.component
Class PortalComponentException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--java.lang.RuntimeException
                    |
                    +--com.sapportals.portal.prt.runtime.PortalRuntimeException
                          |
                          +--com.sapportals.portal.prt.component.PortalComponentException

All Implemented Interfaces:

java.io.Serializable

public class PortalComponentException

extends PortalRuntimeException

The Portal Component Exception is the base class for all the exceptions raised by the Portal builder runtime.
It is also a wrapper for exception occuring inside the runtime.

See Also:

Serialized Form

Constructor Summary

PortalComponentException(java.lang.String s)
PortalComponentException constructor.

PortalComponentException(java.lang.String s, java.lang.Throwable exception)
Exception wrapper constructor.

PortalComponentException(java.lang.Throwable exception)
Exception wrapper constructor.

Method Summary

java.lang.String	getMessage() overloads the superclass implementation to provide move details including the name of the component the associated class and the user information if exists.
void	setDetail(IPortalComponentRequest request) this methods is called to provide further information about the context of the exception.
void	setDetail(java.lang.String userName, java.lang.String componentName, java.lang.String componentClass) this methods is called to provide further information about the context of the exception.

Methods inherited from class com.sapportals.portal.prt.runtime.PortalRuntimeException

getCause, getException, printStackTrace, printStackTrace, printStackTrace, setCause, setException, toHTML, toText

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PortalComponentException

public PortalComponentException(java.lang.String s)

PortalComponentException constructor.

Parameters:

s - a short String describing the exception

PortalComponentException

public PortalComponentException(java.lang.Throwable exception)

Exception wrapper constructor.

Parameters:

exception - a Throwable object referring to the original exception

PortalComponentException

public PortalComponentException(java.lang.String s,
                                java.lang.Throwable exception)

Exception wrapper constructor.

Parameters:

s - a short String describing the exception

exception - a Throwable object referring to the original exception

Method Detail

setDetail

public void setDetail(IPortalComponentRequest request)

this methods is called to provide further information about the context of the exception.

Parameters:

request - The portal component request containning the current component context

setDetail

public void setDetail(java.lang.String userName,
                      java.lang.String componentName,
                      java.lang.String componentClass)

this methods is called to provide further information about the context of the exception.

Parameters:

request - The portal component request containning the current component context

getMessage

public java.lang.String getMessage()

overloads the superclass implementation to provide move details including the name of the component the associated class and the user information if exists.

Overrides:

getMessage in class java.lang.Throwable

Returns:

the formatted message corresponding to the enriched exception