com.broadleafcommerce.pricelist.dao

Interface PriceListDao

All Known Implementing Classes:

PriceListDaoImpl

public interface PriceListDao

Price List DAO

Author:

bpolster

Method Summary

Modifier and Type	Method and Description
Long	getCurrentDateResolution() Returns the number of milliseconds that the current date/time will be cached for queries before refreshing.
List<PriceList>	readAllActiveAndFuturePriceListsByType(PriceListType priceListType) Returns a list of PriceLists for a given PriceListType.
List<PriceList>	readAllActiveAndFuturePriceListsByTypes(List<PriceListType> priceListTypes)
List<PriceList>	readAllPriceListsByType(PriceListType priceListType) Returns a list of PriceLists for a given PriceListType.
List<PriceList>	readAllStandardPriceLists() Returns a list of standard PriceLists.
List<PriceList>	readNotDirectlyAssignedPriceListsByType(PriceListType priceListType)
ProductSkuPriceDataDTOCache	readPriceDataForProducts(List<org.broadleafcommerce.core.catalog.domain.Product> productIds) For the given productIds, return a Map of productId to a Map of skuId and PriceDataDTO.
SkuPriceData	readPriceForSku(PriceList priceList, org.broadleafcommerce.core.catalog.domain.Sku sku) Return a SKUPriceData item from a price list if one exists.
PriceList	readPriceListById(Long priceListId) Retrieve a PriceList instance by its primary key
List<PriceList>	readRuleBasedPriceListsByType(PriceListType priceListType)
void	removeAllFromPricingDataCache() Remove all members from the pricing cache.
void	removeFromPricingDataCache(SkuPriceData skuPriceData) Remove a member from the pricing cache.
PriceList	savePriceList(PriceList priceList) Persists a price list.
void	setCurrentDateResolution(Long currentDateResolution) Sets the number of milliseconds that the current date/time will be cached for queries before refreshing.

Method Detail

readPriceListById

@Nonnull
PriceList readPriceListById(@Nonnull
                                     Long priceListId)

Retrieve a PriceList instance by its primary key

Parameters:

priceListId - the primary key of the priceList

Returns:

the priceList instance at the specified primary key

readAllActiveAndFuturePriceListsByType

List<PriceList> readAllActiveAndFuturePriceListsByType(PriceListType priceListType)

Returns a list of PriceLists for a given PriceListType. Will order these price lists by priority with nulls being considered a lower priority than a set value. Also excludes PriceLists whose PriceList.getRequireAssignmentToCustomer() is true.

Returns:

a list of all currently configured PriceLists

readAllPriceListsByType

List<PriceList> readAllPriceListsByType(PriceListType priceListType)

Returns a list of PriceLists for a given PriceListType. Will order these price lists by priority with nulls being considered a lower priority than a set value. Filters out PriceLists that are inactive based on the start and end dates. Also excludes PriceLists whose PriceList.getRequireAssignmentToCustomer() is true.

Returns:

a list of all currently configured PriceLists

readNotDirectlyAssignedPriceListsByType

List<PriceList> readNotDirectlyAssignedPriceListsByType(PriceListType priceListType)

Parameters:

priceListType -

Returns:

readRuleBasedPriceListsByType

List<PriceList> readRuleBasedPriceListsByType(PriceListType priceListType)

Parameters:

priceListType -

Returns:

readAllStandardPriceLists

List<PriceList> readAllStandardPriceLists()

Returns a list of standard PriceLists. Will order these price lists by priority with nulls being considered a lower priority than a set value. Filters out PriceLists that are inactive based on the start and end dates. Also excludes PriceLists whose PriceList.getRequireAssignmentToCustomer() is true.

Returns:

a list of all currently configured PriceLists

savePriceList

PriceList savePriceList(PriceList priceList)

Persists a price list.

Parameters:

priceList -

Returns:

the persisted price list

readPriceForSku

SkuPriceData readPriceForSku(PriceList priceList,
                             org.broadleafcommerce.core.catalog.domain.Sku sku)

Return a SKUPriceData item from a price list if one exists. Handles sparse prices lists efficient

readAllActiveAndFuturePriceListsByTypes

List<PriceList> readAllActiveAndFuturePriceListsByTypes(List<PriceListType> priceListTypes)

removeFromPricingDataCache

void removeFromPricingDataCache(SkuPriceData skuPriceData)

Remove a member from the pricing cache. This should occur when a change to a SkuPriceData has occurred, either as the result of editing the SkuPriceData, or adding/deleting a SkuPriceData on a product.

Parameters:

skuPriceData -

removeAllFromPricingDataCache

void removeAllFromPricingDataCache()

Remove all members from the pricing cache.

readPriceDataForProducts

ProductSkuPriceDataDTOCache readPriceDataForProducts(List<org.broadleafcommerce.core.catalog.domain.Product> productIds)

For the given productIds, return a Map of productId to a Map of skuId and PriceDataDTO. This method is primarily used for improving performance for indexing.

Parameters:

productIds -

Returns:

getCurrentDateResolution

Long getCurrentDateResolution()

Returns the number of milliseconds that the current date/time will be cached for queries before refreshing. This aids in query caching, otherwise every query that utilized current date would be different and caching would be ineffective.

Returns:

the milliseconds to cache the current date/time

setCurrentDateResolution

void setCurrentDateResolution(Long currentDateResolution)

Sets the number of milliseconds that the current date/time will be cached for queries before refreshing. This aids in query caching, otherwise every query that utilized current date would be different and caching would be ineffective.

Parameters:

currentDateResolution - the milliseconds to cache the current date/time