|
|||||||||
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.nucleus.TimedOperationService atg.nucleus.servlet.ServletService atg.nucleus.servlet.HttpServletService atg.servlet.DynamoServlet atg.droplet.ForEach atg.commerce.catalog.custom.ForEachItemInCatalog
public class ForEachItemInCatalog
This is exactly the same as the ForEach droplet except only items that are in the current users catalog. One extra parameter is allowed, although it is optional. That parameter is "profile". If a profile is not provided, then it the current session scoped profile is used. If the element In the array is not of type RepositoryItem, it is not considered part of the users catalog.
This droplet should be used to iterate through lists of items that may not necessarily be in the current catalog. Examples of these are product.relatedProducts, category.relatedCategories, and sku.replacementSkus. Lists like childProducts can use ForEach instead.
Created: Thu Jun 21 11:58:51 2001
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Fields inherited from class atg.droplet.ForEach |
---|
ARRAY, COUNT, DEBUG, ELEMENT, ELEMENT_NAME, EMPTY, INDEX, INDEX_NAME, KEY, OUTPUT, OUTPUT_END, OUTPUT_START, REVERSE_ORDER, SIZE, SORT_PROPERTIES |
Fields inherited from class atg.servlet.DynamoServlet |
---|
mAllowCleanupRequest, mParameters |
Fields inherited from class atg.nucleus.servlet.ServletService |
---|
SERVLET_INFO_KEY |
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 | |
---|---|
ForEachItemInCatalog()
|
Method Summary | |
---|---|
java.lang.Object |
getArray(DynamoHttpServletRequest pReq)
Gets the array-like value (e.g., array, List, Enumeration) to be used by this droplet from the request. |
java.lang.String |
getCatalogsPropertyName()
The name of the property in categories, products, and skus that holds the list of catalogs that the item appears in. |
RepositoryItem |
getProfile()
Returns property Profile |
java.lang.String |
getProfilesCatalogPropertyName()
The name of the property in the Profile that stores the user's catalog. |
protected java.lang.Object[] |
getValidArray(java.lang.Object pArray,
DynamoHttpServletRequest pRequest)
Takes a collection of repository items and returns a list of those items in the current catalog. |
java.util.Dictionary |
getValidDictionary(java.util.Dictionary pArray,
DynamoHttpServletRequest pRequest)
|
java.util.Enumeration |
getValidEnumartion(java.util.Enumeration pArray,
DynamoHttpServletRequest pRequest)
Deprecated. this method is replaced by getValidEnumeration(Enumeration,DynamoHttpServletRequest) . |
java.util.Enumeration |
getValidEnumeration(java.util.Enumeration pArray,
DynamoHttpServletRequest pRequest)
|
java.util.Iterator |
getValidIterator(java.util.Iterator pArray,
DynamoHttpServletRequest pRequest)
Creates a new Iterator that references only the items in the user's catalog. |
protected java.util.List |
getValidList(java.util.Collection pArray,
DynamoHttpServletRequest pRequest)
Takes a collection of repository items and returns a list of those items in the current catalog. |
java.util.Map |
getValidMap(java.util.Map pArray,
DynamoHttpServletRequest pRequest)
|
protected java.util.Map.Entry[] |
getValidMapEntries(java.util.Map.Entry[] pArray,
DynamoHttpServletRequest pRequest)
Takes a collection of repository items and returns a list of those items in the current catalog. |
void |
setCatalogsPropertyName(java.lang.String pCatalogsPropertyName)
|
void |
setProfilesCatalogPropertyName(java.lang.String pProfilesCatalogPropertyName)
|
Methods inherited from class atg.droplet.ForEach |
---|
getSortedArray, service, serviceArray, serviceCollection, serviceDictionary, serviceEnumeration, serviceIndexedList, serviceIterator, serviceMap, serviceMapArray, servicePrimitiveArray, setElementParameter |
Methods inherited from class atg.servlet.DynamoServlet |
---|
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, service, service, setParameter |
Methods inherited from class atg.nucleus.servlet.ServletService |
---|
destroy, getServletConfig, getServletInfo, init, setServletInfo |
Methods inherited from class atg.nucleus.TimedOperationService |
---|
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics |
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
Constructor Detail |
---|
public ForEachItemInCatalog()
Method Detail |
---|
public void setCatalogsPropertyName(java.lang.String pCatalogsPropertyName)
public java.lang.String getCatalogsPropertyName()
public void setProfilesCatalogPropertyName(java.lang.String pProfilesCatalogPropertyName)
public java.lang.String getProfilesCatalogPropertyName()
public RepositoryItem getProfile()
public java.lang.Object getArray(DynamoHttpServletRequest pReq)
getArray
in class ForEach
protected java.util.List getValidList(java.util.Collection pArray, DynamoHttpServletRequest pRequest)
protected java.lang.Object[] getValidArray(java.lang.Object pArray, DynamoHttpServletRequest pRequest)
protected java.util.Map.Entry[] getValidMapEntries(java.util.Map.Entry[] pArray, DynamoHttpServletRequest pRequest)
public java.util.Enumeration getValidEnumartion(java.util.Enumeration pArray, DynamoHttpServletRequest pRequest)
getValidEnumeration(Enumeration,DynamoHttpServletRequest)
.
public java.util.Enumeration getValidEnumeration(java.util.Enumeration pArray, DynamoHttpServletRequest pRequest)
public java.util.Iterator getValidIterator(java.util.Iterator pArray, DynamoHttpServletRequest pRequest)
public java.util.Map getValidMap(java.util.Map pArray, DynamoHttpServletRequest pRequest)
public java.util.Dictionary getValidDictionary(java.util.Dictionary pArray, DynamoHttpServletRequest pRequest)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |