org.sakaiproject.portal.api
Interface PortalSiteHelper

public interface PortalSiteHelper

Author:

ieb

Method Summary

boolean	allowTool(org.sakaiproject.site.api.Site site, org.sakaiproject.tool.api.Placement placement)
boolean	doGatewaySiteList()
String	getGatewaySiteId()
org.sakaiproject.site.api.Site	getMyWorkspace(org.sakaiproject.tool.api.Session session)
SiteView	getSitesView(SiteView.View view, javax.servlet.http.HttpServletRequest req, org.sakaiproject.tool.api.Session session, String siteId) Generates a SiteView object from the current request and location
org.sakaiproject.site.api.Site	getSiteVisit(String siteId)
String	lookupPageToAlias(String siteId, org.sakaiproject.site.api.SitePage page) Find an alias for a page.
org.sakaiproject.site.api.SitePage	lookupSitePage(String pageId, org.sakaiproject.site.api.Site site)
Map	pageListToMap(javax.servlet.http.HttpServletRequest req, boolean loggedIn, org.sakaiproject.site.api.Site site, org.sakaiproject.site.api.SitePage page, String toolContextPath, String portalPrefix, boolean doPages, boolean resetTools, boolean includeSummary) Iterate through the pages in a site and return information in a Map.

Method Detail

getSiteVisit

org.sakaiproject.site.api.Site getSiteVisit(String siteId)
                                            throws org.sakaiproject.exception.IdUnusedException,
                                                   org.sakaiproject.exception.PermissionException

Parameters:

siteId -

Returns:

Throws:

org.sakaiproject.exception.IdUnusedException

org.sakaiproject.exception.PermissionException

getMyWorkspace

org.sakaiproject.site.api.Site getMyWorkspace(org.sakaiproject.tool.api.Session session)

Parameters:

session -

Returns:

allowTool

boolean allowTool(org.sakaiproject.site.api.Site site,
                  org.sakaiproject.tool.api.Placement placement)

Parameters:

site -

placement -

Returns:

doGatewaySiteList

boolean doGatewaySiteList()

Returns:

getGatewaySiteId

String getGatewaySiteId()

Returns:

lookupSitePage

org.sakaiproject.site.api.SitePage lookupSitePage(String pageId,
                                                  org.sakaiproject.site.api.Site site)

Parameters:

portal -

pageId -

site -

Returns:

pageListToMap

Map pageListToMap(javax.servlet.http.HttpServletRequest req,
                  boolean loggedIn,
                  org.sakaiproject.site.api.Site site,
                  org.sakaiproject.site.api.SitePage page,
                  String toolContextPath,
                  String portalPrefix,
                  boolean doPages,
                  boolean resetTools,
                  boolean includeSummary)

Iterate through the pages in a site and return information in a Map.

Parameters:

req -

loggedIn -

site -

page -

toolContextPath -

portalPrefix -

doPages -

resetTools -

includeSummary -

getSitesView

SiteView getSitesView(SiteView.View view,
                      javax.servlet.http.HttpServletRequest req,
                      org.sakaiproject.tool.api.Session session,
                      String siteId)

Generates a SiteView object from the current request and location

Parameters:

view -

req -

session -

siteId -

Returns:

lookupPageToAlias

String lookupPageToAlias(String siteId,
                         org.sakaiproject.site.api.SitePage page)

Find an alias for a page.

Parameters:

siteId -

page -

Returns:

null if no alias was found, otherwise the short alias for the page.