de.hybris.platform.jalo.order.price

Interface PriceFactory

All Known Subinterfaces:

ExtendedPriceFactory

All Known Implementing Classes:

AbstractPriceFactory, CatalogAwareEurope1PriceFactory, CustomPriceFactoryTest.TinyPriceFactory, DummyPriceFactory, DummyPriceFactoryImpl, Europe1PriceFactory, ExtendedCatalogAwareEurope1PriceFactory, GeneratedEurope1PriceFactory

public interface PriceFactory

Method Summary

Modifier and Type	Method and Description
ProductPriceInformations	getAllPriceInformations(SessionContext ctx, Product product, Date date, boolean net) Implement this to calculates a product price quote containing all applicable prices, discounts and taxes for the given product and net/gross state.
PriceValue	getBasePrice(AbstractOrderEntry entry) Implement this to define the base price of an order entry
List	getDiscountValues(AbstractOrder order) Implement this to define (global) discount values for an order.
List	getDiscountValues(AbstractOrderEntry entry) Implement this to define discount values for an order entry.
List	getProductDiscountInformations(SessionContext ctx, Product product, Date date, boolean net) Implement this to show all discounts which may apply to the given product
List	getProductPriceInformations(SessionContext ctx, Product product, Date date, boolean net) Implement this to show all prices available for the given product
List	getProductTaxInformations(SessionContext ctx, Product product, Date date) Implement this to show all taxes which apply to the given product
Collection	getTaxValues(AbstractOrderEntry entry) Implement this to define tax values for an order entry.
boolean	isNetUser(User user) Implement this to define whether a user should be treated as net or gross customer.

Method Detail

getAllPriceInformations

ProductPriceInformations getAllPriceInformations(SessionContext ctx,
                                                 Product product,
                                                 Date date,
                                                 boolean net)
                                          throws JaloPriceFactoryException

Implement this to calculates a product price quote containing all applicable prices, discounts and taxes for the given product and net/gross state.

This default implementation just calls getProductPriceInformations(SessionContext, Product, Date, boolean), getProductTaxInformations(SessionContext, Product, Date ) and getProductDiscountInformations(SessionContext, Product, Date, boolean ) and wraps the results inside a ProductPriceInformations object.

Override to define the prices, taxes and discounts for all occasions when no order or order entry is available, e.g. for product lists. Please take care also to override getProductPriceInformations(SessionContext, Product, Date, boolean ), getProductTaxInformations(SessionContext, Product, Date) and getProductDiscountInformations(SessionContext, Product, Date, boolean ) since these methods are called by Product directly.

Throws:

JaloPriceFactoryException - if a calculation error occured

getProductPriceInformations

List getProductPriceInformations(SessionContext ctx,
                                 Product product,
                                 Date date,
                                 boolean net)
                          throws JaloPriceFactoryException

Implement this to show all prices available for the given product

Parameters:

product - the product

net - the net/gross state of the requested prices

Returns:

a list of PriceInformation objects

Throws:

JaloPriceFactoryException - if price calculation error occured

getProductTaxInformations

List getProductTaxInformations(SessionContext ctx,
                               Product product,
                               Date date)
                        throws JaloPriceFactoryException

Implement this to show all taxes which apply to the given product

Parameters:

product - the product

Returns:

a list of TaxInformation objects

Throws:

JaloPriceFactoryException - if price calculation error occured

getProductDiscountInformations

List getProductDiscountInformations(SessionContext ctx,
                                    Product product,
                                    Date date,
                                    boolean net)
                             throws JaloPriceFactoryException

Implement this to show all discounts which may apply to the given product

Parameters:

product - the product

Returns:

a list of DiscountInformation objects

Throws:

JaloPriceFactoryException - if price calculation error occured

isNetUser

boolean isNetUser(User user)

Implement this to define whether a user should be treated as net or gross customer.

Returns:

true, if the given user is treated as a net customer

getTaxValues

Collection getTaxValues(AbstractOrderEntry entry)
                 throws JaloPriceFactoryException

Implement this to define tax values for an order entry.

Returns:

the Collection of TaxValues assigned to the given AbstractOrderEntry

Throws:

JaloPriceFactoryException

getBasePrice

PriceValue getBasePrice(AbstractOrderEntry entry)
                 throws JaloPriceFactoryException

Implement this to define the base price of an order entry

Returns:

a price with the order's currency iso code, 0.0 as value and the order's net status

Throws:

JaloPriceFactoryException

getDiscountValues

List getDiscountValues(AbstractOrderEntry entry)
                throws JaloPriceFactoryException

Implement this to define discount values for an order entry.

Returns:

the Collection of DiscountValues assigned to the given AbstractOrderEntry

Throws:

JaloPriceFactoryException

getDiscountValues

List getDiscountValues(AbstractOrder order)
                throws JaloPriceFactoryException

Implement this to define (global) discount values for an order. These discount values are applied to the whole order, not just to one entry like getDiscountValues(AbstractOrderEntry)

Returns:

the Collection of DiscountValues applicable to the given AbstractOrder

Throws:

JaloPriceFactoryException