|
|||||||||
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.collections.filter.ItemSiteFilter
public class ItemSiteFilter
Implementation of CachedCollectionFilter
which filters input products collection by their site IDs.
This filter will return only products whose site IDs intersect with site IDs from the current sharing group
defined by the shareableTypeId
property.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version |
protected boolean |
mIncludeDisabledSites
mIncludeDisabledSites; a value of true indicates that items should be
retained in the collection even if all their sites are disabled |
protected boolean |
mIncludeInactiveSites
mIncludeInactiveSites; a value of true indicates that items should be
retained in the collection even if all their sites are inactive |
protected java.lang.String |
mShareableTypeId
|
protected SiteGroupManager |
mSiteGroupManager
|
protected SiteManager |
mSiteManager
|
protected java.lang.String |
mSitesPropertyName
|
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 | |
---|---|
ItemSiteFilter()
|
Method Summary | |
---|---|
java.util.Collection |
generateFilteredCollection(java.util.Collection pUnfilteredCollection,
java.lang.String pCollectionIdentifierKey,
RepositoryItem pProfile)
This method filters the passed in collection by the current site. |
java.lang.String |
getShareableTypeId()
This property contains a shareable ID to be used when determining sharing sites. |
SiteGroupManager |
getSiteGroupManager()
This property contains a reference to SiteGroupManager to be used when determining sharing sites. |
SiteManager |
getSiteManager()
This property contains a reference to SiteManager to be used when determining active sites. |
java.lang.String |
getSitesPropertyName()
This property contains the name of the property that holds references to an item's sites. |
boolean |
isIncludeDisabledSites()
Returns the includeDisabledSites property. |
boolean |
isIncludeInactiveSites()
Returns the includeInactiveSites property. |
void |
setIncludeDisabledSites(boolean pIncludeDisabledSites)
Sets the includeDisabledSites property. |
void |
setIncludeInactiveSites(boolean pIncludeInactiveSites)
Sets the includeInactiveSites property. |
void |
setShareableTypeId(java.lang.String pShareableTypeId)
|
void |
setSiteGroupManager(SiteGroupManager pSiteGroupManager)
|
void |
setSiteManager(SiteManager pSiteManager)
|
void |
setSitesPropertyName(java.lang.String pSitesPropertyName)
|
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, vlogDebugTrace, 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 java.lang.String mShareableTypeId
protected boolean mIncludeDisabledSites
true
indicates that items should be
retained in the collection even if all their sites are disabled
protected boolean mIncludeInactiveSites
true
indicates that items should be
retained in the collection even if all their sites are inactive
protected java.lang.String mSitesPropertyName
protected SiteGroupManager mSiteGroupManager
protected SiteManager mSiteManager
Constructor Detail |
---|
public ItemSiteFilter()
Method Detail |
---|
public java.lang.String getShareableTypeId()
public void setShareableTypeId(java.lang.String pShareableTypeId)
public boolean isIncludeDisabledSites()
public void setIncludeDisabledSites(boolean pIncludeDisabledSites)
pIncludeDisabledSites
- whether or not to filter out items that exist only
on disabled sitespublic boolean isIncludeInactiveSites()
public void setIncludeInactiveSites(boolean pIncludeInactiveSites)
pIncludeInactiveSites
- whether or not to filter out items that exist only
on inactive sitespublic java.lang.String getSitesPropertyName()
public void setSitesPropertyName(java.lang.String pSitesPropertyName)
public SiteGroupManager getSiteGroupManager()
SiteGroupManager
to be used when determining sharing sites.
public void setSiteGroupManager(SiteGroupManager pSiteGroupManager)
public SiteManager getSiteManager()
SiteManager
to be used when determining active sites.
public void setSiteManager(SiteManager pSiteManager)
public java.util.Collection generateFilteredCollection(java.util.Collection pUnfilteredCollection, java.lang.String pCollectionIdentifierKey, RepositoryItem pProfile) throws FilterException
generateFilteredCollection
in class CachedCollectionFilter
pUnfilteredCollection
- the collection to be filteredpCollectionIdentifierKey
- unused
pProfile pCollectionIdentifierKey unusedpProfile
- Repository item
FilterException
- if the item does not have a sites property
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |