org.apache.beehive.netui.core.urls
Interface TemplatedURLFormatter

All Known Implementing Classes:
DefaultTemplatedURLFormatter

public interface TemplatedURLFormatter

Offers a method for formatting URLs based on templates from a URL template config file. A template is chosen from a reference group based on the template type (key).


Method Summary
 String getTemplatedURL(ServletRequest request, MutableURI uri, String key, boolean forXML)
          Format the given URL using a URL template, if defined in a URL template config file.
 

Method Detail

getTemplatedURL

String getTemplatedURL(ServletRequest request,
                       MutableURI uri,
                       String key,
                       boolean forXML)
Format the given URL using a URL template, if defined in a URL template config file.

Parameters:
request - the current ServletRequest.
uri - the MutableURI to be formatted into a String.
key - key for the URL template type to use for formatting the URI
forXML - flag indicating that the query of the uri should be written using the "&" entity for XML, rather than the character, '&'.