org.broadleafcommerce.common.sitemap.service.SiteMapGenerationResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of broadleaf-common Show documentation

A collection of classes shared by broadleaf profile, cms, admin, and core.

There is a newer version: 3.1.15-GA

/*
 * #%L
 * BroadleafCommerce Common Libraries
 * %%
 * 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.common.sitemap.service;

import java.util.ArrayList;
import java.util.List;

/**
 * Represents the outcome of a SiteMap generation request.   Can be extended for specific domain objectives but 
 * generally provides the directory location where the SiteMap request is stored.
 * 
 * @author bpolster
 */
public class SiteMapGenerationResponse {

    private String sitemapIndexFileName = "sitemap.xml";
    private List siteMapFilePaths = new ArrayList();
    private boolean hasError = false;
    private String errorCode;

    /**
     * Returns the name of the main SiteMap index file.
     * @return
     */
    public String getSitemapIndexFileName() {
        return sitemapIndexFileName;
    }

    /**
     * Sets the name of the main index file.
     * @param sitemapIndexFileName
     */
    public void setSitemapIndexFileName(String sitemapIndexFileName) {
        this.sitemapIndexFileName = sitemapIndexFileName;
    }

    /**
     * List of files representing the siteMap files.   The default Broadleaf generator will always create 
     * a SiteMap index file with at least one additional Sitemap file.   
     * 
     * @return
     */
    public List getSiteMapFilePaths() {
        return siteMapFilePaths;
    }

    /**
     * Sets the individual sitemap files.
     * @param siteMapFilePaths
     */
    public void setSiteMapFilePaths(List siteMapFilePaths) {
        this.siteMapFilePaths = siteMapFilePaths;
    }

    /**
     * Returns true if the sitemap generation process resulted in an error.
     * @return
     */
    public boolean isHasError() {
        return hasError;
    }

    /**
     * Sets that this response represents an error when generating the SiteMap.
     * @return
     */

    public void setHasError(boolean hasError) {
        this.hasError = hasError;
    }

    /**
     * Returns a code representing the error.   Undefined if called in the context of a response with no error.
     * @return
     */
    public String getErrorCode() {
        return errorCode;
    }

    /**
     * Sets the error code associated with this SiteMap Generation.
     * @param errorCode
     */
    public void setErrorCode(String errorCode) {
        this.errorCode = errorCode;
    }
}