de.hybris.platform.jalo.order.price

Class AbstractPriceFactory

java.lang.Object

de.hybris.platform.jalo.Manager

de.hybris.platform.jalo.extension.Extension

de.hybris.platform.jalo.order.price.AbstractPriceFactory

All Implemented Interfaces:

PriceFactory, Serializable

Direct Known Subclasses:

DummyPriceFactory, GeneratedEurope1PriceFactory

public abstract class AbstractPriceFactory
extends Extension
implements PriceFactory

The PriceFactory base class. All PriceFactory implementations must inherit from this class.

A PriceFactory is responsible for calculating product price quotes as well as order prices. This may include the calcuation of taxes and discounts.

The Hybris Platform core does not have any default price model implemented but usually ships one PriceFactory implementation (in form of an extension) within the installation package. So please refer to the available extension documentation about which features this price model provides.

To implement a PriceFactory at least the following methods have to be implemented:

• getBasePrice(AbstractOrderEntry) - provides the base price for a order entry
• getProductPriceInformations(Product, Date, boolean) - provides all prices which apply to a Product
• getProductTaxInformations(Product, Date) - provides all taxes which apply to a Product
• getProductDiscountInformations(Product, Date, boolean) - provides all discounts which apply to a Product

Please note that

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.jalo.extension.Extension

Extension.RestrictedLanguagesProvider, Extension.RightsProvider

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Manager

Manager.GenericManagerSingletonCreator, Manager.ManagerSingletonCreator

Constructor Summary

Constructors

Constructor and Description
AbstractPriceFactory()

Method Summary

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

Methods inherited from class de.hybris.platform.jalo.extension.Extension

checkBeforeItemRemoval, createEssentialData, createProjectData, createSampleData, getCreatorDescription, getCreatorName, getCreatorParameterDefault, getCreatorParameterNames, getCreatorParameterPossibleValues, getDefaultAttributeModes, getName, getRemote, isCreatorDisabled, notifyInitializationEnd, notifyInitializationStart, notifyItemRemoval, onFirstSessionCreation, writeReplace

Methods inherited from class de.hybris.platform.jalo.Manager

afterItemCreation, beforeItemCreation, destroy, getAllValuesSessionContext, getAttribute, getAttributeMap, getFirstItemByAttribute, getFirstItemByAttribute, getRemoteManagerClass, getSession, getSingletonManagerInstance, getTenant, getTransientObject, getTransientObjectMap, init, setAttribute, setTenant, setTransientObject, unwrap, unwrap, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractPriceFactory

public AbstractPriceFactory()

Method Detail

getInstance

public static AbstractPriceFactory getInstance()

getAllPriceInformations

@Deprecated
public final ProductPriceInformations getAllPriceInformations(Product product,
                                                                          Date date,
                                                                          boolean net)
                                                                   throws JaloPriceFactoryException

Deprecated. please use getAllPriceInformations(SessionContext, Product, Date, boolean) instead

Throws:

JaloPriceFactoryException - if a calculation error occured

getAllPriceInformations

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

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(Product, Date, boolean), getProductTaxInformations(Product, Date) and getProductDiscountInformations(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(Product, Date, boolean), getProductTaxInformations(Product, Date) and getProductDiscountInformations(Product, Date, boolean) since these methods are called by Product directly.

Specified by:

getAllPriceInformations in interface PriceFactory

Throws:

JaloPriceFactoryException - if a calculation error occured

Since:

2.10

getProductPriceInformations

@Deprecated
public final List getProductPriceInformations(Product product,
                                                          Date date,
                                                          boolean net)
                                                   throws JaloPriceFactoryException

Deprecated. please use getProductPriceInformations(SessionContext, Product, Date, boolean) instead

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

getProductPriceInformations

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

Override this to show all prices available for the given product

Specified by:

getProductPriceInformations in interface PriceFactory

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

Since:

2.10

getProductTaxInformations

@Deprecated
public final List getProductTaxInformations(Product product,
                                                        Date date)
                                                 throws JaloPriceFactoryException

Deprecated. please use getProductTaxInformations(SessionContext, Product, Date) instead

Parameters:

product - the product

Returns:

a list of TaxInformation objects

Throws:

JaloPriceFactoryException - if price calculation error occured

getProductTaxInformations

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

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

Specified by:

getProductTaxInformations in interface PriceFactory

Parameters:

product - the product

Returns:

a list of TaxInformation objects

Throws:

JaloPriceFactoryException - if price calculation error occured

Since:

2.10

getProductDiscountInformations

@Deprecated
public final List getProductDiscountInformations(Product product,
                                                             Date date,
                                                             boolean net)
                                                      throws JaloPriceFactoryException

Deprecated. please use getProductDiscountInformations(SessionContext, Product, Date, boolean) instead

Parameters:

product - the product

Returns:

a list of DiscountInformation objects

Throws:

JaloPriceFactoryException - if price calculation error occured

getProductDiscountInformations

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

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

Specified by:

getProductDiscountInformations in interface PriceFactory

Parameters:

product - the product

Returns:

a list of DiscountInformation objects

Throws:

JaloPriceFactoryException - if price calculation error occured

Since:

2.10

isNetUser

public boolean isNetUser(User user)

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

Specified by:

isNetUser in interface PriceFactory

Returns:

false as default

getTaxValues

public Collection getTaxValues(AbstractOrderEntry entry)
                        throws JaloPriceFactoryException

override to define tax values for an order entry.

Specified by:

getTaxValues in interface PriceFactory

Returns:

empty list as default

Throws:

JaloPriceFactoryException

getBasePrice

public abstract PriceValue getBasePrice(AbstractOrderEntry entry)
                                 throws JaloPriceFactoryException

override to define the base price of an order entry

Specified by:

getBasePrice in interface PriceFactory

Returns:

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

Throws:

JaloPriceFactoryException

getDiscountValues

public List getDiscountValues(AbstractOrderEntry entry)
                       throws JaloPriceFactoryException

override to define discount values for an order entry.

Specified by:

getDiscountValues in interface PriceFactory

Returns:

empty list as default

Throws:

JaloPriceFactoryException

getDiscountValues

public List getDiscountValues(AbstractOrder order)
                       throws JaloPriceFactoryException

override to define (global) discounts for an order. these discounts are applied to the whole order, not just to one entry like getDiscountValues(AbstractOrderEntry)

Specified by:

getDiscountValues in interface PriceFactory

Returns:

empty list as default

Throws:

JaloPriceFactoryException