|
Oracle® Fusion Middleware Site Studio for External Applications Java API Reference 11g Release 1 (11.1.1) E17273-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.stellent.wcm.client.model.SiteContext
public class SiteContext
Represents the context during the evaluation of the site. Typically, a SiteContext is created at the beginning of a rendering request (i.e. in a servlet) and then used to keep track of the current state of the site.
Constructor Summary | |
---|---|
SiteContext() Create a default site context. |
Method Summary | |
---|---|
void |
clearContext() Reset the context object |
FilePath |
getFilePath() |
oracle.stellent.ridc.IdcContext |
getIdcContext() |
SiteRequest.Mode |
getMode() |
PageTemplate |
getPageTemplate() |
java.util.Map<java.lang.String,java.lang.String> |
getParameters() |
java.lang.String |
getPath() |
Placeholder |
getPlaceholder() |
java.lang.String |
getPreviewID() |
Project |
getProject() |
SectionNode |
getSection() |
java.lang.String |
getSiteID() Retrieve the site ID for this context |
java.util.Map<UrlRequest.UrlRoot,java.lang.String> |
getUrlPatterns() The format strings to use for the URL types. |
boolean |
isContributorMode() |
boolean |
isDevelopmentMode() |
boolean |
isErrorMode() |
boolean |
isPathFromUrl() Set to true if the path was initialized from the browser url |
boolean |
isPreview() |
boolean |
isScriptIncluded() |
void |
populateSiteRequest(SiteRequest siteRequest) Populate the site request based on the information in this context object |
void |
setContributorMode(boolean contributorMode) Set the contributor mode with a simple boolean |
void |
setDevelopmentMode(boolean developmentMode) |
void |
setIdcContext(oracle.stellent.ridc.IdcContext idcContext) |
void |
setMode(SiteRequest.Mode mode) Set the mode |
void |
setPageTemplate(PageTemplate pageTemplate) Set the page template |
void |
setParameters(java.util.Map<java.lang.String,java.lang.String> parameters) Set the url parameters |
void |
setPath(java.lang.String path) Set the path portion of the url |
void |
setPathFromUrl(boolean pathFromUrl) Set the initialized from url flag |
void |
setPlaceholder(Placeholder placeholder) Set the active placeholder object |
void |
setPreview(boolean preview) |
void |
setPreviewID(java.lang.String previewID) |
void |
setProject(Project project) Set the project associated with the site ID |
void |
setScriptIncluded(boolean scriptIncluded) Set the scriptIncluded flag |
void |
setSection(SectionNode section) Set the active section |
void |
setSiteID(java.lang.String siteID) Set the site identifier |
void |
setUrl(java.lang.String url) Set the URL; will individually set the path and parameters objects |
void |
setUrlPatterns(java.util.Map<UrlRequest.UrlRoot,java.lang.String> urlPatterns) Set the url patterns to use for this site context |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SiteContext()
Method Detail |
---|
public void clearContext()
public java.util.Map<UrlRequest.UrlRoot,java.lang.String> getUrlPatterns()
public void setUrlPatterns(java.util.Map<UrlRequest.UrlRoot,java.lang.String> urlPatterns)
urlPatterns
- a mapping of url root to patternpublic void setSiteID(java.lang.String siteID)
siteID
- the site IDpublic java.lang.String getSiteID()
public Project getProject()
public void setProject(Project project)
project
- the projectpublic SectionNode getSection()
public void setSection(SectionNode section)
section
- the sectionpublic boolean isPathFromUrl()
public void setPathFromUrl(boolean pathFromUrl)
pathFromUrl
- true to set the flag indicating the context was initialized from the urlpublic void setUrl(java.lang.String url)
url
- the url with optional urlencoded parameterspublic java.lang.String getPath()
public void setPath(java.lang.String path)
path
- the pathpublic java.util.Map<java.lang.String,java.lang.String> getParameters()
public void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
parameters
- the parameterspublic FilePath getFilePath()
public PageTemplate getPageTemplate()
public void setPageTemplate(PageTemplate pageTemplate)
pageTemplate
- the current page templatepublic Placeholder getPlaceholder()
public void setPlaceholder(Placeholder placeholder)
placeholder
- the placeholderpublic boolean isScriptIncluded()
public void setScriptIncluded(boolean scriptIncluded)
scriptIncluded
- true to indicate the script code has been includedpublic void setMode(SiteRequest.Mode mode)
mode
- the mode for this contextpublic SiteRequest.Mode getMode()
public boolean isContributorMode()
public void setContributorMode(boolean contributorMode)
contributorMode
- true for contributor mode, false for consumption modepublic boolean isErrorMode()
public boolean isDevelopmentMode()
public void setDevelopmentMode(boolean developmentMode)
public boolean isPreview()
public void setPreview(boolean preview)
public java.lang.String getPreviewID()
public void setPreviewID(java.lang.String previewID)
public oracle.stellent.ridc.IdcContext getIdcContext()
public void setIdcContext(oracle.stellent.ridc.IdcContext idcContext)
public void populateSiteRequest(SiteRequest siteRequest)
siteRequest
- the site request to populate
|
Oracle® Fusion Middleware Site Studio for External Applications Java API Reference 11g Release 1 (11.1.1) E17273-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |