Package org.sakaiproject.portal.api
Interface SiteView
-
public interface SiteViewThis interface represents a view of a the Site cloud from a particuar view point.- Author:
- ieb
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classSiteView.View
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ObjectgetRenderContextObject()gets the representation for the render contextbooleanisEmpty()is the SiteView empty.voidsetDoPages(boolean doPages)voidsetExpandSite(boolean expandSite)voidsetIncludeSummary(boolean includeSummary)voidsetPrefix(String prefix)The prefix for creating site URLs.voidsetResetTools(boolean resetTools)voidsetToolContextPath(String toolContextPath)required
-
-
-
Method Detail
-
setPrefix
void setPrefix(String prefix)
The prefix for creating site URLs. Eg. If "site" then URLs will come out like /portal/site/... required- Parameters:
prefix- The prefix to use.
-
setToolContextPath
void setToolContextPath(String toolContextPath)
required- Parameters:
toolContextPath-
-
getRenderContextObject
Object getRenderContextObject()
gets the representation for the render context- Returns:
-
isEmpty
boolean isEmpty()
is the SiteView empty.- Returns:
-
setResetTools
void setResetTools(boolean resetTools)
- Parameters:
resetTools-
-
setIncludeSummary
void setIncludeSummary(boolean includeSummary)
- Parameters:
includeSummary-
-
setDoPages
void setDoPages(boolean doPages)
- Parameters:
doPages-
-
setExpandSite
void setExpandSite(boolean expandSite)
- Parameters:
expandSite-
-
-