org.sakaiproject.portal.util

Class ToolUtils

java.lang.Object

org.sakaiproject.portal.util.ToolUtils

public class ToolUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	PORTAL_INLINE_EXPERIMENTAL

Constructor Summary

Constructors

Constructor and Description
ToolUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static SitePage	getPageForTool(Site site, String toolId) Look through the pages in a site and find the page that corresponds to a tool.
static String	getPageUrl(HttpServletRequest req, Site site, SitePage page) Captures the rules for getting the URL of a page suitable for a GET request
static String	getPageUrl(HttpServletRequest req, Site site, SitePage page, String portalPrefix) Captures the rules for getting the URL of a page suitable for a GET request
static String	getPageUrl(HttpServletRequest req, Site site, SitePage page, String portalPrefix, boolean reset, String effectiveSiteId, String pageAlias) Captures the rules for getting the URL of a page suitable for a GET request
static String	getPageUrlForTool(HttpServletRequest req, Site site, ToolConfiguration pageTool) Look through the pages in a site and get the page URL for a tool.
static String	getToolPopupUrl(ToolConfiguration pageTool) Captures the rules for the various tools and when they want a popup
static boolean	isInlineRequest(HttpServletRequest req) Determine if this is an inline request.
static boolean	isPortletPlacement(Placement placement)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PORTAL_INLINE_EXPERIMENTAL

public static final String PORTAL_INLINE_EXPERIMENTAL

See Also:

Constant Field Values

Constructor Detail

ToolUtils

public ToolUtils()

Method Detail

isInlineRequest

public static boolean isInlineRequest(HttpServletRequest req)

Determine if this is an inline request.

Parameters:

req - The request object.

Returns:

True if this is a request where a tool will be inlined.

getPageUrl

public static String getPageUrl(HttpServletRequest req,
                Site site,
                SitePage page)

Captures the rules for getting the URL of a page suitable for a GET request

Parameters:

req - The request object.

site - The site that contains the page

page - The page URL. If this has a logged in session, we use it to set the default prefix if available. This will use the default prefix if called without a session (i.e. through /direct).

getPageUrl

public static String getPageUrl(HttpServletRequest req,
                Site site,
                SitePage page,
                String portalPrefix)

Captures the rules for getting the URL of a page suitable for a GET request

Parameters:

req - The request object.

site - The site that contains the page

page - The page

portalPrefix - The controlling portal. Typically "portal" or "pda". No slashes should be included

getPageUrl

public static String getPageUrl(HttpServletRequest req,
                Site site,
                SitePage page,
                String portalPrefix,
                boolean reset,
                String effectiveSiteId,
                String pageAlias)

Captures the rules for getting the URL of a page suitable for a GET request

Parameters:

req - The request object.

site - The site that contains the page

page - The page

portalPrefix - The controlling portal. Typically "portal" or "pda". No slashes should be included

reset - Should we reset the tool as part of this GET reference (typically true)

effectiveSiteId - The effective site ID

pageAlias - The alias for the page (typically null)

Returns:

The url for the page.

getToolPopupUrl

public static String getToolPopupUrl(ToolConfiguration pageTool)

Captures the rules for the various tools and when they want a popup

Parameters:

pageTool - The tools configuration object.

Returns:

The url to be uded in the popup of null of there is no tool-requested popup.

getPageForTool

public static SitePage getPageForTool(Site site,
                      String toolId)

Look through the pages in a site and find the page that corresponds to a tool.

Parameters:

site - The site

toolId - The placement / tool ID

Returns:

The page if found otherwise null.

getPageUrlForTool

public static String getPageUrlForTool(HttpServletRequest req,
                       Site site,
                       ToolConfiguration pageTool)

Look through the pages in a site and get the page URL for a tool.

Parameters:

req - The request object.

site - The site

pageTool - The placement / tool configuration

Returns:

The page if found otherwise null.

isPortletPlacement

public static boolean isPortletPlacement(Placement placement)