ariba.util.core
Class TransientException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              ariba.util.core.TransientException

All Implemented Interfaces:

java.io.Serializable

public class TransientException
extends java.lang.RuntimeException

TransientException is designed to be thrown by application code that needs to halt execution of an action and display a localized error message to the user about the error while running an action in the UI. Its message should be an already localized string in the current session's locale, so it can be displayed in the UI as if it were an error message provided by the validation conditions or the application UI code. It is generally used for conditions that are too expensive or obscure to check in the UI, and get detected during the action execution, including in non-UI application business logic code in classes in collaborate.main, etc.

See Also:

Serialized Form

Constructor Summary

TransientException(java.lang.String message)
Construct a new TransientException with the given message string, which should have already been localized into the current session's locale; it will be displayed to the user in the UI on the same page where the exception is thrown, if the exception is thrown during action execution.

TransientException(java.lang.String message, boolean forceHome)
Construct a new TransientException with the given message string, which should have already been localized into the current session's locale; it will be displayed to the user in the UI.

Method Summary

static TransientException	asCauseOf(java.lang.Throwable t) Returns TransientException that is the given Throwable or is its direct or indirect cause, and returns null if there is no TransientException in the causal chain.
boolean	forceHome() Returns true if the forceHome flag was set to true when this TransientException was constructed.

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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TransientException

public TransientException(java.lang.String message)

Construct a new TransientException with the given message string, which should have already been localized into the current session's locale; it will be displayed to the user in the UI on the same page where the exception is thrown, if the exception is thrown during action execution. It should not be thrown during appendToResponse or takeValues unless it will be caught in the application, because the UI framework is unlikely to be able to do anything other than display a stack trace if it is thrown outside action execution and not caught by the application code.

TransientException

public TransientException(java.lang.String message,
                          boolean forceHome)

Construct a new TransientException with the given message string, which should have already been localized into the current session's locale; it will be displayed to the user in the UI. If forceHome is true, the UI may attention to it and try to take the user to the application "home" page rather than staying on the same page, but the catching context may also ignore it.

Method Detail

forceHome

public boolean forceHome()

Returns true if the forceHome flag was set to true when this TransientException was constructed.

asCauseOf

public static TransientException asCauseOf(java.lang.Throwable t)

Returns TransientException that is the given Throwable or is its direct or indirect cause, and returns null if there is no TransientException in the causal chain.