|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.service.collections.filter.CachedCollectionFilter atg.commerce.gifts.GiftlistSiteFilter
public class GiftlistSiteFilter
This filter filters gift list and gift list items in the collection depending on whether they belong to the specified site / shareable or not.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
protected GiftlistManager |
mGiftlistManager
|
protected boolean |
mIncludeDisabledSites
|
protected boolean |
mIncludeInactiveSites
|
protected atg.multisite.SiteGroupManager |
mSiteGroupManager
|
protected atg.multisite.SiteManager |
mSiteManager
|
Fields inherited from class atg.service.collections.filter.CachedCollectionFilter |
---|
FILTER_CACHE_COMPONENT, mCache, mCacheEnabled |
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
GiftlistSiteFilter()
|
Method Summary | |
---|---|
protected java.util.Collection |
generateFilteredCollection(java.util.Collection pUnfilteredCollection,
java.lang.String pCollectionIdentifierKey,
RepositoryItem pProfile,
java.util.Map pExtraParameters)
This method does filtering in the following way: Retrieves site ID and shareable type from extra parameters map passed to the method. |
GiftlistManager |
getGiftlistManager()
Returns SiteGroupManager instance |
protected atg.multisite.SiteGroupManager |
getSiteGroupManager()
Returns the SiteGroupManager instance |
atg.multisite.SiteManager |
getSiteManager()
This property contains a reference to SiteManager to be used when determining active
and disabled sites. |
boolean |
isIncludeDisabledSites()
Returns the includeDisabledSites property. |
boolean |
isIncludeInactiveSites()
Returns the includeInactiveSites property. |
void |
setGiftlistManager(GiftlistManager giftlistManager)
Sets the GiftlistManager instance |
void |
setIncludeDisabledSites(boolean pIncludeDisabledSites)
Sets the includeDisabledSites property. |
void |
setIncludeInactiveSites(boolean pIncludeInactiveSites)
Sets the includeInactiveSites property. |
void |
setSiteGroupManager(atg.multisite.SiteGroupManager pSiteGroupManager)
Sets the SiteGroupManager instance |
void |
setSiteManager(atg.multisite.SiteManager pSiteManager)
Sets the SiteManager instance |
Methods inherited from class atg.service.collections.filter.CachedCollectionFilter |
---|
dumpCache, filterCollection, filterCollection, filterCollection, filterCollection, flushCache, generateCacheKey, generateCacheKey, generateContextKey, generateContextKey, generateFilteredCollection, generateNewCollectionObject, getCache, getDefaultProfile, isCacheEnabled, setCache, setCacheEnabled, shouldApplyFilter, shouldApplyFilter, stringIt |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
protected boolean mIncludeDisabledSites
protected boolean mIncludeInactiveSites
protected atg.multisite.SiteGroupManager mSiteGroupManager
protected atg.multisite.SiteManager mSiteManager
protected GiftlistManager mGiftlistManager
Constructor Detail |
---|
public GiftlistSiteFilter()
Method Detail |
---|
public boolean isIncludeDisabledSites()
public void setIncludeDisabledSites(boolean pIncludeDisabledSites)
pIncludeDisabledSites
- whether or not to filter out items that exist only
on disabled sites. A value of true
indicates that items should be
retained in the collection even if all their sites are disabled.public boolean isIncludeInactiveSites()
public void setIncludeInactiveSites(boolean pIncludeInactiveSites)
pIncludeInactiveSites
- whether or not to filter out items that exist only
on inactive sites. A value of true
indicates that items should be
retained in the collection even if all their sites are inactive.protected atg.multisite.SiteGroupManager getSiteGroupManager()
public void setSiteGroupManager(atg.multisite.SiteGroupManager pSiteGroupManager)
pSiteGroupManager
- the siteGroupManager to setpublic atg.multisite.SiteManager getSiteManager()
SiteManager
to be used when determining active
and disabled sites.
public void setSiteManager(atg.multisite.SiteManager pSiteManager)
pSiteManager
- the SiteManager to setpublic GiftlistManager getGiftlistManager()
public void setGiftlistManager(GiftlistManager giftlistManager)
giftlistManager
- the giftlistManager to setprotected java.util.Collection generateFilteredCollection(java.util.Collection pUnfilteredCollection, java.lang.String pCollectionIdentifierKey, RepositoryItem pProfile, java.util.Map pExtraParameters) throws FilterException
generateFilteredCollection
in class CachedCollectionFilter
pUnfilteredCollection
- Unfiltered collection of elementspCollectionIdentifierKey
- Identifier keypProfile
- ProfilepExtraParameters
- A map of extra parameters
FilterException
GiftlistManager.areSitesCompatible(String, String)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |