atg.projects.store.inventory

Interface StoreInventoryManagerInterface

All Superinterfaces:

atg.commerce.inventory.InventoryManager, atg.commerce.inventory.LocationInventoryManager

All Known Implementing Classes:

StoreInventoryManager

public interface StoreInventoryManagerInterface
extends atg.commerce.inventory.LocationInventoryManager

An interface for CRS additions to the LocationInventoryManager.

Author:

ATG

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Fields inherited from interface atg.commerce.inventory.InventoryManager

AVAILABILITY_STATUS_BACKORDERABLE, AVAILABILITY_STATUS_DERIVED, AVAILABILITY_STATUS_DISCONTINUED, AVAILABILITY_STATUS_IN_STOCK, AVAILABILITY_STATUS_OUT_OF_STOCK, AVAILABILITY_STATUS_PREORDERABLE, INVENTORY_STATUS_FAIL, INVENTORY_STATUS_INSUFFICIENT_SUPPLY, INVENTORY_STATUS_ITEM_NOT_FOUND, INVENTORY_STATUS_SUCCEED

Method Summary

Methods

Modifier and Type	Method and Description
void	createBackInStockNotifyItem(atg.repository.MutableRepository pRepository, java.lang.String pCatalogRefId, java.lang.String pEmail, java.lang.String pProductId, java.lang.String pLocale, java.lang.String pSiteId) Creates the required item in the repository.
int	getAvailabilityStatusBackorderableValue() The integer value for the availabilityStatus of BACKORDERABLE
int	getAvailabilityStatusDerivedValue() The integer value for the availabilityStatus of DERIVED
int	getAvailabilityStatusDiscontinuedValue() The integer value for the availabilityStatus of DISCONTINUED
int	getAvailabilityStatusInStockValue() The integer value for the availabilityStatus of IN_STOCK
int	getAvailabilityStatusOutOfStockValue() The integer value for the availabilityStatus of OUT_OF_STOCK
int	getAvailabilityStatusPreorderableValue() The integer value for the availabilityStatus of PREORDERABLE
java.util.Date	getBackorderAvailabilityDate(java.lang.String pSkuId) Get the availabilityDate from the inventory data for a SKU item.
StoreCatalogProperties	getCatalogProperties()
atg.repository.Repository	getCatalogRefRepository() Returns property CatalogRefRepository
java.util.Date	getPreorderAvailabilityDate(atg.repository.RepositoryItem pProduct) Get the availabilityDate for a product.
boolean	isBackInStockItemExists(atg.repository.MutableRepository pRepository, java.lang.String pCatalogRefId, java.lang.String pEmail, java.lang.String pProductId) Check to see if backInStoreNotifyItem already exists for this combination of CatalogRefId and email.
boolean	isBackInStockItemExists(atg.repository.MutableRepository pRepository, java.lang.String pCatalogRefId, java.lang.String pEmail, java.lang.String pProductId, java.lang.String pLocationId)
boolean	isItemInStock(java.lang.String pSkuId) Returns true if SKU is in stock.
boolean	isItemInStock(java.lang.String pSkuId, java.lang.String pLocationId)
boolean	logInventoryException(atg.commerce.inventory.InventoryException pException) The method logs InventoryException.
int	queryAvailabilityStatus(atg.repository.RepositoryItem pProduct, java.lang.String pSkuId) Derive the availabilityStatus based on the properties of the product and the item.
int	queryAvailabilityStatus(atg.repository.RepositoryItem pProduct, java.lang.String pSkuId, java.lang.String pLocationId)

Methods inherited from interface atg.commerce.inventory.LocationInventoryManager

acquireInventoryLocks, backorder, backorder, decreaseBackorderLevel, decreaseBackorderLevel, decreasePreorderLevel, decreasePreorderLevel, decreaseStockLevel, decreaseStockLevel, increaseBackorderLevel, increaseBackorderLevel, increasePreorderLevel, increasePreorderLevel, increaseStockLevel, increaseStockLevel, inventoryWasUpdated, preorder, preorder, purchase, purchase, purchaseOffBackorder, purchaseOffBackorder, purchaseOffPreorder, purchaseOffPreorder, queryAvailabilityDate, queryAvailabilityStatus, queryAvailableToPromise, queryBackorderLevel, queryBackorderLevelWithFraction, queryBackorderThreshold, queryInventoryInformation, queryInventoryInformation, queryInventoryInformation, queryInventoryInformation, queryPreorderLevel, queryPreorderLevelWithFraction, queryPreorderThreshold, queryStockLevel, queryStockLevelWithFraction, queryStockThreshold, releaseInventoryLocks, setAvailabilityDate, setAvailabilityStatus, setBackorderLevel, setBackorderLevel, setBackorderThreshold, setPreorderLevel, setPreorderLevel, setPreorderThreshold, setStockLevel, setStockLevel, setStockThreshold

Methods inherited from interface atg.commerce.inventory.InventoryManager

acquireInventoryLocks, backorder, backorder, decreaseBackorderLevel, decreaseBackorderLevel, decreasePreorderLevel, decreasePreorderLevel, decreaseStockLevel, decreaseStockLevel, getInventoryName, increaseBackorderLevel, increaseBackorderLevel, increasePreorderLevel, increasePreorderLevel, increaseStockLevel, increaseStockLevel, inventoryWasUpdated, preorder, preorder, purchase, purchase, purchaseOffBackorder, purchaseOffBackorder, purchaseOffPreorder, purchaseOffPreorder, queryAvailabilityDate, queryAvailabilityStatus, queryBackorderLevel, queryBackorderLevelWithFraction, queryBackorderThreshold, queryPreorderLevel, queryPreorderLevelWithFraction, queryPreorderThreshold, queryStockLevel, queryStockLevelWithFraction, queryStockThreshold, releaseInventoryLocks, setAvailabilityDate, setAvailabilityStatus, setBackorderLevel, setBackorderLevel, setBackorderThreshold, setPreorderLevel, setPreorderLevel, setPreorderThreshold, setStockLevel, setStockLevel, setStockThreshold

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Method Detail

logInventoryException

boolean logInventoryException(atg.commerce.inventory.InventoryException pException)

The method logs InventoryException. MissingInventoryException is logged only if logMissingInventoryExceptionsAsError property is configured to true.

Parameters:

pException - The InventoryException to log.

Returns:

true if exception has been logged as error.

isItemInStock

boolean isItemInStock(java.lang.String pSkuId)
                      throws atg.commerce.inventory.InventoryException

Returns true if SKU is in stock.

Parameters:

pSkuId - SKU ID.

Returns:

true if SKU is in stock.

Throws:

atg.commerce.inventory.InventoryException - if there was an error while attempting to return the inventory information.

isItemInStock

boolean isItemInStock(java.lang.String pSkuId,
                    java.lang.String pLocationId)
                      throws atg.commerce.inventory.InventoryException

Throws:

atg.commerce.inventory.InventoryException

queryAvailabilityStatus

int queryAvailabilityStatus(atg.repository.RepositoryItem pProduct,
                          java.lang.String pSkuId)
                            throws atg.commerce.inventory.InventoryException

Derive the availabilityStatus based on the properties of the product and the item. Always derives the status, does not check the current value of availabilityStatus. Pre-orderability is checked first. Pre-orderability can be set based just on product properties or on a combination of product properties and inventory levels. The end date for pre-orderability can be set to a fixed date or use stockLevel to determine when it ends. If an item is not pre-orderable, then the inventory levels are checked to see if it is available, back-orderable or unavailable.

Parameters:

pProduct - The product we are deriving the status for.

pSkuId - The SKU we are deriving the status for.

Returns:

The derived status.

Throws:

