/**
* Sets the value of the a session attribute using the specified name and value within
* PortletSession.APPLICATION_SCOPE
*/
public static void setSessionSharedAttribute(String name, Object value) {
PortletHelperFactory.getPortletHelperInstance().setSessionSharedAttribute(name, value);
}
/** Returns TRUE if the Window state of the current portlet is set to MAXIMIZED */
public static boolean isWindowNormal() {
return PortletHelperFactory.getPortletHelperInstance().isWindowNormal();
}
/**
* Sets the portlet mode of the portlet associated with the current JSF FacesContext to the
* specified portlet mode.
*/
public static void setPortletMode(PortletMode portletMode) {
PortletHelperFactory.getPortletHelperInstance().setPortletMode(portletMode);
}
/**
* Retrieves the name of the portlet associated with the current JSF FacesContext (as defined in
* portlet.xml's <portlet-name> tag).
*/
public static String getPortletName() {
return PortletHelperFactory.getPortletHelperInstance().getPortletName();
}
/**
* Returns short representation of the value of the portlet preference associated with the
* specified name in from the PortletPreferenceMap object associated with the current JSF
* FacesContext.
*/
public static short getPortletPreferenceAsShort(String preferenceName, short defaultValue) {
return PortletHelperFactory.getPortletHelperInstance()
.getPortletPreferenceAsShort(preferenceName, defaultValue);
}
/** A short-cut method for calling setWindowState(WindowState.NORMAL) */
public static void setWindowStateToNormal() {
PortletHelperFactory.getPortletHelperInstance().setWindowStateToNormal();
}
/**
* Retrieves the <code>javax.portlet.ActionResponse</code> object associated with the current JSF
* FacesContext.
*/
public static ActionResponse getActionResponse() {
return PortletHelperFactory.getPortletHelperInstance().getActionResponse();
}
/** Returns the user name/id of the user associated with the current JSF FacesContext */
public static String getRemoteUser() {
return PortletHelperFactory.getPortletHelperInstance().getRemoteUser();
}
/**
* Returns the value of the session attribute associated with the specified name from
* PortletSession.APPLICATION_SCOPE
*/
public static Object getSessionSharedAttribute(String name) {
return PortletHelperFactory.getPortletHelperInstance().getSessionSharedAttribute(name);
}
/**
* Retrieves the <code>javax.portlet.PortletRequest</code> object associated with the current JSF
* FacesContext.
*/
public static PortletRequest getPortletRequest() {
return PortletHelperFactory.getPortletHelperInstance().getPortletRequest();
}
/**
* Retrieves the <code>javax.portlet.PortletSession</code> object associated with the current JSF
* FacesContext.
*/
public static PortletSession getPortletSession() {
return PortletHelperFactory.getPortletHelperInstance().getPortletSession();
}
/**
* Retrieves the <code>javax.portlet.RenderResponse</code> object associated with the current JSF
* FacesContext.
*/
public static RenderResponse getPortletRenderResponse() {
return PortletHelperFactory.getPortletHelperInstance().getPortletRenderResponse();
}
/**
* Retrieves the <code>javax.portlet.PortletPreferences</code> object associated with the current
* JSF FacesContext.
*/
public static PortletPreferences getPortletPreferences() {
return PortletHelperFactory.getPortletHelperInstance().getPortletPreferences();
}
/**
* Returns short representation of the value of the portlet preference associated with the
* specified name in from the PortletPreferenceMap object associated with the current JSF
* FacesContext.
*/
public static String getPortletPreferenceAsString(String preferenceName, String defaultValue) {
return PortletHelperFactory.getPortletHelperInstance()
.getPortletPreferenceAsString(preferenceName, defaultValue);
}
/**
* Sets the window state of the portlet associated with the current JSF FacesContext to the
* specified window state.
*/
public static void setWindowState(WindowState windowState) {
PortletHelperFactory.getPortletHelperInstance().setWindowState(windowState);
}
/** Returns the window state of the portlet associated with the current JSF FacesContext */
public static WindowState getWindowState() {
return PortletHelperFactory.getPortletHelperInstance().getWindowState();
}
/** A short-cut method for calling setWindowState(WindowState.MAXIMIZED) */
public static void setWindowStateToMaximized() {
PortletHelperFactory.getPortletHelperInstance().setWindowStateToMaximized();
}
/**
* Returns TRUE if the underlying request/response is from a portlet environment. Otherwise, must
* be running in a servlet environment.
*/
public static boolean isPortletEnvironment() {
return PortletHelperFactory.getPortletHelperInstance().isPortletEnvironment();
}
/** Retrieves a render URL for the current facesContext. */
public static PortletURL createRenderURL() {
return PortletHelperFactory.getPortletHelperInstance().createRenderURL();
}
/** Returns TRUE if the current user is associated with the specified role. */
public static boolean isUserInRole(String roleName) {
return PortletHelperFactory.getPortletHelperInstance().isUserInRole(roleName);
}
/**
* Retrieves the <code>javax.portlet.PortletContext</code> object associated with the current JSF
* FacesContext.
*/
public static PortletContext getPortletContext() {
return PortletHelperFactory.getPortletHelperInstance().getPortletContext();
}
/** Returns TRUE if the Window state of the current portlet is set to MAXIMIZED */
public static boolean isWindowMaximized() {
return PortletHelperFactory.getPortletHelperInstance().isWindowMaximized();
}
/**
* Returns String representation of the value of the portlet preference associated with the
* specified name in from the <code>javax.portlet.PortletPreferences</code> object associated with
* the current JSF FacesContext.
*/
public static Object getPortletPreference(String preferenceName, Object defaultValue) {
return PortletHelperFactory.getPortletHelperInstance()
.getPortletPreference(preferenceName, defaultValue);
}
/**
* Returns boolean representation of the value of the portlet preference associated with the
* specified name in from the PortletPreferenceMap object associated with the current JSF
* FacesContext.
*/
public static boolean getPortletPreferenceAsBool(String preferenceName, boolean defaultValue) {
return PortletHelperFactory.getPortletHelperInstance()
.getPortletPreferenceAsBool(preferenceName, defaultValue);
}
