= TranslatableException
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR  CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Exceptions that provide translations should implement this interface.

The _org.apache.isis.applib.services.exceprecog.ExceptionRecognizer_ will automatically detect and use the translation. In addition, the integration testing support provides a rule ( `ExceptionRecognizerTranslations` ) that will exercise any thrown exceptions, ensuring tha the message is captured in the `translations.po` file so that it can be translated.

== API

[source,java]
.TranslatableException.java
----
interface TranslatableException {
  TranslatableString getTranslatableMessage()     // <.>
}
----

<.> xref:#getTranslatableMessage_[getTranslatableMessage()]
+
--
In the spirit of _Exception#getLocalizedMessage()_ , but using xref:refguide:applib:index/services/i18n/TranslatableString.adoc[TranslatableString] instead.
--

== Members

[#getTranslatableMessage_]
=== getTranslatableMessage()

In the spirit of _Exception#getLocalizedMessage()_ , but using xref:refguide:applib:index/services/i18n/TranslatableString.adoc[TranslatableString] instead.

If returns `null` , then _Exception#getMessage()_ will be used as a fallback. This design allows the Isis-provided xref:refguide:applib:index/exceptions/RecoverableException.adoc[RecoverableException] and xref:refguide:applib:index/exceptions/UnrecoverableException.adoc[UnrecoverableException] to provide constructors that accept a xref:refguide:applib:index/services/i18n/TranslatableString.adoc[TranslatableString] , but can be left as null for any existing code.
