@Service(requiredProperties={"siteGroupManager","storeSitePropertiesManager"})
public class RecommendationAlternativeSiteIdsDroplet
extends atg.servlet.DynamoServlet
siteId
is not provided the current site ID
will be used.true
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
static atg.nucleus.naming.ParameterName |
EXCLUDE_INPUT_SITE
ParameterName for excludeInputSite
|
static atg.nucleus.naming.ParameterName |
INCLUDE_ACTIVE_SITES
ParameterName for includeActiveSites
|
static atg.nucleus.naming.ParameterName |
INPUT_SITE_CHANNEL_ONLY
ParameterName for inputSiteChannelOnly
|
protected boolean |
mExcludeInputSite
ExcludeInputSite
|
protected boolean |
mIncludeActiveSites
IncludeActiveSites
|
protected boolean |
mInputSiteChannelOnly
InputSiteChannelOnly
|
protected java.lang.String |
mShareableTypeId
ShareableTypeId
|
protected atg.multisite.SiteGroupManager |
mSiteGroupManager
SiteGroupManager
|
static atg.nucleus.naming.ParameterName |
OUTPUT
ParameterName for output
|
static atg.nucleus.naming.ParameterName |
SHAREABLE_TYPE_ID
ParameterName for shareableTypeId
|
static atg.nucleus.naming.ParameterName |
SITE_ID
ParameterName for siteId
|
static java.lang.String |
SITES_IDS_PROP_NAME
Parameter name for site
|
Constructor and Description |
---|
RecommendationAlternativeSiteIdsDroplet() |
Modifier and Type | Method and Description |
---|---|
protected void |
addSiteToList(atg.repository.RepositoryItem pSite,
java.util.List<java.lang.String> pSitesList,
java.lang.String pInputSiteId,
boolean pExcludeInputSite,
java.lang.String pInputSiteChannel,
boolean pInputSiteChannelOnly)
Adds site's ID to the list of sites.
|
java.lang.String |
getShareableTypeId() |
atg.multisite.SiteGroupManager |
getSiteGroupManager()
Returns the SiteGroupManager.
|
StoreSitePropertiesManager |
getStoreSitePropertiesManager()
Gets the StoreSitePropertiesManager bean which is used to manage store properties.
|
boolean |
isExcludeInputSite() |
boolean |
isIncludeActiveSites()
Returns the includeActiveSites parameter, determining whether only active
sites should be retrieved
|
boolean |
isInputSiteChannelOnly()
Returns the InputSiteChannelOnly property, determining whether only sites with the same
channel as the input site should be included.
|
void |
service(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Services the output oparam if a the list of sites can be determined.
|
void |
setExcludeInputSite(boolean pExcludeInputSite) |
void |
setIncludeActiveSites(boolean pIncludeActiveSites)
Sets the includeActiveSites property, determining whether only active
site should be retrieved
|
void |
setInputSiteChannelOnly(boolean pInputSiteChannelOnly)
Sets the InputSiteChannelOnly property, determining whether only sites with the same
channel as the input site should be included.
|
void |
setShareableTypeId(java.lang.String pShareableTypeId) |
void |
setSiteGroupManager(atg.multisite.SiteGroupManager pSiteGroupManager)
Sets the SiteGroupManager
|
void |
setStoreSitePropertiesManager(StoreSitePropertiesManager pStoreSitePropertiesManager)
Sets the StoreSitePropertiesManager bean which is used to manage store properties.
|
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter
destroy, getServletConfig, getServletInfo, setServletInfo
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static java.lang.String CLASS_VERSION
public static final atg.nucleus.naming.ParameterName SITE_ID
public static final atg.nucleus.naming.ParameterName SHAREABLE_TYPE_ID
public static final atg.nucleus.naming.ParameterName EXCLUDE_INPUT_SITE
public static final atg.nucleus.naming.ParameterName INCLUDE_ACTIVE_SITES
public static final atg.nucleus.naming.ParameterName INPUT_SITE_CHANNEL_ONLY
public static final atg.nucleus.naming.ParameterName OUTPUT
public static final java.lang.String SITES_IDS_PROP_NAME
protected atg.multisite.SiteGroupManager mSiteGroupManager
protected java.lang.String mShareableTypeId
protected boolean mExcludeInputSite
protected boolean mIncludeActiveSites
protected boolean mInputSiteChannelOnly
public RecommendationAlternativeSiteIdsDroplet()
public atg.multisite.SiteGroupManager getSiteGroupManager()
public void setSiteGroupManager(atg.multisite.SiteGroupManager pSiteGroupManager)
pSiteGroupManager
- the siteGroupManager to setpublic StoreSitePropertiesManager getStoreSitePropertiesManager()
public void setStoreSitePropertiesManager(StoreSitePropertiesManager pStoreSitePropertiesManager)
StoreSitePropertiesManager
- Set a new storeSitePropertyManager.public java.lang.String getShareableTypeId()
public void setShareableTypeId(java.lang.String pShareableTypeId)
mShareableTypeId
- the mShareableTypeId to setpublic boolean isExcludeInputSite()
public void setExcludeInputSite(boolean pExcludeInputSite)
pExcludeInputSite
- the excludeInputSite to setpublic boolean isIncludeActiveSites()
The default value for this property is false
.
public void setIncludeActiveSites(boolean pIncludeActiveSites)
The default value for this property is false
.
pIncludeActiveSites
- the includeActiveSites to setpublic boolean isInputSiteChannelOnly()
The default value for this property is true
.
public void setInputSiteChannelOnly(boolean pInputSiteChannelOnly)
The default value for this property is false
.
pInputSiteChannelOnly
- the InputSiteChannelOnly property to setpublic void service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
service
in class atg.servlet.DynamoServlet
pRequest
- The requestpResponse
- The responsejavax.servlet.ServletException
java.io.IOException
DynamoServlet.service(atg.servlet.DynamoHttpServletRequest,
atg.servlet.DynamoHttpServletResponse)
,
SiteGroupManager.findSharingSites(String, String, boolean, boolean)
protected void addSiteToList(atg.repository.RepositoryItem pSite, java.util.List<java.lang.String> pSitesList, java.lang.String pInputSiteId, boolean pExcludeInputSite, java.lang.String pInputSiteChannel, boolean pInputSiteChannelOnly)
pExcludeInputSite
is true
then input site will not be added.
If pInputSiteChannel
is true
then only sites with the same
channel will be added to the list.pSite
- The site repository item to add to the listpSitesList
- The list of sites to add to.pInputSiteId
- The droplet's input site.pExcludeInputSite
- The boolean indicating whether input site should be excluded.pInputSiteChannel
- The channel of the input site.pInputSiteChannelOnly
- The boolean indicating whether only site's with the same
channel as the input site can be added to the list.