org.kuali.rice.krad.messages

Interface MessageProvider

All Known Implementing Classes:

DatabaseMessageProvider, ResourceMessageProvider

public interface MessageProvider

API for message providers

A message provider fronts an external repository and provides messages from that repository to the application. The provider must support the following message retrieval methods and be registered with the MessageService implementation

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Methods

Modifier and Type	Method and Description
Collection<Message>	getAllMessagesForComponent(String namespace, String component, String locale) Gets all message objects for the given namespace, component, and locale
Message	getMessage(String namespace, String component, String key, String locale) Gets the Message object that has the given namespace, component, key, and locale

Method Detail

getMessage

Message getMessage(String namespace,
                 String component,
                 String key,
                 String locale)

Gets the Message object that has the given namespace, component, key, and locale

Parameters:

namespace - namespace code the message belongs to

component - component code the namespace is associated with

key - key that identifies the message within the namespace and component

locale - locale code for the message to return

Returns:

Message matching message object, or null if a message was not found

getAllMessagesForComponent

Collection<Message> getAllMessagesForComponent(String namespace,
                                             String component,
                                             String locale)

Gets all message objects for the given namespace, component, and locale

Parameters:

namespace - namespace code the message belongs to

component - component code the namespace is associated with

locale - locale code for the message to return

Returns:

Collection collection of messages that match, or empty collection if no messages are found