atg.commerce.inventory.InventoryException - if there was an error while attempting to return the inventory information.

queryAvailabilityStatus

int queryAvailabilityStatus(atg.repository.RepositoryItem pProduct,
                          java.lang.String pSkuId,
                          java.lang.String pLocationId)
                            throws atg.commerce.inventory.InventoryException

Throws:

atg.commerce.inventory.InventoryException

isBackInStockItemExists

boolean isBackInStockItemExists(atg.repository.MutableRepository pRepository,
                              java.lang.String pCatalogRefId,
                              java.lang.String pEmail,
                              java.lang.String pProductId)
                                throws atg.repository.RepositoryException

Check to see if backInStoreNotifyItem already exists for this combination of CatalogRefId and email.

Parameters:

pRepository - - Repository where to check if item exists.

pCatalogRefId - - repository id.

pEmail - - string that represents email.

pProductId - - product id.

Returns:

true if item exists.

Throws:

atg.repository.RepositoryException - if there was an error while creating repository item.

isBackInStockItemExists

boolean isBackInStockItemExists(atg.repository.MutableRepository pRepository,
                              java.lang.String pCatalogRefId,
                              java.lang.String pEmail,
                              java.lang.String pProductId,
                              java.lang.String pLocationId)
                                throws atg.repository.RepositoryException

Throws:

atg.repository.RepositoryException

createBackInStockNotifyItem

void createBackInStockNotifyItem(atg.repository.MutableRepository pRepository,
                               java.lang.String pCatalogRefId,
                               java.lang.String pEmail,
                               java.lang.String pProductId,
                               java.lang.String pLocale,
                               java.lang.String pSiteId)
                                 throws atg.repository.RepositoryException

Creates the required item in the repository.

Parameters:

pRepository - - Repository where to create item.

pCatalogRefId - - repository id.

pEmail - - string that represents email.

pProductId - - product id.

pLocale - - local.

pSiteId - - site id.

Throws:

atg.repository.RepositoryException - if there was an error while creating repository item.

getBackorderAvailabilityDate

java.util.Date getBackorderAvailabilityDate(java.lang.String pSkuId)
                                            throws atg.commerce.inventory.InventoryException

Get the availabilityDate from the inventory data for a SKU item.

Parameters:

pSkuId - - The SKU we are getting the availability date for.

Returns:

The availabilityDate which may be null.

Throws:

atg.commerce.inventory.InventoryException - if there was an error while attempting to return the inventory information.

getPreorderAvailabilityDate

java.util.Date getPreorderAvailabilityDate(atg.repository.RepositoryItem pProduct)

Get the availabilityDate for a product.

Parameters:

pProduct - - The product we are getting the availability date for.

Returns:

The availabilityDate which may be null.

getCatalogProperties

StoreCatalogProperties getCatalogProperties()

Returns:

catalog properties.

getCatalogRefRepository

atg.repository.Repository getCatalogRefRepository()

Returns property CatalogRefRepository

getAvailabilityStatusDerivedValue

int getAvailabilityStatusDerivedValue()

The integer value for the availabilityStatus of DERIVED

getAvailabilityStatusInStockValue

int getAvailabilityStatusInStockValue()

The integer value for the availabilityStatus of IN_STOCK

getAvailabilityStatusBackorderableValue

int getAvailabilityStatusBackorderableValue()

The integer value for the availabilityStatus of BACKORDERABLE

getAvailabilityStatusPreorderableValue

int getAvailabilityStatusPreorderableValue()

The integer value for the availabilityStatus of PREORDERABLE

getAvailabilityStatusOutOfStockValue

int getAvailabilityStatusOutOfStockValue()

The integer value for the availabilityStatus of OUT_OF_STOCK

getAvailabilityStatusDiscontinuedValue

int getAvailabilityStatusDiscontinuedValue()

The integer value for the availabilityStatus of DISCONTINUED