org.broadleafcommerce.common.sitemap.service

Class SiteMapGenerationResponse

java.lang.Object

org.broadleafcommerce.common.sitemap.service.SiteMapGenerationResponse

public class SiteMapGenerationResponse
extends Object

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

Constructor Summary

Constructors

Constructor and Description
SiteMapGenerationResponse()

Method Summary

Methods

Modifier and Type	Method and Description
String	getErrorCode() Returns a code representing the error.
List<String>	getSiteMapFilePaths() List of files representing the siteMap files.
String	getSitemapIndexFileName() Returns the name of the main SiteMap index file.
boolean	isHasError() Returns true if the sitemap generation process resulted in an error.
void	setErrorCode(String errorCode) Sets the error code associated with this SiteMap Generation.
void	setHasError(boolean hasError) Sets that this response represents an error when generating the SiteMap.
void	setSiteMapFilePaths(List<String> siteMapFilePaths) Sets the individual sitemap files.
void	setSitemapIndexFileName(String sitemapIndexFileName) Sets the name of the main index file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SiteMapGenerationResponse

public SiteMapGenerationResponse()

Method Detail

getSitemapIndexFileName

public String getSitemapIndexFileName()

Returns the name of the main SiteMap index file.

Returns:

setSitemapIndexFileName

public void setSitemapIndexFileName(String sitemapIndexFileName)

Sets the name of the main index file.

Parameters:

sitemapIndexFileName -

getSiteMapFilePaths

public List<String> getSiteMapFilePaths()

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.

Returns:

setSiteMapFilePaths

public void setSiteMapFilePaths(List<String> siteMapFilePaths)

Sets the individual sitemap files.

Parameters:

siteMapFilePaths -

isHasError

public boolean isHasError()

Returns true if the sitemap generation process resulted in an error.

Returns:

setHasError

public void setHasError(boolean hasError)

Sets that this response represents an error when generating the SiteMap.

getErrorCode

public String getErrorCode()

Returns a code representing the error. Undefined if called in the context of a response with no error.

Returns:

setErrorCode

public void setErrorCode(String errorCode)

Sets the error code associated with this SiteMap Generation.

Parameters:

errorCode -