de.tif.jacob.core.exception
Class UserException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          de.tif.jacob.core.exception.UserException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AuthenticationException, AuthorizationException, InvalidApplicationException, InvalidExpressionException, InvalidNewPasswordException, RecordLockedException, RecordNotFoundException, RequiredFieldException, TerminatedSessionException, TimeoutApplicationException, UncommittedLinkedRecordException, UniqueViolationException, UserNotExistingException

public class UserException
extends java.lang.Exception

UserException is the base class of all (non runtime) exceptions which in general result due to inproper user operation.

Exceptions of type UserException should be handled by gui clients by means of generating a nice (i.e. a localized, user understandable) warning.

See Also:

UserRuntimeException, Serialized Form

Field Summary

static java.lang.String	RCS_ID The internal revision control system id.
static java.lang.String	RCS_REV The internal revision control system id in short form.

Constructor Summary

UserException(Message message)
Constructs a new user exception with the specified internationalized detail message.

UserException(Message message, java.lang.Throwable cause)
Constructs a new user exception with the specified internationalized detail message and an additional exception cause.

UserException(java.lang.String message)
Constructs a new user exception with the specified detail message.

Method Summary

java.lang.String	getLocalizedMessage(java.util.Locale locale) Returns a localized detail message for the given locale.
java.lang.String	getMessage() Returns the detail message.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

RCS_ID

public static final transient java.lang.String RCS_ID

The internal revision control system id.

See Also:

Constant Field Values

RCS_REV

public static final transient java.lang.String RCS_REV

The internal revision control system id in short form.

See Also:

Constant Field Values

Constructor Detail

UserException

public UserException(java.lang.String message)

Constructs a new user exception with the specified detail message.

Note: This constructor should only be used, if your application is not designed for multi language support! To internationalize the exception use UserException(Message) or UserException(Message, Throwable).

Parameters:

message - the detail message

UserException

public UserException(Message message)

Constructs a new user exception with the specified internationalized detail message.

Parameters:

message - the internationalized detail message

UserException

public UserException(Message message,
                     java.lang.Throwable cause)

Constructs a new user exception with the specified internationalized detail message and an additional exception cause.

Parameters:

message - the internationalized detail message

cause - the original cause

Method Detail

getLocalizedMessage

public java.lang.String getLocalizedMessage(java.util.Locale locale)

Returns a localized detail message for the given locale.

Parameters:

locale - the locale

Returns:

localized detail message

getMessage

public java.lang.String getMessage()

Returns the detail message. If possible, the message is localized.

Overrides:

getMessage in class java.lang.Throwable

Returns:

detail message

See Also:

Throwable.getMessage()