Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* 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.catalog.domain;
import org.broadleafcommerce.common.vendor.service.type.ContainerShapeType;
import org.broadleafcommerce.common.vendor.service.type.ContainerSizeType;
import org.broadleafcommerce.core.media.domain.Media;
import javax.annotation.Nullable;
import java.io.Serializable;
import java.math.BigDecimal;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
* Implementations of this interface are used to hold data for a Product. A product is a general description
* of an item that can be sold (for example: a hat). Products are not sold or added to a cart. {@link Sku}s
* which are specific items (for example: a XL Blue Hat) are sold or added to a cart.
*
*
* You should implement this class if you want to make significant changes to how the
* Product is persisted. If you just want to add additional fields then you should extend {@link ProductImpl}.
*
* @author btaylor
* @see {@link ProductImpl},{@link Sku}, {@link Category}
*/
public interface Product extends Serializable {
/**
* The id of the Product.
*
* @return the id of the Product
*/
public Long getId();
/**
* Sets the id of the Product.
*
* @param id - the id of the product
*/
public void setId(Long id);
/**
* Returns the name of the product that is used for display purposes.
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @return the name of the product
*/
public String getName();
/**
* Sets the name of the product that is used for display purposes.
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @param name - the name of the Product
*/
public void setName(String name);
/**
* Returns a brief description of the product that is used for display.
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @return a brief description of the product
*/
public String getDescription();
/**
* Sets a brief description of the product that is used for display.
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @param description - a brief description of the product
*/
public void setDescription(String description);
/**
* Returns a long description of the product that is used for display.
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @return a long description of the product
*/
public String getLongDescription();
/**
* Sets a long description of the product that is used for display.
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @param longDescription the long description
*/
public void setLongDescription(String longDescription);
/**
* Returns the first date a product will be available that is used to determine whether
* to display the product.
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @return the first date the product will be available
*/
public Date getActiveStartDate();
/**
* Sets the first date a product will be available that is used to determine whether
* to display the product.
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @param activeStartDate - the first day the product is available
*/
public void setActiveStartDate(Date activeStartDate);
/**
* Returns the last date a product will be available that is used to determine whether
* to display the product.
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @return the last day the product is available
*/
public Date getActiveEndDate();
/**
* Sets the last date a product will be available that is used to determine whether
* to display the product.
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @param activeEndDate - the last day the product is available
*/
public void setActiveEndDate(Date activeEndDate);
/**
* Returns a boolean that indicates if the product is currently active.
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @return a boolean indicates if the product is active.
*/
public boolean isActive();
/**
* Gets the default {@link Sku} associated with this Product. A Product is
* required to have a default Sku which holds specific information about the Product
* like weight, dimensions, price, etc. Many of the Product attributes that
* have getters and setters on Product are actually pass-through to the default Sku.
*
*
* Products can also have multiple Skus associated with it that are represented by
* {@link ProductOption}s. For instance, a large, blue shirt. For more information on
* that relationship see {@link #getAdditionalSkus()}.
*
* @return the default Sku for this Product
*/
public Sku getDefaultSku();
/**
* Sets the default Sku for this Product
*
*
* Note: this operation is cascaded with CascadeType.ALL which saves from having to persist the Product
* in 2 operations: first persist the Sku and then take the merged Sku, set it as this Product's default
* Sku, and then persist this Product.
*
* @param defaultSku - the Sku that should be the default for this Product
*/
public void setDefaultSku(Sku defaultSku);
/**
* @return whether or not the default sku can be used for a multi-sku product in the case that no
* product options are set. Defaults to false if not specified. Note that this only affects multi-sku
* products.
*/
public Boolean getCanSellWithoutOptions();
/**
* Sets whether or not the default sku can be sold in the case that no product options are specified. Note
* that this only affects multi-sku products.
*
* @param canSellWithoutOptions
*/
public void setCanSellWithoutOptions(Boolean canSellWithoutOptions);
/**
* Returns a list of {@link Sku}s filtered by whether the Skus are active or not.
* This list does not contain the {@link #getDefaultSku()} and filters by {@link Sku#isActive()}.
*
* @return a list of active Skus from {@link #getAdditionalSkus()} for this Product
*/
public List getSkus();
/**
* Gets all the additional Skus associated with this Product. For instance, if this
* Product represented a T-shirt and you could pick the size of the T-shirt as a
* {@link ProductOption} (like "small", "medium", "large") this would return 3 Skus
* if you had different inventory or price constraints on each {@link ProductOptionValue}.
*
*
* This list does not take into account whether any of these additional Skus are active or not, nor
* does it contain the {@link #getDefaultSku()} for this Product. For this functionality, see
* {@link #getSkus()} and {@link #getAllSkus()}, respectively.
*
* @return the additional Skus for this Product
* @see {@link ProductOption}, {@link ProductOptionValue}
*/
public List getAdditionalSkus();
/**
* Sets the additional Skus associated to this Product. These additional Skus should
* come from {@link ProductOptionValue}s and are used in instance where you need to track inventory
* or change pricing on a per-option value basis.
*
* @param skus - a List of {@link Sku}s to associate with this Product, usually based off of {@link ProductOption}s
* @see {@link #getAdditionalSkus()}, {@link ProductOption}, {@link ProductOptionValue}
*/
public void setAdditionalSkus(List skus);
/**
* Returns all the {@link Sku}s that are associated with this Product (including {@link #getDefaultSku()})
* regardless of whether or not the {@link Sku}s are active or not
*
*
* Note: in the event that the default Sku was added to the list of {@link #getAdditionalSkus()}, it is filtered out
* so that only a single instance of {@link #getDefaultSku()} is contained in the resulting list
*
* @return all the Skus associated to this Product
*/
public List getAllSkus();
/**
* Gets the media for this product. This serves as a pass-through to
* the {@link getDefaultSku()} media
*
* @return the Media for the default Sku associated with this Product
* @see Sku
*/
public Map getMedia();
/**
* Gets the media for this product. This serves as a pass-through to
* the {@link getDefaultSku()} media
*
* @param media Media map to set on the default Sku associated with this Product
* @see Sku
*/
public void setMedia(Map media);
/**
* Convenience method for returning all of the media associated with this Product by adding
* all the media in {@link #getDefaultSku()} as well as all the media in the Skus represented by
* {@link #getAdditionalSkus()}
*
* @return all of the Media for all of the Skus for this Product
*/
public Map getAllSkuMedia();
/**
* Returns all parent {@link Category}(s) this product is associated with.
*
* @return the all parent categories for this product
*/
public List getAllParentCategories();
/**
* Sets all parent {@link Category}s this product is associated with.
*
* @param allParentCategories - a List of all parent {@link Category}(s) to associate this product with
*/
public void setAllParentCategories(List allParentCategories);
/**
* Returns the default {@link Category} this product is associated with.
*
*/
public Category getDefaultCategory();
/**
* Sets the default {@link Category} to associate this product with.
*
* @param defaultCategory - the default {@link Category} to associate this product with
*/
public void setDefaultCategory(Category defaultCategory);
/**
* Returns the model number of the product
* @return the model number
*/
public String getModel();
/**
* Sets the model number of the product
* @param model
*/
public void setModel(String model);
/**
* Returns the manufacture name for this product
* @return the manufacture name
*/
public String getManufacturer();
/**
* Sets the manufacture for this product
* @param manufacturer
*/
public void setManufacturer(String manufacturer);
/**
* Returns the {@link Dimension} for this product
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @return a ProductDimensions object
*
*/
public Dimension getDimension();
/**
* Sets the {@link Dimension} for this product
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @param dimension
*
*/
public void setDimension(Dimension dimension);
/**
* Returns the dimension width
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @return width dimension of the product
*
*/
public BigDecimal getWidth();
/**
* Sets the dimension width
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @param width
*
*/
public void setWidth(BigDecimal width);
/**
* Returns the dimension height
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @return height dimension of the product
*
*/
public BigDecimal getHeight();
/**
* Sets the dimension height
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @param height
*
*/
public void setHeight(BigDecimal height);
/**
* Returns the dimension depth
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @return width depth of the product
*
*/
public BigDecimal getDepth();
/**
* Sets the dimension depth
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @param depth
*/
public void setDepth(BigDecimal depth);
/**
* Gets the dimension girth
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @return the dimension girth
*/
public BigDecimal getGirth();
/**
* Sets the dimension girth
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @param girth
*/
public void setGirth(BigDecimal girth);
/**
* Returns the dimension container size
*
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @return dimension container size
*/
public ContainerSizeType getSize();
/**
* Sets the dimension container size
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @param size
*/
public void setSize(ContainerSizeType size);
/**
* Gets the dimension container shape
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @return dimension container shape
*/
public ContainerShapeType getContainer();
/**
* Sets the dimension container shape
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @param container
*/
public void setContainer(ContainerShapeType container);
/**
* Returns a String representation of the dimension
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @return a dimension String
*/
public String getDimensionString();
/**
* Returns the weight of the product
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @return weight of product
*/
public Weight getWeight();
/**
* Sets the product weight
*
*
* Note: this is a convenience method that merely serves as
* a pass-through to the same method via {@link getDefaultSku()}
*
* @param weight
*/
public void setWeight(Weight weight);
/**
* Returns a List of this product's related Cross Sales
* @return
*/
public List getCrossSaleProducts();
/**
* Sets the related Cross Sales
* @param crossSaleProducts
*/
public void setCrossSaleProducts(List crossSaleProducts);
/**
* Returns a List of this product's related Up Sales
* @return
*/
public List getUpSaleProducts();
/**
* Sets the related Up Sales
* @param upSaleProducts
*/
public void setUpSaleProducts(List upSaleProducts);
/**
* Returns whether or not the product is featured
* @return isFeaturedProduct as Boolean
*/
public boolean isFeaturedProduct();
/**
* Sets whether or not the product is featured
* @param isFeaturedProduct
*/
public void setFeaturedProduct(boolean isFeaturedProduct);
/**
* Generic key-value pair of attributes to associate to this Product for maximum
* extensibility.
*
* @return the attributes for this Product
*/
public List getProductAttributes();
/**
* Sets a generic list of key-value pairs for Product
* @param productAttributes
*/
public void setProductAttributes(List productAttributes);
/**
* Gets the promotional message for this Product. For instance, this could be a limited-time
* Product
*
* @return the Product's promotional message
*/
public String getPromoMessage();
/**
* Sets the promotional message for this Product
*
* @param promoMessage
*/
public void setPromoMessage(String promoMessage);
/**
* The available {@link ProductOption}s for this Product. For instance, if this
* Product is a T-Shirt, you might be able to specify a size and color. This would
* be modeled by 2 {@link ProductOption}s, each that could have multiple {@link ProductOptionValue}s
* (which could be "small" "medium" "large", "blue", "yellow", "green"). For specific pricing or
* inventory needs on a per-value basis, multiple Skus can be associated to this Product based
* off of the {@link ProductOptionValue}s
*
* @return the {@link ProductOption}s for this Product
* @see Product#getAdditionalSkus(), {@link ProductOption}, {@link ProductOptionValue}
*/
public List getProductOptions();
/**
* Sets the list of available ProductOptions for this Product
*
* @param productOptions
*/
public void setProductOptions(List productOptions);
/**
* A product can have a designated URL. When set, the ProductHandlerMapping will check for this
* URL and forward this user to the {@link #getDisplayTemplate()}.
*
* Alternatively, most sites will rely on the {@link Product#getGeneratedUrl()} to define the
* url for a product page.
*
* @see org.broadleafcommerce.core.web.catalog.ProductHandlerMapping
* @return
*/
public String getUrl();
/**
* Sets the URL that a customer could type in to reach this product.
*
* @param url
*/
public void setUrl(String url);
/**
* Sets a url-fragment. By default, the system will attempt to create a unique url-fragment for
* this product by taking the {@link Product.getName()} and removing special characters and replacing
* dashes with spaces.
*/
public String getUrlKey();
/**
* Sets a url-fragment to be used with this product. By default, the system will attempt to create a
* unique url-fragment for this product by taking the {@link Product.getName()} and removing special characters and replacing
* dashes with spaces.
*/
public void setUrlKey(String url);
/**
* Returns the name of a display template that is used to render this product. Most implementations have a default
* template for all products. This allows for the user to define a specific template to be used by this product.
*
* @return
*/
public String getDisplayTemplate();
/**
* Sets the name of a display template that is used to render this product. Most implementations have a default
* template for all products. This allows for the user to define a specific template to be used by this product.
* @param displayTemplate
*/
public void setDisplayTemplate(String displayTemplate);
/**
* Generates a URL that can be used to access the product.
* Builds the url by combining the url of the default category with the getUrlKey() of this product.
*/
public String getGeneratedUrl();
/**
* Looks at all ProductAttributes for this product and returns the attribute that matches the given name
*
* @param name the name of the attribute
* @return the matching ProductAttribute (null if no match)
*/
public ProductAttribute getProductAttributeByName(String name);
/**
* @return a Map of all the product attributes on this product keyed by the attribute name
*/
public Map getMappedProductAttributes();
/**
* Returns a list of the cross sale products for this product as well
* all cross sale products in all parent categories of this product.
*
* @return the cumulative cross sale products
*/
public List getCumulativeCrossSaleProducts();
/**
* Returns a list of the upsale products for this product as well as
* all upsale products in all parent categories of this product.
*
* @return the cumulative upsale products
*/
public List getCumulativeUpSaleProducts();
/**
* Removes any currently stored dynamic pricing
*/
public void clearDynamicPrices();
}
