org.broadleafcommerce.core.offer.domain

Interface OrderItemPriceDetailAdjustment

All Superinterfaces:

Adjustment, MultiTenantCloneable<OrderItemPriceDetailAdjustment>, Serializable

All Known Implementing Classes:

OrderItemPriceDetailAdjustmentImpl

public interface OrderItemPriceDetailAdjustment
extends Adjustment, MultiTenantCloneable<OrderItemPriceDetailAdjustment>

Records the actual adjustments that were made to an OrderItemPriceDetail.

Author:

bpolster

Method Summary

Modifier and Type	Method and Description
String	getOfferName() Stores the offer name at the time the adjustment was made.
OrderItemPriceDetail	getOrderItemPriceDetail()
Money	getRetailPriceValue() Value of this adjustment relative to the retail price.
Money	getSalesPriceValue() Value of this adjustment relative to the sale price.
void	init(OrderItemPriceDetail orderItemPriceDetail, Offer offer, String reason)
boolean	isAppliedToSalePrice() Even for items that are on sale, it is possible that an adjustment was made to the retail price that gave the customer a better offer.
boolean	isFutureCredit() Future credit means that the associated adjustment will be discounted at a later time to the customer via a credit.
void	setAppliedToSalePrice(boolean appliedToSalePrice)
void	setFutureCredit(boolean futureCredit) Future credit means that the associated adjustment will be discounted at a later time to the customer via a credit.
void	setOfferName(String offerName) Returns the name of the offer at the time the adjustment was made.
void	setOrderItemPriceDetail(OrderItemPriceDetail orderItemPriceDetail)
void	setRetailPriceValue(Money retailPriceValue)
void	setSalesPriceValue(Money salesPriceValue)

Methods inherited from interface org.broadleafcommerce.core.offer.domain.Adjustment

getId, getOffer, getReason, getValue, setId, setReason, setValue

Methods inherited from interface org.broadleafcommerce.common.copy.MultiTenantCloneable

createOrRetrieveCopyInstance

Method Detail

getOfferName

String getOfferName()

Stores the offer name at the time the adjustment was made. Primarily to simplify display within the admin.

Returns:

setOfferName

void setOfferName(String offerName)

Returns the name of the offer at the time the adjustment was made.

Parameters:

offerName -

getOrderItemPriceDetail

OrderItemPriceDetail getOrderItemPriceDetail()

init

void init(OrderItemPriceDetail orderItemPriceDetail,
          Offer offer,
          String reason)

setOrderItemPriceDetail

void setOrderItemPriceDetail(OrderItemPriceDetail orderItemPriceDetail)

isAppliedToSalePrice

boolean isAppliedToSalePrice()

Even for items that are on sale, it is possible that an adjustment was made to the retail price that gave the customer a better offer. Since some offers can be applied to the sale price and some only to the retail price, this setting provides the required value.

Returns:

true if this adjustment was applied to the sale price

setAppliedToSalePrice

void setAppliedToSalePrice(boolean appliedToSalePrice)

getRetailPriceValue

Money getRetailPriceValue()

Value of this adjustment relative to the retail price.

Returns:

setRetailPriceValue

void setRetailPriceValue(Money retailPriceValue)

getSalesPriceValue

Money getSalesPriceValue()

Value of this adjustment relative to the sale price.

Returns:

setSalesPriceValue

void setSalesPriceValue(Money salesPriceValue)

isFutureCredit

boolean isFutureCredit()

Future credit means that the associated adjustment will be discounted at a later time to the customer via a credit. It is up to the implementor to decide how to achieve this. This field is used to determine if the adjustment originated from an offer marked as FUTURE_CREDIT. See Offer.getAdjustmentType() for more info

Returns:

setFutureCredit

void setFutureCredit(boolean futureCredit)

Future credit means that the associated adjustment will be discounted at a later time to the customer via a credit. It is up to the implementor to decide how to achieve this. This field is used to determine if the adjustment originated from an offer marked as FUTURE_CREDIT. See Offer.getAdjustmentType() for more info

Parameters:

futureCredit -