com.ocs.dynamo.service

Interface MessageService

public interface MessageService

A service for convenient access to message bundles - catches any exceptions related to missing messages and returns either NULL or a warning when no message can be found

Author:

bas.rutten

Method Summary

Modifier and Type	Method and Description
String	getAttributeMessage(String reference, AttributeModel attributeModel, String propertyName, Locale locale) Retrieves a message that is used to override an attribute model setting
String	getEntityMessage(String reference, String propertyName, Locale locale) Retrieves a message that is used to override an entity model setting
<E extends Enum<?>> String	getEnumMessage(Class<E> enumClass, E value, Locale locale) Retrieves a message that is used as the human-readable definition of an enum
String	getMessage(String key, Locale locale) Retrieves a simple message - returns a warning if no such message can be found
String	getMessage(String key, Locale locale, Object... args) Retrieves a simple parameterized message - returns a warning if no such message can be found
String	getMessageNoDefault(String key, Locale locale) Retrieves a message - does NOT fall back to a default version if the message is not found.
String	getMessageNoDefault(String key, Locale locale, Object... args) Retrieves a message - does NOT fall back to a default version if the message is not found.

Method Detail

getAttributeMessage

String getAttributeMessage(String reference,
                           AttributeModel attributeModel,
                           String propertyName,
                           Locale locale)

Retrieves a message that is used to override an attribute model setting

Parameters:

reference - the entity model

attributeModel - the attribute model

propertyName - the name of the property

locale - the locale

Returns:

getEntityMessage

String getEntityMessage(String reference,
                        String propertyName,
                        Locale locale)

Retrieves a message that is used to override an entity model setting

Parameters:

reference - the entity class

propertyName - the name of the property

Returns:

getEnumMessage

<E extends Enum<?>> String getEnumMessage(Class<E> enumClass,
                                          E value,
                                          Locale locale)

Retrieves a message that is used as the human-readable definition of an enum

Parameters:

enumClass - the class of the enum

value - the enum value

Returns:

getMessage

String getMessage(String key,
                  Locale locale)

Retrieves a simple message - returns a warning if no such message can be found

Parameters:

key - the key of the message

Returns:

getMessage

String getMessage(String key,
                  Locale locale,
                  Object... args)

Retrieves a simple parameterized message - returns a warning if no such message can be found

Parameters:

key - the key of the message

args - the arguments. These are referred to using {0}, {1} etc

Returns:

getMessageNoDefault

String getMessageNoDefault(String key,
                           Locale locale)

Retrieves a message - does NOT fall back to a default version if the message is not found.

Parameters:

key - the key of the message

Returns:

the message specified by the key, or null if no such message can be found

getMessageNoDefault

String getMessageNoDefault(String key,
                           Locale locale,
                           Object... args)

Retrieves a message - does NOT fall back to a default version if the message is not found.

Parameters:

key - the key of the message

locale - the desired locale

args - the message parameters

Returns: