com.liferay.faces.bridge.context
Interface FacesView

All Known Implementing Classes:

FacesViewImpl

public interface FacesView

This interface represents a JSF View from the perspective of how it is mapped to the FacesServlet.

Author:

Neil Griffin

Method Summary

String	getExtension() Determines the extension (such as *.faces) used by the extension-mapped servlet-mapping.
String	getQueryString() Returns the query-string which may contain navigation parameters such as Bridge.PORTLET_MODE_PARAMETER, Bridge.NONFACES_TARGET_PATH_PARAMETER, Bridge.PORTLET_SECURE_PARAMETER, Bridge.PORTLET_WINDOWSTATE_PARAMETER, Bridge.FACES_VIEW_ID_PARAMETER, or Bridge.FACES_VIEW_PATH_PARAMETER.
String	getServletPath() Determines the servlet-path (such as /faces/views) used by the path-mapped servlet-mapping.
String	getViewId() Returns the viewId associated with this view.
boolean	isExtensionMapped() Flag indicating whether or not the view is mapped to the FacesServlet via extension-mapping (such as *.faces) or some other extension.
boolean	isPathMapped() Flag indicating whether or not the view is mapped to the FacesServlet via path-mapping (such as /faces/views/*) or some other extension.

Method Detail

isExtensionMapped

boolean isExtensionMapped()

Flag indicating whether or not the view is mapped to the FacesServlet via extension-mapping (such as *.faces) or some other extension.

Returns:

true if extension-mapped, otherwise false.

isPathMapped

boolean isPathMapped()

Flag indicating whether or not the view is mapped to the FacesServlet via path-mapping (such as /faces/views/*) or some other extension.

Returns:

true if extension-mapped, otherwise false.

getExtension

String getExtension()

Determines the extension (such as *.faces) used by the extension-mapped servlet-mapping.

Returns:

If the view is extension-mapped, returns the extension. Otherwise, returns null.

getQueryString

String getQueryString()

Returns the query-string which may contain navigation parameters such as Bridge.PORTLET_MODE_PARAMETER, Bridge.NONFACES_TARGET_PATH_PARAMETER, Bridge.PORTLET_SECURE_PARAMETER, Bridge.PORTLET_WINDOWSTATE_PARAMETER, Bridge.FACES_VIEW_ID_PARAMETER, or Bridge.FACES_VIEW_PATH_PARAMETER. Note that "navigation" does not refer to JSF navigation-rules, but rather changes in PortletMode, WindowState, etc. It could also contain user-define name=value parameters specified in a Bridge.VIEW_ID request attribute.

getServletPath

String getServletPath()

Determines the servlet-path (such as /faces/views) used by the path-mapped servlet-mapping.

Returns:

If the view is path-mapped, returns the path. Otherwise, returns null.

getViewId

String getViewId()

Returns the viewId associated with this view.