|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectatg.nucleus.logging.VariableArgumentApplicationLoggingImpl
atg.nucleus.GenericService
atg.nucleus.TimedOperationService
atg.nucleus.servlet.ServletService
atg.nucleus.servlet.HttpServletService
atg.servlet.DynamoServlet
atg.commerce.inventory.InventoryDroplet
public class InventoryDroplet
This Dynamo Servlet Bean is an interface into the Inventory management services.
A single global instance is defined with the Nucleus name
/atg/commerce/inventory/InventoryLookup
. This service is intended to
be configured with both a caching and non-caching InventoryManager. Therefore with
this one service a developer can easily show both cached and uncached inventory
information. The useCache
property defines the default InventoryManager
to use when the servlet is invoked. By default this value is true. This can be overrode
by setting the servlet param useCache to true
or false
.
This servlet requires a single parameter to be set, itemId. This should be the identifier that will be passed through to the InventoryManager services. Typically this would be a SKU id.
Setting filterOutOfStock will allow results to be filtered to only return results that are in stock.
Using this id the servlet uses an InventoryManager to set an inventory information object that includes several properties. It is inside the output oparam. The parameters are as follows:
InventoryManager
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
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 | |
---|---|
InventoryDroplet()
Constructs an instanceof InventoryDroplet |
Method Summary | |
---|---|
protected InventoryInfo |
createInventoryInfo(java.lang.String pInventoryId,
java.lang.String pLocationId,
InventoryManager pInventoryManager,
ApplicationLogging pLogging)
Create a new InventoryInfo object |
protected java.util.Collection<InventoryInfo> |
filterOutOfStockInventoryItems(java.util.Collection<InventoryInfo> pInfos)
Filters out 'out of stock' items from collection |
protected java.util.Collection<InventoryInfo> |
getBatchInfo(java.util.Collection<java.lang.String> pInventoryIds,
java.util.Collection<java.lang.String> pLocationIds,
InventoryManager pInventoryManager,
boolean pFilterOutOfStock)
Gets multiple inventory info messages in a single call if possible |
protected java.util.Collection<InventoryInfo> |
getBatchInfo(java.util.Collection<java.lang.String> pInventoryIds,
java.lang.String pLocationId,
InventoryManager pInventoryManager,
boolean pFilterOutOfStock)
Gets multiple inventory info messages in a single call if possible |
protected java.util.Collection<InventoryInfo> |
getBatchInfo(java.lang.String pInventoryId,
java.util.Collection<java.lang.String> pLocationIds,
InventoryManager pInventoryManager,
boolean pFilterOutOfStock)
Gets multiple inventory info messages in a single call if possible |
InventoryManager |
getCachingInventoryManager()
Returns property CachingInventoryManager |
protected InventoryInfo |
getInventoryInfo(java.lang.String pInventoryId,
java.lang.String pLocationId,
InventoryManager pInventoryManager,
boolean pFilterOutOfStock)
Gets an inventory info record for a given id and location. |
InventoryManager |
getInventoryManager()
Returns property InventoryManager |
boolean |
isLogMissingInventoryExceptionsAsError()
Return the logMissingInventoryExceptionsAsError property. |
boolean |
isUseCache()
Returns property UseCache |
boolean |
isUseLocalizedResourceStrings()
If this is true, then availability status messages are localized. |
void |
service(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
This method provides the default implementation of service, by dispatching to conventionally named methods which begin with "do". |
void |
setCachingInventoryManager(InventoryManager pCachingInventoryManager)
Sets property CachingInventoryManager |
void |
setInventoryManager(InventoryManager pInventoryManager)
Sets property InventoryManager |
void |
setLogMissingInventoryExceptionsAsError(boolean pLogMissingInventoryExceptionsAsError)
Set the logMissingInventoryExceptionsAsError property. |
void |
setUseCache(boolean pUseCache)
Sets property UseCache |
void |
setUseLocalizedResourceStrings(boolean pUseLocalizedResourceStrings)
|
Methods inherited from class atg.servlet.DynamoServlet |
---|
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter |
Methods inherited from class atg.nucleus.servlet.ServletService |
---|
destroy, getServletConfig, getServletInfo, 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 InventoryDroplet()
Method Detail |
---|
public void setLogMissingInventoryExceptionsAsError(boolean pLogMissingInventoryExceptionsAsError)
public boolean isLogMissingInventoryExceptionsAsError()
public void setUseCache(boolean pUseCache)
public boolean isUseCache()
public void setCachingInventoryManager(InventoryManager pCachingInventoryManager)
public InventoryManager getCachingInventoryManager()
public void setInventoryManager(InventoryManager pInventoryManager)
public InventoryManager getInventoryManager()
public void setUseLocalizedResourceStrings(boolean pUseLocalizedResourceStrings)
public boolean isUseLocalizedResourceStrings()
public void service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
DynamoServlet
service
in class DynamoServlet
pRequest
- the request to be processedpResponse
- the response object for this request
javax.servlet.ServletException
- an application specific error occurred
processing this request
java.io.IOException
- an error occurred reading data from the request
or writing data to the response.protected java.util.Collection<InventoryInfo> getBatchInfo(java.util.Collection<java.lang.String> pInventoryIds, java.lang.String pLocationId, InventoryManager pInventoryManager, boolean pFilterOutOfStock) throws InventoryException
pInventoryIds
- The Inventory Ids to retrievepLocationId
- the location of the inventorypInventoryManager
- the managerpFilterOutOfStock
- filter out items in "out of stock" state
InventoryException
protected java.util.Collection<InventoryInfo> getBatchInfo(java.lang.String pInventoryId, java.util.Collection<java.lang.String> pLocationIds, InventoryManager pInventoryManager, boolean pFilterOutOfStock) throws InventoryException
pInventoryId
- The Inventory Id to retrievepLocationIds
- the locations of the inventorypInventoryManager
- the managerpFilterOutOfStock
- filter out items in "out of stock" state
InventoryException
protected java.util.Collection<InventoryInfo> getBatchInfo(java.util.Collection<java.lang.String> pInventoryIds, java.util.Collection<java.lang.String> pLocationIds, InventoryManager pInventoryManager, boolean pFilterOutOfStock) throws InventoryException
pInventoryIds
- The Inventory Ids to retrievepLocationIds
- the locations of the inventorypInventoryManager
- the managerpFilterOutOfStock
- filter out items in "out of stock" state
InventoryException
protected InventoryInfo getInventoryInfo(java.lang.String pInventoryId, java.lang.String pLocationId, InventoryManager pInventoryManager, boolean pFilterOutOfStock) throws InventoryException
pInventoryIds
- The Inventory Ids to retrievepLocationIds
- the locations of the inventorypInventoryManager
- the managerpFilterOutOfStock
- filter out items in "out of stock" state
InventoryException
protected InventoryInfo createInventoryInfo(java.lang.String pInventoryId, java.lang.String pLocationId, InventoryManager pInventoryManager, ApplicationLogging pLogging)
protected java.util.Collection<InventoryInfo> filterOutOfStockInventoryItems(java.util.Collection<InventoryInfo> pInfos)
pInfos
- collection of InventoryInfo objects to be filtered
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |