org.broadleafcommerce.core.offer.domain.Offer Maven / Gradle / Ivy
/*
* Copyright 2008-2012 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.broadleafcommerce.core.offer.domain;
import org.broadleafcommerce.common.money.Money;
import org.broadleafcommerce.core.offer.service.type.OfferDeliveryType;
import org.broadleafcommerce.core.offer.service.type.OfferDiscountType;
import org.broadleafcommerce.core.offer.service.type.OfferItemRestrictionRuleType;
import org.broadleafcommerce.core.offer.service.type.OfferType;
import java.io.Serializable;
import java.math.BigDecimal;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.Set;
public interface Offer extends Serializable {
public void setId(Long id);
public Long getId();
public String getName();
public void setName(String name);
public String getDescription();
public void setDescription(String description);
public OfferType getType();
public void setType(OfferType offerType);
public OfferDiscountType getDiscountType();
public void setDiscountType(OfferDiscountType type);
public BigDecimal getValue();
public void setValue(BigDecimal value);
public int getPriority();
public void setPriority(int priority);
public Date getStartDate();
public void setStartDate(Date startDate);
public Date getEndDate();
public void setEndDate(Date endDate);
/**
* @deprecated
* Use isCombinable instead.
* @return
*/
@Deprecated
public boolean isStackable();
/**
* @deprecated
* calls {@link #setCombinableWithOtherOffers(boolean)}
* @param stackable
*/
@Deprecated
public void setStackable(boolean stackable);
public String getTargetSystem();
public void setTargetSystem(String targetSystem);
public boolean getApplyDiscountToSalePrice();
public void setApplyDiscountToSalePrice(boolean applyToSalePrice);
@Deprecated
public String getAppliesToOrderRules();
@Deprecated
public void setAppliesToOrderRules(String appliesToRules);
@Deprecated
public String getAppliesToCustomerRules();
@Deprecated
public void setAppliesToCustomerRules(String appliesToCustomerRules);
@Deprecated
public boolean isApplyDiscountToMarkedItems();
@Deprecated
public void setApplyDiscountToMarkedItems(boolean applyDiscountToMarkedItems);
public OfferItemRestrictionRuleType getOfferItemQualifierRuleType();
public void setOfferItemQualifierRuleType(OfferItemRestrictionRuleType restrictionRuleType);
public OfferItemRestrictionRuleType getOfferItemTargetRuleType();
public void setOfferItemTargetRuleType(OfferItemRestrictionRuleType restrictionRuleType);
/**
* Returns false if this offer is not combinable with other offers of the same type.
* For example, if this is an Item offer it could be combined with other Order or FG offers
* but it cannot be combined with other Item offers.
*
* @return
*/
public boolean isCombinableWithOtherOffers();
public void setCombinableWithOtherOffers(boolean combinableWithOtherOffers);
public OfferDeliveryType getDeliveryType();
public void setDeliveryType(OfferDeliveryType deliveryType);
/**
* Returns the maximum number of times that this offer
* can be used by the same customer. This field
* tracks the number of times the offer can be used
* and not how many times it is applied.
*
* 0 or null indicates unlimited usage per customer.
*
* @return
*/
public Long getMaxUsesPerCustomer();
/**
* Sets the maximum number of times that this offer
* can be used by the same customer. Intended as a transient
* field that gets derived from the other persisted max uses fields
* including maxUsesPerOrder and maxUsesPerCustomer.
*
* 0 or null indicates unlimited usage.
*
* @param maxUses
*/
public void setMaxUsesPerCustomer(Long maxUses);
/**
* Indicates that there is no limit to how many times a customer can use this offer. By default this is true if
* {@link #getMaxUsesPerCustomer()} == 0
*/
public boolean isUnlimitedUsePerCustomer();
/**
* Whether or not this offer has limited use in an order. By default this is true if {@link #getMaxUsesPerCustomer()} > 0
*/
public boolean isLimitedUsePerCustomer();
/**
* Returns the maximum number of times that this offer
* can be used in the current order.
*
* 0 indicates unlimited usage.
*
* @deprecated use {@link #getMaxUsesPerOrder()} directly instead
*/
@Deprecated
public int getMaxUses();
/**
* Sets the maximum number of times that this offer
* can be used in the current order.
*
* 0 indicates unlimited usage.
*
* @deprecated use {@link #setMaxUsesPerOrder(int)} directly instead
*/
@Deprecated
public void setMaxUses(int maxUses) ;
/**
* Returns the maximum number of times that this offer
* can be used in the current order.
*
* 0 indicates unlimited usage.
*/
public int getMaxUsesPerOrder();
/**
* Sets the maximum number of times that this offer
* can be used in the current order.
*
* 0 indicates unlimited usage.
*
* @param maxUses
*/
public void setMaxUsesPerOrder(int maxUsesPerOrder);
/**
* Indicates that there is no limit to how many times this offer can be applied to the order. By default this is true if
* {@link #getMaxUsesPerOrder()} == 0
*/
public boolean isUnlimitedUsePerOrder();
/**
* Whether or not this offer has limited use in an order. By default this is true if {@link #getMaxUsesPerOrder()} > 0
*/
public boolean isLimitedUsePerOrder();
/**
* @deprecated replaced by the {@link OfferAudit} table
*/
@Deprecated
public int getUses() ;
/**
* @deprecated replaced by the {@link OfferAudit} table
*/
@Deprecated
public void setUses(int uses) ;
public Set getQualifyingItemCriteria();
public void setQualifyingItemCriteria(Set qualifyingItemCriteria);
public Set getTargetItemCriteria();
public void setTargetItemCriteria(Set targetItemCriteria);
public Boolean isTotalitarianOffer();
public void setTotalitarianOffer(Boolean totalitarianOffer);
public Map getOfferMatchRules();
public void setOfferMatchRules(Map offerMatchRules);
public Boolean getTreatAsNewFormat();
public void setTreatAsNewFormat(Boolean treatAsNewFormat);
/**
* Indicates the amount of items that must be purchased for this offer to
* be considered for this order.
*
* The system will find all qualifying items for the given offer and sum their prices before
* any discounts are applied to make the determination.
*
* If the sum of the qualifying items is not greater than this value the offer is
* not considered by the offer processing algorithm.
* @return
*/
public Money getQualifyingItemSubTotal();
public void setQualifyingItemSubTotal(Money qualifyingItemSubtotal);
void setMarketingMessage(String marketingMessage);
String getMarketingMessage();
}