public interface PortalSiteHelper
| Modifier and Type | Method and Description |
|---|---|
boolean |
allowTool(org.sakaiproject.site.api.Site site,
org.sakaiproject.tool.api.Placement placement) |
Map |
convertSiteToMap(HttpServletRequest req,
org.sakaiproject.site.api.Site s,
String prefix,
String currentSiteId,
String myWorkspaceSiteId,
boolean includeSummary,
boolean expandSite,
boolean resetTools,
boolean doPages,
String toolContextPath,
boolean loggedIn) |
boolean |
doGatewaySiteList() |
String |
getGatewaySiteId() |
org.sakaiproject.site.api.Site |
getMyWorkspace(org.sakaiproject.tool.api.Session session) |
org.sakaiproject.site.api.Site |
getSite(String siteId)
This looks up a site but also checks for any aliases.
|
SiteView |
getSitesView(SiteView.View view,
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) |
boolean |
isJoinable(String siteId,
String userId)
Check if the site is joinable by the supplied user and the user isn't currently a member
of the site.
|
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(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.
|
org.sakaiproject.site.api.Site getSiteVisit(String siteId) throws org.sakaiproject.exception.IdUnusedException, org.sakaiproject.exception.PermissionException
siteId - org.sakaiproject.exception.IdUnusedExceptionorg.sakaiproject.exception.PermissionExceptionorg.sakaiproject.site.api.Site getMyWorkspace(org.sakaiproject.tool.api.Session session)
session - boolean allowTool(org.sakaiproject.site.api.Site site,
org.sakaiproject.tool.api.Placement placement)
site - placement - boolean doGatewaySiteList()
String getGatewaySiteId()
org.sakaiproject.site.api.SitePage lookupSitePage(String pageId, org.sakaiproject.site.api.Site site)
portal - pageId - site - Map pageListToMap(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)
req - loggedIn - site - page - toolContextPath - portalPrefix - doPages - resetTools - includeSummary - Map convertSiteToMap(HttpServletRequest req, org.sakaiproject.site.api.Site s, String prefix, String currentSiteId, String myWorkspaceSiteId, boolean includeSummary, boolean expandSite, boolean resetTools, boolean doPages, String toolContextPath, boolean loggedIn)
SiteView getSitesView(SiteView.View view, HttpServletRequest req, org.sakaiproject.tool.api.Session session, String siteId)
view - req - session - siteId - String lookupPageToAlias(String siteId, org.sakaiproject.site.api.SitePage page)
siteId - page - null if no alias was found, otherwise the short alias for the page.boolean isJoinable(String siteId, String userId)
siteId - The ID of the site.userId - The ID of the user.true if the user can join the site.org.sakaiproject.site.api.Site getSite(String siteId) throws org.sakaiproject.exception.IdUnusedException
siteId - The siteId/alias to lookuporg.sakaiproject.exception.IdUnusedException - If the siteId doesn't exist and there isn't an alias for this.Copyright © 2003-2015 Sakai Project. All Rights Reserved.