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.core.inventory.service.type.InventoryType;
import org.broadleafcommerce.core.media.domain.Media;
import org.broadleafcommerce.core.order.service.type.FulfillmentType;
import org.broadleafcommerce.core.search.domain.CategorySearchFacet;
import org.broadleafcommerce.core.search.domain.SearchFacet;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.io.Serializable;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
* Implementations of this interface are used to hold data about a Category. A category is a group of products.
*
*
* You should implement this class if you want to make significant changes to how the
* Category is persisted. If you just want to add additional fields then you should extend {@link CategoryImpl}.
*
* @see {@link CategoryImpl}
* @author btaylor
* @author Jeff Fischer
*
*/
public interface Category extends Serializable {
/**
* Gets the primary key.
*
* @return the primary key
*/
@Nullable
public Long getId();
/**
* Sets the primary key.
*
* @param id the new primary key
*/
public void setId(@Nullable Long id);
/**
* Gets the name.
*
* @return the name
*/
@Nonnull
public String getName();
/**
* Sets the name.
*
* @param name the new name
*/
public void setName(@Nonnull String name);
/**
* Gets the default parent category.
*
* @return the default parent category
*/
@Nullable
public Category getDefaultParentCategory();
/**
* Sets the default parent category.
*
* @param defaultParentCategory the new default parent category
*/
public void setDefaultParentCategory(@Nullable Category defaultParentCategory);
/**
* Retrieve all parent categories
*
* @return the list of parent categories
*/
@Nonnull
public List getAllParentCategories();
/**
* Sets the list of parent categories
*
* @param allParentCategories the list of parent categories
*/
public void setAllParentCategories(@Nonnull List allParentCategories);
/**
* Gets the url. The url represents the presentation layer destination for
* this category. For example, if using Spring MVC, you could send the user
* to this destination by returning {@code "redirect:"+currentCategory.getUrl();}
* from a controller.
*
* @return the url for the presentation layer component for this category
*/
@Nullable
public String getUrl();
/**
* Sets the url. The url represents the presentation layer destination for
* this category. For example, if using Spring MVC, you could send the user
* to this destination by returning {@code "redirect:"+currentCategory.getUrl();}
* from a controller.
*
* @param url the new url for the presentation layer component for this category
*/
public void setUrl(@Nullable String url);
/**
* Gets the url key. The url key is used as part of SEO url generation for this
* category. Each segment of the url leading to a category is comprised of the url
* keys of the various associated categories in a hierarchy leading to this one. If
* the url key is null, the the name for the category formatted with dashes for spaces.
*
* @return the url key for this category to appear in the SEO url
*/
@Nullable
public String getUrlKey();
/**
* Creates the SEO url starting from this category and recursing up the
* hierarchy of default parent categories until the topmost category is
* reached. The url key for each category is used for each segment
* of the SEO url.
*
* @return the generated SEO url for this category
*/
@Nullable
public String getGeneratedUrl();
/**
* Sets the url key. The url key is used as part of SEO url generation for this
* category. Each segment of the url leading to a category is comprised of the url
* keys of the various associated categories in a hierarchy leading to this one.
*
* @param urlKey the new url key for this category to appear in the SEO url
*/
public void setUrlKey(@Nullable String urlKey);
/**
* Gets the description.
*
* @return the description
*/
@Nullable
public String getDescription();
/**
* Sets the description.
*
* @param description the new description
*/
public void setDescription(@Nullable String description);
/**
* Gets the active start date. If the current date is before activeStartDate,
* then this category will not be visible on the site.
*
* @return the active start date
*/
@Nullable
public Date getActiveStartDate();
/**
* Sets the active start date. If the current date is before activeStartDate,
* then this category will not be visible on the site.
*
* @param activeStartDate the new active start date
*/
public void setActiveStartDate(@Nullable Date activeStartDate);
/**
* Gets the active end date. If the current date is after activeEndDate,
* the this category will not be visible on the site.
*
* @return the active end date
*/
@Nullable
public Date getActiveEndDate();
/**
* Sets the active end date. If the current date is after activeEndDate,
* the this category will not be visible on the site.
*
* @param activeEndDate the new active end date
*/
public void setActiveEndDate(@Nullable Date activeEndDate);
/**
* Checks if is active. Returns true if the startDate is null or if the current
* date is after the start date, or if the endDate is null or if the current date
* is before the endDate.
*
* @return true, if is active
*/
public boolean isActive();
/**
* Gets the display template. The display template can be used to help create a unique key
* that drives the presentation layer destination for this category. For example, if
* using Spring MVC, you might derive the view destination in this way:
*
* {@code view = categoryTemplatePrefix + currentCategory.getDisplayTemplate();}
*
* @return the display template
*/
@Nullable
public String getDisplayTemplate();
/**
* Sets the display template. The display template can be used to help create a unique key
* that drives the presentation layer destination for this category. For example, if
* using Spring MVC, you might derive the view destination in this way:
*
* {@code view = categoryTemplatePrefix + currentCategory.getDisplayTemplate();}
*
* @param displayTemplate the new display template
*/
public void setDisplayTemplate(@Nullable String displayTemplate);
/**
* Gets the child category url map. This map is keyed off of the {@link #getGeneratedUrl()} values
* for this category and all of its child categories. By calling get on this map using the
* generated url for a given category, you will receive the list of immediate child categories.
* This lifecycle for this map is maintained via the {@code HydratedCacheJPAListener}. This listener
* keeps this map in a separate cache from the normal Hibernate level 2 cache, but will honor
* cache region settings for this entity, resulting in this map being evicted from its cache
* when this entity is removed from the Hibernate level 2 cache.
*
* @see org.broadleafcommerce.common.cache.HydratedSetup
* @return the child category url map
*/
@Nonnull
public Map> getChildCategoryURLMap();
/**
* Included to support the {@code HydratedCacheJPAListener}
*
* @see org.broadleafcommerce.common.cache.HydratedSetup
* @param childCategoryURLMap
*/
public void setChildCategoryURLMap(@Nonnull Map> childCategoryURLMap);
/**
* Gets the child categories. This list includes all categories, regardless
* of whether or not they are active.
*
* @return the list of active and inactive child categories.
*/
@Nonnull
public List getAllChildCategories();
/**
* Checks for child categories.
*
* @return true, if this category has any children (active or not)
*/
public boolean hasAllChildCategories();
/**
* Sets the list of child categories (active and inactive)
*
* @param childCategories the list of child categories
*/
public void setAllChildCategories(@Nonnull List childCategories);
/**
* Gets the child categories. If child categories has not been previously
* set, then the list of active only categories will be returned.
*
* @return the list of active child categories
*/
@Nonnull
public List getChildCategories();
/**
* Checks for child categories.
*
* @return true, if this category contains any active child categories.
*/
public boolean hasChildCategories();
/**
* Sets the all child categories. This should be a list
* of active only child categories.
*
* @param childCategories the list of active child categories.
*/
public void setChildCategories(@Nonnull List childCategories);
/**
* Gets the category images.
* @deprecated replaced by {@link #getCategoryMedia()}
*
* @return the category images
*/
@Deprecated
@Nonnull
public Map getCategoryImages();
/**
* Gets the category image.
* @deprecated replaced by {@link #getCategoryMedia()}
*
* @param imageKey the image key
* @return the category image
*/
@Deprecated
@Nullable
public String getCategoryImage(@Nonnull String imageKey);
/**
* Sets the category images.
* @deprecated replaced by {@link #setCategoryMedia(java.util.Map)}
*
* @param categoryImages the category images
*/
@Deprecated
public void setCategoryImages(@Nonnull Map categoryImages);
/**
* Gets the category media map. The key is of arbitrary meaning
* and the {@code Media} instance stores information about the
* media itself (image url, etc...)
*
* @return the category Media
*/
@Nonnull
public Map getCategoryMedia() ;
/**
* Sets the category media. The key is of arbitrary meaning
* and the {@code Media} instance stores information about the
* media itself (image url, etc...)
*
* @param categoryMedia the category media
*/
public void setCategoryMedia(@Nonnull Map categoryMedia);
/**
* Gets the long description.
*
* @return the long description
*/
@Nullable
public String getLongDescription();
/**
* Sets the long description.
*
* @param longDescription the new long description
*/
public void setLongDescription(@Nullable String longDescription);
/**
* Gets the featured products. Featured products are a special list
* of products you would like to showcase for this category.
*
* @return the featured products
*/
@Nonnull
public List getFeaturedProducts();
/**
* Sets the featured products. Featured products are a special list
* of products you would like to showcase for this category.
*
* @param featuredProducts the featured products
*/
public void setFeaturedProducts(@Nonnull List featuredProducts);
/**
* Convenience method to retrieve all of this {@link Category}'s {@link Product}s filtered by
* active. If you want all of the {@link Product}s (whether inactive or not) consider using
* {@link #getAllProducts()}.
*
* @return the list of active {@link Product}s for this {@link Category}
* @see {@link Product#isActive()}
*/
public List getActiveProducts();
/**
* Retrieve all the {@code Product} instances associated with this
* category.
*
* Note: this method does not take into account whether or not the {@link Product}s are active or not. If
* you need this functionality, use {@link #getActiveProducts()}
* @return the list of products associated with this category.
*/
@Nonnull
public List getAllProducts();
/**
* Set all the {@code Product} instances associated with this
* category.
*
* @param allProducts the list of products to associate with this category
*/
public void setAllProducts(@Nonnull List allProducts);
/**
* Returns a list of cross sale products that are related to this category.
*
* @return a list of cross sale products
*/
public List getCrossSaleProducts();
/**
* Sets the cross sale products that are related to this category.
*
* @see #getCrossSaleProducts()
* @param crossSaleProducts
*/
public void setCrossSaleProducts(List crossSaleProducts);
/**
* Returns a list of cross sale products that are related to this category.
*
* @return a list of cross sale products
*/
public List getUpSaleProducts();
/**
* Sets the upsale products that are related to this category.
*
* @see #getUpSaleProducts()
* @param upSaleProducts
*/
public void setUpSaleProducts(List upSaleProducts);
/**
* Returns a list of the cross sale products in this category as well as
* all cross sale products in all parent categories of this category.
*
* @return the cumulative cross sale products
*/
public List getCumulativeCrossSaleProducts();
/**
* Returns a list of the upsale products in this category as well as
* all upsale products in all parent categories of this category.
*
* @return the cumulative upsale products
*/
public List getCumulativeUpSaleProducts();
/**
* Returns a list of the featured products in this category as well as
* all featured products in all parent categories of this category.
*
* @return the cumulative featured products
*/
public List getCumulativeFeaturedProducts();
/**
* Returns all of the SearchFacets that are directly associated with this Category
*
* @return related SearchFacets
*/
public List getSearchFacets();
/**
* Sets the SearchFacets that are directly associated with this Category
*
* @param searchFacets
*/
public void setSearchFacets(List searchFacets);
/**
* Sets the SearchFacets that should not be rendered by this Category. Typically, this will include
* facets from parent categories that do not apply to this category.
*
* @param excludedSearchFacets
*/
public void setExcludedSearchFacets(List excludedSearchFacets);
/**
* Gets the excluded SearchFacets
* @return the excluded SearchFacets
*/
public List getExcludedSearchFacets();
/**
* Returns a list of CategorySearchFacets that takes into consideration the search facets for this Category,
* the search facets for all parent categories, and the search facets that should be excluded from this
* Category. This method will order the resulting list based on the {@link CategorySearchFacet#getPosition()}
* method for each category level. That is, the facets on this Category will be ordered by their position
* relative to each other with the ordered parent facets after that, etc.
*
* @return the current active search facets for this category and all parent categories
*/
public List getCumulativeSearchFacets();
/**
* Build category hierarchy by walking the default category tree up to the root category.
* If the passed in tree is null then create the initial list.
*
* @param currentHierarchy
* @return
*/
public List buildCategoryHierarchy(List currentHierarchy);
/**
* Build the full category hierarchy by walking up the default category tree and the all parent
* category tree.
*
* @param currentHierarchy
* @return the full hierarchy
*/
public List buildFullCategoryHierarchy(List currentHierarchy);
/**
* Gets the attributes for this {@link Category}. In smaller sites, using these attributes might be preferred to
* extending the domain object itself.
*
* @return
* @see {@link #getMappedCategoryAttributes()}
*/
public List getCategoryAttributes();
/**
* Sets the attributes for this {@link Category}. In smaller sites, using these attributes might be preferred to
* extending the domain object and creating a new table to store custom properties.
*
* @return
*/
public void setCategoryAttributes(List categoryAttributes);
/**
* Convenience method to get a {@link CategoryAttribute} by name
*
* @param name
* @return
* @see {@link #getCategoryAttributes()}, {@link #getMappedCategoryAttributes()}
*/
public CategoryAttribute getCategoryAttributeByName(String name);
/**
* Convenience method to return the {@link CategoryAttribute}s for the {@link Category} in an easily-consumable
* form
*
* @return
*/
public Map getMappedCategoryAttributes();
/**
* Returns the type of inventory for this category
* @return the {@link InventoryType} for this category
*/
public InventoryType getInventoryType();
/**
* Sets the type of inventory for this category
* @param inventoryType the {@link InventoryType} for this category
*/
public void setInventoryType(InventoryType inventoryType);
/**
* Returns the default fulfillment type for skus in this category. May be null.
* @return
*/
public FulfillmentType getFulfillmentType();
/**
* Sets the default fulfillment type for skus in this category. May return null.
* @param fulfillmentType
*/
public void setFulfillmentType(FulfillmentType fulfillmentType);
}
