# com.beasys.commerce.foundation.exception
MessageCatalogException Interface

public interface MessageCatalogException

The `MessageCatalogException` interface is the interface implemented by all `MessageCatalog```-aware exceptions. All such exceptions should contain both log and user messages that are constructed using the `MessageCatalog`.

Related Topics

``MessageCatalog``

All Known Implementing Classes
  `ApplicationException`, `FatalApplicationException`, `SystemException`

## Method Summary

`public void` | `addLogMessage`(`String` namespace, `String` messageKey) Adds a new log catalog message to the stack of associated messages.
`public void` | `addLogMessage`(`String` namespace, `String` messageKey, `Object` argument) Adds a new log catalog message to the stack of associated messages.
`public void` | `addLogMessage`(`String` namespace, `String` messageKey, `Object`[] aguments) Adds a new log catalog message to the stack of associated messages.
`public void` | `addMessage`(`String` namespace, `String` messageKey) Adds a new user and log catalog message to the stack of associated messages.
`public void` | `addMessage`(`String` namespace, `String` messageKey, `Object` argument) Adds a new user catalog message to the stack of associated messages.
`public void` | `addMessage`(`String` namespace, `String` messageKey, `Object`[] aguments) Adds a new user catalog message to the stack of associated messages.
`public void` | `addUserMessage`(`String` namespace, `String` messageKey) Adds a new user catalog message to the stack of associated messages.
`public void` | `addUserMessage`(`String` namespace, `String` messageKey, `Object` argument) Adds a new user catalog message to the stack of associated messages.
`public void` | `addUserMessage`(`String` namespace, `String` messageKey, `Object`[] aguments) Adds a new user catalog message to the stack of associated messages.
`public `Exception`` | `getEmbeddedException`() Gets the embedded exception associated with this exception.
`public `String`` | `getLogMessage`() Returns the first log catalog message associated with this exception.
`public `Iterator`` | `getLogMessages`() Returns an iterator over all the log catalog messages associated with this exception.
`public `String`` | `getUserMessage`() Returns the first user catalog message associated with this exception.
`public `Iterator`` | `getUserMessages`() Returns an iterator over all the user catalog messages associated with this exception.

## Method Detail

### addLogMessage(String, String) Method

    public void addLogMessage(String namespace,
                              String messageKey)

Adds a new log catalog message to the stack of associated messages.

#### Parameters

namespace
  Log catalog message namespace.

messageKey
  Log catalog message key.

### addLogMessage(String, String, Object) Method

    public void addLogMessage(String namespace,
                              String messageKey,
                              Object argument)

Adds a new log catalog message to the stack of associated messages.

#### Parameters

namespace
  Log catalog message namespace.

messageKey
  Log catalog message key.

argument
  Message parameter substitution argument.

### addLogMessage(String, String, Object[]) Method

    public void addLogMessage(String namespace,
                              String messageKey,
                              Object[] aguments)

Adds a new log catalog message to the stack of associated messages.

#### Parameters

namespace
  Log catalog message namespace.

messageKey
  Log catalog message key.

aguments
  Message parameter substitution arguments.

### addMessage(String, String) Method

    public void addMessage(String namespace,
                           String messageKey)

Adds a new user and log catalog message to the stack of associated messages.

#### Parameters

namespace
  User and log catalog message namespace.

messageKey
  User and log catalog message key.

### addMessage(String, String, Object) Method

    public void addMessage(String namespace,
                           String messageKey,
                           Object argument)

Adds a new user catalog message to the stack of associated messages.

#### Parameters

namespace
  User and log catalog message namespace.

messageKey
  User and log catalog message key.

argument
  Message parameter substitution argument.

### addMessage(String, String, Object[]) Method

    public void addMessage(String namespace,
                           String messageKey,
                           Object[] aguments)

Adds a new user catalog message to the stack of associated messages.

#### Parameters

namespace
  User and log catalog message namespace.

messageKey
  User and log catalog message key.

aguments
  Message parameter substitution arguments.

### addUserMessage(String, String) Method

    public void addUserMessage(String namespace,
                               String messageKey)

Adds a new user catalog message to the stack of associated messages.

#### Parameters

namespace
  User catalog message namespace.

messageKey
  User catalog message key.

### addUserMessage(String, String, Object) Method

    public void addUserMessage(String namespace,
                               String messageKey,
                               Object argument)

Adds a new user catalog message to the stack of associated messages.

#### Parameters

namespace
  User catalog message namespace.

messageKey
  User catalog message key.

argument
  Message parameter substitution argument.

### addUserMessage(String, String, Object[]) Method

    public void addUserMessage(String namespace,
                               String messageKey,
                               Object[] aguments)

Adds a new user catalog message to the stack of associated messages.

#### Parameters

namespace
  User catalog message namespace.

messageKey
  User catalog message key.

aguments
  Message parameter substitution arguments.

### getEmbeddedException() Method

    public Exception getEmbeddedException()

Gets the embedded exception associated with this exception.

#### Returns

The embedded exception.

### getLogMessage() Method

    public String getLogMessage()

Returns the first log catalog message associated with this exception.

#### Returns

The first log catalog message associated with this exception.

### getLogMessages() Method

    public Iterator getLogMessages()

Returns an iterator over all the log catalog messages associated with this exception.

#### Returns

An iterator over all log catalog messages.

### getUserMessage() Method

    public String getUserMessage()

Returns the first user catalog message associated with this exception.

#### Returns

The user catalog message associated with this exception.

### getUserMessages() Method

    public Iterator getUserMessages()

Returns an iterator over all the user catalog messages associated with this exception.

#### Returns

An iterator over all user catalog messages.