org.broadleafcommerce.core.catalog.domain.CategorySiteMapGeneratorConfiguration Maven / Gradle / Ivy
/*
* #%L
* BroadleafCommerce Framework
* %%
* Copyright (C) 2009 - 2013 Broadleaf Commerce
* %%
* 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.
* #L%
*/
package org.broadleafcommerce.core.catalog.domain;
import org.broadleafcommerce.common.sitemap.domain.SiteMapGeneratorConfiguration;
/**
* CategorySiteMapGenerator is controlled by this configuration.
*
* @author Joshua Skorton (jskorton)
*/
public interface CategorySiteMapGeneratorConfiguration extends SiteMapGeneratorConfiguration {
/**
* Returns the root category.
*
* @return
*/
public Category getRootCategory();
/**
* Sets the root category.
*
* @param rootCategory
*/
public void setRootCategory(Category rootCategory);
/**
* Returns the starting depth.
*
* @return
*/
public int getStartingDepth();
/**
* Sets the starting depth.
*
* @param startingDepth
*/
public void setStartingDepth(int startingDepth);
/**
* Returns the ending depth.
*
* @return
*/
public int getEndingDepth();
/**
* Sets the ending depth.
*
* @param endingDepth
*/
public void setEndingDepth(int endingDepth);
}