org.got5.tapestry5.jquery.services.messages.MessageProvider Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of tapestry5-jquery Show documentation

Tapestry Components Library

The newest version!

package org.got5.tapestry5.jquery.services.messages;

import org.apache.tapestry5.ComponentResources;

/**
 * Service used to get messages from parent's components or pages, and to handle name convention Tapestry 
 * system in property files (component_id-message_id).
 *
 */
public interface MessageProvider {
	
	/**
	 * Returns the message corresponding to the component id pClientId and the message key pKey. This function
	 * also needs the ComponentResources injected service instance from the page/component to work.
	 * 
	 * @param String pKey
	 * @param String pClientId
	 * @param ComponentResources pResources
	 * 
	 * @return String
	 */
	String get(String pKey, String pClientId, ComponentResources pResources);
}