com.elasticpath.domain.impl
Class ElasticPathImpl

java.lang.Object
  com.elasticpath.domain.impl.ElasticPathImpl

All Implemented Interfaces:

ElasticPath, org.springframework.context.ApplicationContextAware

public class ElasticPathImpl
extends java.lang.Object
implements ElasticPath, org.springframework.context.ApplicationContextAware

This class provides elastic path configurations and context to others.

Method Summary

void	clearAllAttributeRanges() Clears all attribute range information, including bottom level attribute ranges.
void	clearAllAttributeSimpleValues() Clears all attribute simple value information.
void	clearAllPriceRanges() Clears all price range information, including bottom level price ranges.
java.lang.String	get(java.lang.String name) Return the value of a string property with the specified name from the dyanamic property map.
java.lang.String	get(java.lang.String name, java.lang.String defaultValue) Return the value of a string property with the specified name.
float	getAccuracy() Returns the degree of similarity that a word must have to the original word in order to be suggested.
java.util.Map	getAll() Return name and values of all properties as a map.
java.util.Map	getAllAttributeRanges() Returns all defined attribute ranges as a Map.
java.util.Map	getAllAttributeSimpleValues() Returns all defined attribute simple value filters as a Map.
java.util.Map	getAllAttributesMap() This map contains all the attribute defined in the guided-navigation.xml.
java.util.Map	getAllCurrencies() Return all supported currencies.
java.util.Map	getAllLocales() Get a map of all supported locales.
java.util.Map	getAllPriceRanges() Returns all defined price ranges as a Map.
java.util.List	getAllShipmentCarriers() Return all supported shipment carrier.
java.util.SortedMap	getAttributeSimpleValuesMap(java.lang.String attributeCode) Returns attribute ranges of the given attributeCode, which are defined at bottom level of the attribute-range-tree.
java.lang.Object	getBean(java.lang.String name) Get the bean with the given id from spring ContextBeanFactory.
java.util.Map	getBoolMap() Returns a map used by Spring/Velocity for checkboxes.
java.util.SortedMap	getBottomLevelAttributeRanges(java.lang.String attributeCode) Returns attribute ranges of the given attributeCode, which are defined at bottom level of the attribute-range-tree.
java.util.SortedMap	getBottomLevelPriceRanges(java.util.Currency currency) Returns price ranges of the given currency, which are defined at bottom level of the price-range-tree.
java.lang.String	getCatalogAssetPath() Return the absolute asset directory path.
int	getCatalogViewPagination() Return the catalog view pagination.
CheckoutTransactionBehaviour	getCheckoutTransactionBehaviour() Return the CheckoutTransactionBehaviour object that defines how a checkout transaction is to be processed.
java.lang.String	getCmContextUrl() Return the commerce manager context URL.
java.lang.String	getContentEncoding() Returns the content encoding.
Geography	getCountries() Return a Geography that provides geographical information.
java.util.Map	getCustomerProfileAttributes() Returns a map of all customer profile attributes.
java.sql.DatabaseMetaData	getDatabaseMetaData() Return database meta data.
java.lang.String	getDatabaseProductName() Get the databse product name.
java.lang.String	getDataFileEncoding() Returns the data file encoding.
java.lang.String	getDefaultCountry() Returns the default country.
java.util.Currency	getDefaultCurrency() Returns the default currency.
java.text.SimpleDateFormat	getDefaultDateFormat() Returns the default date format.
java.util.Locale	getDefaultLocale() Return the system default locale.
PrototypeBeanFactory	getDomainBeanFactory() Returns PrototypeBeanFactory for domain objects.
java.lang.String	getEmailCmUrl() Return the URL of the Commerce Manager to be used only in email messages.
java.lang.String	getEmailStoreUrl() Return the URL of the store to be used only in email messages.
java.lang.String	getEpBuildNo() Returns the Elastic Path build number.
java.lang.String	getEpVersion() Returns the Elastic Path version number.
java.lang.String	getFileAssetPath() Return the file asset directory path.
java.lang.String	getFileAssetSubFolder() Return the file asset sub folder name.
Geography	getGeography() Return a Geography that provides geographical information.
java.lang.String	getImageAssetSubFolder() Return the image asset sub folder name.
java.lang.String	getImagePath() Return the absolute images directory path.
java.lang.String	getImageUrl() Return the image url.
static ElasticPath	getInstance() Return the singleton ElasticPath.
float	getJPEGQuality() Returns the jpeg quality to use when resizing a jpeg in the dynamic image resizing engine.
java.util.Map	getLocaleToLanguageMap() Get a map of supported locales mapped to their language names.
int	getMaximumSuggestions() Returns the maximum number of suggestions that will be returned with the search results.
int	getMaximumSuggestionsPerWord() Returns the maximum number of suggestions per word that will be generated when generating search suggestions.
int	getMaxReturnNumber() Returns the number of maximum results to return to the search client as the search result.
java.lang.String	getMessage(java.lang.String code, java.lang.Object[] args, java.lang.String defaultMessage, java.util.Locale locale) Gets the localized message.
java.lang.String	getMessageDefaultLocale(java.lang.String code, java.lang.Object[] args, java.lang.String defaultMessage) Gets the localized message.
int	getMinimumResultsThreshold() Returns the number of search results that, if not exceeded will trigger the generation of search suggestions.
float	getMinimumSimilarity() Returns the minimum similarity fuzzy search setting, value should be between 0 and 1.
java.lang.String	getNoImage() Returns the image to use when a catalog image does not exist.
PaymentGateway	getPaymentGateway(PaymentType paymentType) Get the payment gateway for the given payment type (e.g.
int	getPowerReviewsMerchantId() Returns the PowerReviews merchant id.
int	getPrefixLength() Returns the fuzzy search setting for the length of common non-fuzzy prefix.
java.util.Map	getPropertiesWithNameStartsWith(java.lang.String prefix) Return name and values of those properties starts with the given string.
java.lang.String	getSecureAssetPath() Return the absolute secure asset (digital goods) directory path.
java.lang.String	getSecureAssetSubFolder() Return the secure asset (digital goods) sub folder name.
java.lang.String	getSfContextUrl() Return the store front context URL.
int	getTopSellerCount() Returns the number of top seller products to display.
java.lang.String	getUnitsLength() Returns the unit measurement of length.
java.lang.String	getUnitsWeight() Returns the unit measurement of weight.
int	getUserIdMode() Return the mode to generate user Id.
int	getUserMaintainMode() Return the user maintenance mode.
Utility	getUtility() Returns the Utility instance.
org.springframework.web.context.WebApplicationContext	getWebApplicationContext() Return the web application context.
java.lang.String	getWebInfPath() Return the absolute WEB-INF directory path.
boolean	isAttributeFilterEnabled() check the attributeFilter is enabled.
boolean	isPowerReviewsEnabled() Returns true if PowerReviews has been enabled, otherwise, false.
boolean	isSeoEnabled() Returns true if SEO(Search Engine Optimization) has been enabled, otherwise, false.
void	setAccuracy(float accuracy) Sets the degree of similarity that a word must have to the original word in order to be suggested.
void	setApplicationContext(org.springframework.context.ApplicationContext context) Set the web application context.
void	setCheckoutTransactionBehaviour(CheckoutTransactionBehaviour behaviour) Sets the checkoutTransactionBehaviour that defines how a checkout transaction is processed.
void	setCustomerProfileAttributes(java.util.Map customerProfileAttributes) Sets the customer profile attribute map.
void	setDatabaseMetaData(java.sql.DatabaseMetaData databaseMetaData) Called in EPContextListener to set the DatabaseMetaData at the start up time.
void	setDomainBeanFactory(PrototypeBeanFactory domainBeanFactory) Sets PrototypeBeanFactory for domain objects.
void	setMaximumSuggestions(int suggestions) Sets the maximum number of suggestions that will be returned with the search results.
void	setMaximumSuggestionsPerWord(int maximumSuggestionsPerWord) Sets the maximum number of suggestions per word that will be generated when generating search suggestions.
void	setMaxReturnNumber(int number) Sets the number of maximum results to return to the search client as the search result.
void	setMinimumResultsThreshold(int minimumResultsThreshold) Sets the number of search results that, if not exceeded will trigger the generation of search suggestions.
void	setMinimumSimilarity(float minimumSimilarity) Sets the minimum similarity fuzzy search setting, value should be between 0 and 1.
void	setPaymentGatewayMap(java.util.Map paymentGatewayMap) Set the payment gateway map, keyed by the payment type (e.g.
void	setPrefixLength(int prefixLength) Sets fuzzy search setting for the length of common non-fuzzy prefix.
void	setProperties(java.util.Map properties) Set the properties.
void	setWebApplicationContext(org.springframework.web.context.WebApplicationContext context) Set the web application context.
void	setWebInfPath(java.lang.String webInfPath) Set the absolute path to the WEB-INF directory.

Methods inherited from class java.lang.Object

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

Method Detail

clearAllAttributeRanges

public void clearAllAttributeRanges()

Clears all attribute range information, including bottom level attribute ranges.

Specified by:

clearAllAttributeRanges in interface ElasticPath

clearAllAttributeSimpleValues

public void clearAllAttributeSimpleValues()

Clears all attribute simple value information.

Specified by:

clearAllAttributeSimpleValues in interface ElasticPath

clearAllPriceRanges

public void clearAllPriceRanges()

Clears all price range information, including bottom level price ranges.

Specified by:

clearAllPriceRanges in interface ElasticPath

get

public java.lang.String get(java.lang.String name)

Return the value of a string property with the specified name from the dyanamic property map.

Specified by:

get in interface ElasticPath

Parameters:

name - Name of the property whose value is to be retrieved

Returns:

the property value

get

public java.lang.String get(java.lang.String name,
                            java.lang.String defaultValue)

Return the value of a string property with the specified name.

Specified by:

get in interface ElasticPath

Parameters:

name - the property name to retrieve

defaultValue - the default value to return if the given property is not defined

Returns:

the value of the given property if it is defined, or the given default value it is not defined.

getAccuracy

public float getAccuracy()

Returns the degree of similarity that a word must have to the original word in order to be suggested.

Specified by:

getAccuracy in interface ElasticPath

Returns:

the similarity

getAll

public java.util.Map getAll()

Return name and values of all properties as a map.

Specified by:

getAll in interface ElasticPath

Returns:

a map contains all properties

getAllAttributeRanges

public java.util.Map getAllAttributeRanges()

Returns all defined attribute ranges as a Map.

The attribute code will be used as the map key .

And the value will be a AttributeRangeFilter.

Specified by:

getAllAttributeRanges in interface ElasticPath

Returns:

all defined attribute ranges as a Map.

getAllAttributeSimpleValues

public java.util.Map getAllAttributeSimpleValues()

Returns all defined attribute simple value filters as a Map.

The filter id will be used as the map key .

And the value will be a AttributeFilter.

Specified by:

getAllAttributeSimpleValues in interface ElasticPath

Returns:

all defined attribute filters as a Map.

getAllAttributesMap

public java.util.Map getAllAttributesMap()

This map contains all the attribute defined in the guided-navigation.xml. The key will be the attribute code, and the value will be the Attribute.

Specified by:

getAllAttributesMap in interface ElasticPath

Returns:

All the attributes.

getAllCurrencies

public java.util.Map getAllCurrencies()

Return all supported currencies.

Specified by:

getAllCurrencies in interface ElasticPath

Returns:

all supported currencies

getAllLocales

public java.util.Map getAllLocales()

Get a map of all supported locales.

Specified by:

getAllLocales in interface ElasticPath

Returns:

all supported locales as a map of locale code Strings to Locale object

getAllPriceRanges

public java.util.Map getAllPriceRanges()

Returns all defined price ranges as a Map.

The key will be like : "price-between-USD-90-and-100".

And the value will be a PriceFilter.

Specified by:

getAllPriceRanges in interface ElasticPath

Returns:

all defined price ranges as a Map.

getAllShipmentCarriers

public java.util.List getAllShipmentCarriers()

Return all supported shipment carrier.

Specified by:

getAllShipmentCarriers in interface ElasticPath

Returns:

all supported shipment carrier.

getAttributeSimpleValuesMap

public java.util.SortedMap getAttributeSimpleValuesMap(java.lang.String attributeCode)

Returns attribute ranges of the given attributeCode, which are defined at bottom level of the attribute-range-tree. This is a lookup map for a Product to decide which attribute range it should belongs to.

The key and the value will be the same AttributeRangeFilter.

Specified by:

getAttributeSimpleValuesMap in interface ElasticPath

Parameters:

attributeCode - the attributeCode

Returns:

attribute ranges of the given attribute code, which are defined at bottom level

getBean

public java.lang.Object getBean(java.lang.String name)

Get the bean with the given id from spring ContextBeanFactory.

Specified by:

getBean in interface ElasticPath

Parameters:

name - bean id

Returns:

instance of the bean with the given id.

getBoolMap

public java.util.Map getBoolMap()

Returns a map used by Spring/Velocity for checkboxes.

Specified by:

getBoolMap in interface ElasticPath

Returns:

a map containing {Boolean.TRUE -> ""}

getBottomLevelAttributeRanges

public java.util.SortedMap getBottomLevelAttributeRanges(java.lang.String attributeCode)

Returns attribute ranges of the given attributeCode, which are defined at bottom level of the attribute-range-tree. This is a lookup map for a Product to decide which attribute range it should belongs to.

The key and the value will be the same AttributeRangeFilter.

Specified by:

getBottomLevelAttributeRanges in interface ElasticPath

Parameters:

attributeCode - the attributeCode

Returns:

attribute ranges of the given attribute code, which are defined at bottom level

getBottomLevelPriceRanges

public java.util.SortedMap getBottomLevelPriceRanges(java.util.Currency currency)

Returns price ranges of the given currency, which are defined at bottom level of the price-range-tree. This is a lookup map for a Product to decide which price range it should belongs to.

The key and the value will be the same PriceFilter.

Specified by:

getBottomLevelPriceRanges in interface ElasticPath

Parameters:

currency - the currency

Returns:

price ranges of the given currency, which are defined at bottom level

getCatalogAssetPath

public java.lang.String getCatalogAssetPath()

Return the absolute asset directory path.

Specified by:

getCatalogAssetPath in interface ElasticPath

Returns:

the absolute asset directory path

getCatalogViewPagination

public int getCatalogViewPagination()

Return the catalog view pagination.

Specified by:

getCatalogViewPagination in interface ElasticPath

Returns:

the catalog view pagination

getCheckoutTransactionBehaviour

public CheckoutTransactionBehaviour getCheckoutTransactionBehaviour()

Return the CheckoutTransactionBehaviour object that defines how a checkout transaction is to be processed.

Specified by:

getCheckoutTransactionBehaviour in interface ElasticPath

Returns:

the CheckoutTransactionBehaviour object

getCmContextUrl

public java.lang.String getCmContextUrl()

Return the commerce manager context URL.

Specified by:

getCmContextUrl in interface ElasticPath

Returns:

the commerce manager context URL

getContentEncoding

public java.lang.String getContentEncoding()

Returns the content encoding.

Specified by:

getContentEncoding in interface ElasticPath

Returns:

the content encoding

getCountries

public Geography getCountries()

Return a Geography that provides geographical information.

Specified by:

getCountries in interface ElasticPath

Returns:

the Geography object

getCustomerProfileAttributes

public java.util.Map getCustomerProfileAttributes()

Returns a map of all customer profile attributes.

Specified by:

getCustomerProfileAttributes in interface ElasticPath

Returns:

a map of all customer profile attributes

getDatabaseMetaData

public java.sql.DatabaseMetaData getDatabaseMetaData()

Return database meta data.

Specified by:

getDatabaseMetaData in interface ElasticPath

Returns:

database meta data

getDatabaseProductName

public java.lang.String getDatabaseProductName()
                                        throws EpSystemException

Get the databse product name.

Specified by:

getDatabaseProductName in interface ElasticPath

Returns:

the databse product name.

Throws:

EpSystemException - in case of error

getDataFileEncoding

public java.lang.String getDataFileEncoding()

Returns the data file encoding.

Specified by:

getDataFileEncoding in interface ElasticPath

Returns:

the data file encoding

getDefaultCountry

public java.lang.String getDefaultCountry()

Returns the default country.

Specified by:

getDefaultCountry in interface ElasticPath

Returns:

the country

getDefaultCurrency

public java.util.Currency getDefaultCurrency()

Returns the default currency.

Specified by:

getDefaultCurrency in interface ElasticPath

Returns:

the currency

getDefaultDateFormat

public java.text.SimpleDateFormat getDefaultDateFormat()

Returns the default date format.

Specified by:

getDefaultDateFormat in interface ElasticPath

Returns:

the default date format

getDefaultLocale

public java.util.Locale getDefaultLocale()

Return the system default locale.

Specified by:

getDefaultLocale in interface ElasticPath

Returns:

the system default locale

getDomainBeanFactory

public PrototypeBeanFactory getDomainBeanFactory()

Returns PrototypeBeanFactory for domain objects.

Returns:

PrototypeBeanFactory for domain objects.

getEmailCmUrl

public java.lang.String getEmailCmUrl()

Return the URL of the Commerce Manager to be used only in email messages.

Specified by:

getEmailCmUrl in interface ElasticPath

Returns:

the cm URL

getEmailStoreUrl

public java.lang.String getEmailStoreUrl()

Return the URL of the store to be used only in email messages.

Specified by:

getEmailStoreUrl in interface ElasticPath

Returns:

the store URL

getEpBuildNo

public java.lang.String getEpBuildNo()

Returns the Elastic Path build number.

Specified by:

getEpBuildNo in interface ElasticPath

Returns:

the Elastic Path build number

getEpVersion

public java.lang.String getEpVersion()

Returns the Elastic Path version number.

Specified by:

getEpVersion in interface ElasticPath

Returns:

the Elastic Path version number

getFileAssetPath

public java.lang.String getFileAssetPath()

Return the file asset directory path.

Specified by:

getFileAssetPath in interface ElasticPath

Returns:

the file asset directory path

getFileAssetSubFolder

public java.lang.String getFileAssetSubFolder()

Return the file asset sub folder name.

Specified by:

getFileAssetSubFolder in interface ElasticPath

Returns:

the file asset sub folder name.

getGeography

public Geography getGeography()

Return a Geography that provides geographical information.

Specified by:

getGeography in interface ElasticPath

Returns:

the Geography object

getImageAssetSubFolder

public java.lang.String getImageAssetSubFolder()

Return the image asset sub folder name.

Specified by:

getImageAssetSubFolder in interface ElasticPath

Returns:

the image asset sub folder name.

getImagePath

public java.lang.String getImagePath()

Return the absolute images directory path.

Specified by:

getImagePath in interface ElasticPath

Returns:

the absolute images directory path

getImageUrl

public java.lang.String getImageUrl()

Return the image url.

Specified by:

getImageUrl in interface ElasticPath

Returns:

the image url

getInstance

public static ElasticPath getInstance()

Return the singleton ElasticPath. Create default EP if one hasn't been created already.

Returns:

the singleton ElasticPath

getJPEGQuality

public float getJPEGQuality()

Returns the jpeg quality to use when resizing a jpeg in the dynamic image resizing engine.

Specified by:

getJPEGQuality in interface ElasticPath

Returns:

the jpeg quality factor

getLocaleToLanguageMap

public java.util.Map getLocaleToLanguageMap()

Get a map of supported locales mapped to their language names. E.g. "en_US" --> "English (United States)", or "en" --> "English"

Specified by:

getLocaleToLanguageMap in interface ElasticPath

Returns:

the locale -> Language map

getMaximumSuggestions

public int getMaximumSuggestions()

Returns the maximum number of suggestions that will be returned with the search results.

Specified by:

getMaximumSuggestions in interface ElasticPath

Returns:

the maximum number of suggestions

getMaximumSuggestionsPerWord

public int getMaximumSuggestionsPerWord()

Returns the maximum number of suggestions per word that will be generated when generating search suggestions.

Specified by:

getMaximumSuggestionsPerWord in interface ElasticPath

Returns:

the maximum number of suggestion per word

getMaxReturnNumber

public int getMaxReturnNumber()

Returns the number of maximum results to return to the search client as the search result.

Specified by:

getMaxReturnNumber in interface ElasticPath

Returns:

the number of maximumu results to return to the search client as the search result

getMessage

public java.lang.String getMessage(java.lang.String code,
                                   java.lang.Object[] args,
                                   java.lang.String defaultMessage,
                                   java.util.Locale locale)

Gets the localized message.

Specified by:

getMessage in interface ElasticPath

Parameters:

code - - the message key.

args - - the args for the message if needed.

defaultMessage - - the default message to display if the given message key does not exists.

locale - - the locale that message needs to be in.

Returns:

localized message string.

getMessageDefaultLocale

public java.lang.String getMessageDefaultLocale(java.lang.String code,
                                                java.lang.Object[] args,
                                                java.lang.String defaultMessage)

Gets the localized message.

Specified by:

getMessageDefaultLocale in interface ElasticPath

Parameters:

code - - the message key.

args - - the args for the message if needed.

defaultMessage - - the default message to display if the given message key does not exists.

Returns:

localized message string.

getMinimumResultsThreshold

public int getMinimumResultsThreshold()

Returns the number of search results that, if not exceeded will trigger the generation of search suggestions.

Specified by:

getMinimumResultsThreshold in interface ElasticPath

Returns:

the minimum results threshold

getMinimumSimilarity

public float getMinimumSimilarity()

Returns the minimum similarity fuzzy search setting, value should be between 0 and 1.

Specified by:

getMinimumSimilarity in interface ElasticPath

Returns:

the minimum similarity fuzzy search setting, value should be between 0 and 1

getNoImage

public java.lang.String getNoImage()

Returns the image to use when a catalog image does not exist.

Specified by:

getNoImage in interface ElasticPath

Returns:

the default image to use.

getPaymentGateway

public PaymentGateway getPaymentGateway(PaymentType paymentType)

Get the payment gateway for the given payment type (e.g. CreditCard).

Specified by:

getPaymentGateway in interface ElasticPath

Parameters:

paymentType - the payment type

Returns:

the payment gateway

getPowerReviewsMerchantId

public int getPowerReviewsMerchantId()

Returns the PowerReviews merchant id.

Specified by:

getPowerReviewsMerchantId in interface ElasticPath

Returns:

the PowerReviews merchant id

getPrefixLength

public int getPrefixLength()

Returns the fuzzy search setting for the length of common non-fuzzy prefix.

Specified by:

getPrefixLength in interface ElasticPath

Returns:

the length of common non-fuzzy prefix

getPropertiesWithNameStartsWith

public java.util.Map getPropertiesWithNameStartsWith(java.lang.String prefix)

Return name and values of those properties starts with the given string.

Specified by:

getPropertiesWithNameStartsWith in interface ElasticPath

Parameters:

prefix - the prefix of the name

Returns:

those properties starts with the given string

getSecureAssetPath

public java.lang.String getSecureAssetPath()

Return the absolute secure asset (digital goods) directory path.

Specified by:

getSecureAssetPath in interface ElasticPath

Returns:

the absolute secure asset (digital goods) directory path

getSecureAssetSubFolder

public java.lang.String getSecureAssetSubFolder()

Return the secure asset (digital goods) sub folder name.

Specified by:

getSecureAssetSubFolder in interface ElasticPath

Returns:

the secure asset (digital goods) sub folder name.

getSfContextUrl

public java.lang.String getSfContextUrl()

Return the store front context URL.

Specified by:

getSfContextUrl in interface ElasticPath

Returns:

the store front context URL

getTopSellerCount

public int getTopSellerCount()

Returns the number of top seller products to display.

Specified by:

getTopSellerCount in interface ElasticPath

Returns:

the number of top seller products to display

getUnitsLength

public java.lang.String getUnitsLength()

Returns the unit measurement of length.

Specified by:

getUnitsLength in interface ElasticPath

Returns:

the length units

getUnitsWeight

public java.lang.String getUnitsWeight()

Returns the unit measurement of weight.

Specified by:

getUnitsWeight in interface ElasticPath

Returns:

the weight units

getUserIdMode

public int getUserIdMode()

Return the mode to generate user Id. 1 - Use user email as user Id, this is default value. 2 - Generate unique premanent user Id, currently will append a random four digit suffix to email address, and use it as User Id. The user Id is created when the customer is created first time. Later on, when the customer change the email address, the user Id will not be changed. e.g. customer email address is a@a.com, the user Id would be a@a.comXXXX, where XXXX is a random generated string. 3 - Independent email and user Id

Specified by:

getUserIdMode in interface ElasticPath

Returns:

the flag to indicate how to generate user Id

getUserMaintainMode

public int getUserMaintainMode()

Return the user maintenance mode. 1 - Maintain user password in Local DB, default value. 2 - Maintain user password through JAAS, CM will disable the create/delete and change password function in this mode.

Specified by:

getUserMaintainMode in interface ElasticPath

Returns:

the user maintenance mode

getUtility

public Utility getUtility()

Returns the Utility instance.

Specified by:

getUtility in interface ElasticPath

Returns:

the utility instance

getWebApplicationContext

public org.springframework.web.context.WebApplicationContext getWebApplicationContext()

Return the web application context.

Specified by:

getWebApplicationContext in interface ElasticPath

Returns:

the web application context

getWebInfPath

public java.lang.String getWebInfPath()

Return the absolute WEB-INF directory path.

Specified by:

getWebInfPath in interface ElasticPath

Returns:

the absolute WEB-INF directory path

isAttributeFilterEnabled

public boolean isAttributeFilterEnabled()

check the attributeFilter is enabled.

Specified by:

isAttributeFilterEnabled in interface ElasticPath

Returns:

the attributeFilterEnabled

isPowerReviewsEnabled

public boolean isPowerReviewsEnabled()

Returns true if PowerReviews has been enabled, otherwise, false.

Specified by:

isPowerReviewsEnabled in interface ElasticPath

Returns:

true if PowerReviews has been enabled, otherwise, false

isSeoEnabled

public boolean isSeoEnabled()

Returns true if SEO(Search Engine Optimization) has been enabled, otherwise, false.

Specified by:

isSeoEnabled in interface ElasticPath

Returns:

true if SEO(Search Engine Optimization) has been enabled, otherwise, false

setAccuracy

public void setAccuracy(float accuracy)

Sets the degree of similarity that a word must have to the original word in order to be suggested.

Specified by:

setAccuracy in interface ElasticPath

Parameters:

accuracy - the similarity

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext context)

Set the web application context.

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Parameters:

context - the web application context to set.

Throws:

EpSystemException - in case of error

setCheckoutTransactionBehaviour

public void setCheckoutTransactionBehaviour(CheckoutTransactionBehaviour behaviour)

Sets the checkoutTransactionBehaviour that defines how a checkout transaction is processed.

Specified by:

setCheckoutTransactionBehaviour in interface ElasticPath

Parameters:

behaviour - the behaviour enum object

setCustomerProfileAttributes

public void setCustomerProfileAttributes(java.util.Map customerProfileAttributes)

Sets the customer profile attribute map.

Specified by:

setCustomerProfileAttributes in interface ElasticPath

Parameters:

customerProfileAttributes - the customer profile attributes map

setDatabaseMetaData

public void setDatabaseMetaData(java.sql.DatabaseMetaData databaseMetaData)
                         throws EpSystemException

Called in EPContextListener to set the DatabaseMetaData at the start up time.

Specified by:

setDatabaseMetaData in interface ElasticPath

Parameters:

databaseMetaData - Database metadata.

Throws:

EpSystemException - in case of error

setDomainBeanFactory

public void setDomainBeanFactory(PrototypeBeanFactory domainBeanFactory)

Sets PrototypeBeanFactory for domain objects.

Parameters:

domainBeanFactory - PrototypeBeanFactory for domain objects.

setMaximumSuggestions

public void setMaximumSuggestions(int suggestions)

Sets the maximum number of suggestions that will be returned with the search results.

Specified by:

setMaximumSuggestions in interface ElasticPath

Parameters:

suggestions - the maximum number of suggestions

setMaximumSuggestionsPerWord

public void setMaximumSuggestionsPerWord(int maximumSuggestionsPerWord)

Sets the maximum number of suggestions per word that will be generated when generating search suggestions.

Specified by:

setMaximumSuggestionsPerWord in interface ElasticPath

Parameters:

maximumSuggestionsPerWord - the maximum number of suggestions per word

setMaxReturnNumber

public void setMaxReturnNumber(int number)

Sets the number of maximum results to return to the search client as the search result.

Specified by:

setMaxReturnNumber in interface ElasticPath

Parameters:

number - the number of maximum results to return, set it to 0 for no limit.

setMinimumResultsThreshold

public void setMinimumResultsThreshold(int minimumResultsThreshold)

Sets the number of search results that, if not exceeded will trigger the generation of search suggestions.

Specified by:

setMinimumResultsThreshold in interface ElasticPath

Parameters:

minimumResultsThreshold - the minimum results threshold

setMinimumSimilarity

public void setMinimumSimilarity(float minimumSimilarity)

Sets the minimum similarity fuzzy search setting, value should be between 0 and 1.

Specified by:

setMinimumSimilarity in interface ElasticPath

Parameters:

minimumSimilarity - the minimum similarity fuzzy search setting

setPaymentGatewayMap

public void setPaymentGatewayMap(java.util.Map paymentGatewayMap)

Set the payment gateway map, keyed by the payment type (e.g. "CreditCard", "PayPalExpress").

Specified by:

setPaymentGatewayMap in interface ElasticPath

Parameters:

paymentGatewayMap - the payment gateway map.

setPrefixLength

public void setPrefixLength(int prefixLength)

Sets fuzzy search setting for the length of common non-fuzzy prefix.

Specified by:

setPrefixLength in interface ElasticPath

Parameters:

prefixLength - length of common non-fuzzy prefix

setProperties

public void setProperties(java.util.Map properties)

Set the properties.

Specified by:

setProperties in interface ElasticPath

Parameters:

properties - the properties

setWebApplicationContext

public void setWebApplicationContext(org.springframework.web.context.WebApplicationContext context)
                              throws EpSystemException

Set the web application context.

Specified by:

setWebApplicationContext in interface ElasticPath

Parameters:

context - the web application context to set.

Throws:

EpSystemException - in case of error

setWebInfPath

public void setWebInfPath(java.lang.String webInfPath)

Set the absolute path to the WEB-INF directory.

Specified by:

setWebInfPath in interface ElasticPath

Parameters:

webInfPath - the absolute path