org.openmrs.messagesource

Interface MutableMessageSource

All Superinterfaces:

org.springframework.context.HierarchicalMessageSource, org.springframework.context.MessageSource

All Known Subinterfaces:

MessageSourceService

All Known Implementing Classes:

CachedMessageSource, MessageSourceServiceImpl, MutableResourceBundleMessageSource

@Transactional
public interface MutableMessageSource
extends org.springframework.context.MessageSource, org.springframework.context.HierarchicalMessageSource

Extended MessageSource interface, which provides more information about the available messages and can be changed.

Method Summary

Modifier and Type	Method and Description
void	addPresentation(PresentationMessage message) Adds a presentation message to the source.
Collection<Locale>	getLocales() Gets the locales for which messages are available from this source.
PresentationMessage	getPresentation(String key, Locale forLocale) Gets the PresentationMessage for a particular locale.
Collection<PresentationMessage>	getPresentations() Gets all of the available messages, packaged as PresentationMessages.
Collection<PresentationMessage>	getPresentationsInLocale(Locale locale) Gets alll the available messages in a particular locale, packaged as PresentationMessages.
void	merge(MutableMessageSource fromSource, boolean overwrite) Merge messages from another source into this source.
void	publishProperties(Properties props, String locale, String namespace, String name, String version) Deprecated. use merge(MutableMessageSource, boolean)
void	removePresentation(PresentationMessage message) Removes a presentation message from the source.

Methods inherited from interface org.springframework.context.HierarchicalMessageSource

getParentMessageSource, setParentMessageSource

Methods inherited from interface org.springframework.context.MessageSource

getMessage, getMessage, getMessage

Method Detail

getLocales

Collection<Locale> getLocales()

Gets the locales for which messages are available from this source.

Returns:

available message locales

publishProperties

void publishProperties(Properties props,
                       String locale,
                       String namespace,
                       String name,
                       String version)

Deprecated. use merge(MutableMessageSource, boolean)

Makes a collection of properties available as messages.

Parameters:

props - key/value properties for the messages

locale - locale in which the messages are expressed

namespace - namespace within which the properties are valid ("" for generic, "module" for modules, etc)

name - unique name for the properties within the namespace

version - version of the properties

getPresentations

Collection<PresentationMessage> getPresentations()

Gets all of the available messages, packaged as PresentationMessages.

Returns:

collection of presentation messages

getPresentationsInLocale

Collection<PresentationMessage> getPresentationsInLocale(Locale locale)

Gets alll the available messages in a particular locale, packaged as PresentationMessages.

Parameters:

locale - locale for which to get the messages

Returns:

collection of PresentationMessages in the locale

addPresentation

void addPresentation(PresentationMessage message)

Adds a presentation message to the source. This operation should overwrite any existing message which conflicts (has the same code and locale).

Parameters:

message - message to add to the source

getPresentation

PresentationMessage getPresentation(String key,
                                    Locale forLocale)

Gets the PresentationMessage for a particular locale.

Parameters:

key - textual key for the message

forLocale - locale for which to get the message

Returns:

corresponding PresentationMessage, or null if not available

removePresentation

void removePresentation(PresentationMessage message)

Removes a presentation message from the source.

Parameters:

message - the message to remove

merge

void merge(MutableMessageSource fromSource,
           boolean overwrite)

Merge messages from another source into this source.

Parameters:

fromSource - message source from which messages should be merge

overwrite - whether to overwrite existing messages