oracle.cabo.servlet.url
Interface PageEncoder

All Superinterfaces:

URLEncoder

All Known Implementing Classes:

BasePageEncoder

public interface PageEncoder

extends URLEncoder

Interface for encoding pages and page events into URLs.

Generally, developers will implement this interface and PageDecoder on exactly the same class, since implementations of these are necessarily closely coupled. The interfaces are separated, though. This separation allows transitions from one encoding scheme to another to be handled properly.

PageEncoder instances are always tied to a specific servlet request, and should not be cached by users.

Method Summary

java.lang.String	encodeEventURL(java.lang.String eventName, java.util.Dictionary parameters) Encodes an event into a full URL.
java.lang.String	encodePage(Page page) Encodes a page and its properties.
java.lang.String	encodePageAndEvent(boolean includeBase, Page page, java.lang.String eventName, java.util.Dictionary parameters) Encodes a page and event parameters into an URL
java.lang.String	encodePageAndEvent(java.lang.String baseURL, Page page, java.lang.String eventName, java.util.Dictionary parameters) Encodes a page and event parameters into an URL
java.lang.String	encodePageURL(Page page) Encodes a page into a full URL.
java.lang.String	encodeResponsePage() Encodes the response page.
void	setResponsePage(Page page) Sets the response page; this page will be used to properly implement getDefaultURL().

Methods inherited from interface oracle.cabo.share.url.URLEncoder

encodeParameter, encodeURL, getDefaultURL

Method Detail

encodePageURL

public java.lang.String encodePageURL(Page page)

Encodes a page into a full URL. Equivalent to encodePageAndEvent(true, page, null, null).

Parameters:

page - the Page object to encode

encodeEventURL

public java.lang.String encodeEventURL(java.lang.String eventName,
                                       java.util.Dictionary parameters)

Encodes an event into a full URL. The URL will be delivered back to the requesting page (perhaps via a controller servlet).

encodePageAndEvent

public java.lang.String encodePageAndEvent(boolean includeBase,
                                           Page page,
                                           java.lang.String eventName,
                                           java.util.Dictionary parameters)

Encodes a page and event parameters into an URL

Parameters:

includeBase - if true, prepend the servlet's base URL

page - the Page object to encode

eventName - the name of the event

parameters - a dictionary of keys and values

encodePageAndEvent

public java.lang.String encodePageAndEvent(java.lang.String baseURL,
                                           Page page,
                                           java.lang.String eventName,
                                           java.util.Dictionary parameters)

Encodes a page and event parameters into an URL

Parameters:

baseURL - the base URL to use; if null, don't prepend anything

page - the Page object to encode

eventName - the name of the event

parameters - a dictionary of keys and values

encodePage

public java.lang.String encodePage(Page page)

Encodes a page and its properties. This method is most useful for JSP coders to stash the page in a form element.

Parameters:

page - the Page object to encode

encodeResponsePage

public java.lang.String encodeResponsePage()

Encodes the response page. This method is most useful for JSP coders to stash the page in a form element.

Parameters:

page - the Page object to encode

setResponsePage

public void setResponsePage(Page page)

Sets the response page; this page will be used to properly implement getDefaultURL().

See Also:

URLEncoder.getDefaultURL()