public interface SiteContext
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
Modifier and Type | Method and Description |
---|---|
java.util.Collection<Site> |
getAdditionalSites()
get the additional sites - in case an app has use for
multiple sites for a given site context
|
java.lang.Object |
getAttribute(java.lang.String pName)
get an attribute for this SiteContext.
|
java.util.Set<java.lang.String> |
getAttributeNames()
get a list of names for all the attributes
currently stored in this SiteContext
|
Site |
getSite()
get Site - the site associated with this context
|
SiteContextManager |
getSiteContextManager()
get SiteContextManager, the global component used to manage SiteContexts
|
SiteSession |
getSiteSession()
get SiteSession - the SiteSession for this context
|
boolean |
isEmptySiteContext()
this attribute will determine if the
site context is actually just an empty
site context.
|
void |
setAdditionalSites(java.util.Collection<Site> pAdditionalSites)
some applications may find use in being able to
specify multiple sites for a given site context.
|
void |
setAttribute(java.lang.String pName,
java.lang.Object pValue)
set an attribute for this SiteContext.
|
void |
setSite(Site pSite)
set Site - the site associated with this context
|
void |
setSiteContextManager(SiteContextManager pSiteContextManager)
set SiteContextManager, the global component used to manage SiteContexts
|
void |
setSiteSession(SiteSession pSiteSession)
set SiteSession - the SiteSession for this context
|
static final java.lang.String CLASS_VERSION
void setSiteSession(SiteSession pSiteSession)
pSiteSession
- the SiteSessionSiteSession getSiteSession()
void setSite(Site pSite)
pSite
- the SiteSite getSite()
void setAdditionalSites(java.util.Collection<Site> pAdditionalSites)
pAdditionalSites
- a set holding the additional Sitesjava.util.Collection<Site> getAdditionalSites()
void setSiteContextManager(SiteContextManager pSiteContextManager)
pSiteContextManager
- the SiteContextManagerSiteContextManager getSiteContextManager()
java.util.Set<java.lang.String> getAttributeNames()
void setAttribute(java.lang.String pName, java.lang.Object pValue)
pName
- the attribute namepValue
- the attribute string valuejava.lang.Object getAttribute(java.lang.String pName)
pName
- the attribute nameboolean isEmptySiteContext()