Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-06


oracle.adf.view.rich.context
Class UriManager

java.lang.Object
  extended by oracle.adf.view.rich.context.UriManager

Direct Known Subclasses:
UriManagerBase

public abstract class UriManager
extends java.lang.Object

Provides abstraction for dealing with the browser's URI


Constructor Summary
UriManager()
           

 

Method Summary
 boolean addQueryParameters(javax.faces.context.FacesContext context, java.util.Map<java.lang.String,java.lang.String> params)
          Deprecated. 
abstract  boolean addQueryParameters(javax.faces.context.FacesContext context, java.util.Map<java.lang.String,java.lang.String> params, boolean redirectIfNeeded)
          Adds query parameters to the current view's URL
abstract  boolean makeBookmarkable(javax.faces.context.FacesContext context, java.lang.String viewId, java.util.Map<java.lang.String,java.lang.String> params)
          Navigates to a bookmarkable URL.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

UriManager

public UriManager()

Method Detail

addQueryParameters

@Deprecated
public final boolean addQueryParameters(javax.faces.context.FacesContext context,
                                                   java.util.Map<java.lang.String,java.lang.String> params)
                                 throws java.io.IOException
Deprecated. 
Adds query parameters to the current view's URL
Parameters:
context - Faces context
params - a map with name-value pairs, where keys represent parameter names. Existing query parameters on the URI will be preserved unless they are overridden with new values from the map
Returns:
true if adding parameters resulted in issuing a client-side redirect, false otherwise. If a redirect was performed, the caller may assume that FacesContext.responseComplete() has been called
Throws:
java.io.IOException

addQueryParameters

public abstract boolean addQueryParameters(javax.faces.context.FacesContext context,
                                           java.util.Map<java.lang.String,java.lang.String> params,
                                           boolean redirectIfNeeded)
                                    throws java.io.IOException
Adds query parameters to the current view's URL
Parameters:
context - Faces context
params - a map with name-value pairs, where keys represent parameter names. Existing query parameters on the URI will be preserved unless they are overridden with new values from the map
redirectIfNeeded - true if a client-side redirect should be issued when the new query parameters cannot be added to the URI by other means, false otherwise. The consumer fo this interface will normally pass true for the GET requests. For the POST requests, the new query parameters will be reflected in the action URL
Returns:
true if adding parameters resulted in issuing a client-side redirect, false otherwise. If a redirect was performed, the caller may assume that FacesContext.responseComplete() has been called
Throws:
java.io.IOException

makeBookmarkable

public abstract boolean makeBookmarkable(javax.faces.context.FacesContext context,
                                         java.lang.String viewId,
                                         java.util.Map<java.lang.String,java.lang.String> params)
                                  throws java.io.IOException
Navigates to a bookmarkable URL.
Parameters:
context - Faces context
viewId - - View Id for the navigation target
params - a map with name-value pairs, where keys represent parameter names. Existing query parameters on the URI will be preserved when no navigation is known to occurr
Returns:
true if making this URI bookmarkable resulted in issuing a client-side redirect, false otherwise If a redirect was performed, the caller may assume that FacesContext.responseComplete() has been called Otherwise, the caller is responsible for setting a new Vew root on FacesContext
Throws:
java.io.IOException

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-06


Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.