com.elasticpath.domain.search
Interface SfSearchLog

All Superinterfaces:
EpDomain, Persistence, java.io.Serializable
All Known Implementing Classes:
SfSearchLogImpl

public interface SfSearchLog
extends Persistence

Represents the persistent log information about a search query that has been issued to the storefront.


Method Summary
 long getCategoryRestriction()
          Gets the category restriction for this search.
 java.lang.String getKeywords()
          Gets the keywords that were used to search.
 int getResultCount()
          Gets the number of results returned by the search.
 java.util.Date getSearchTime()
          Returns the date that this search was executed.
 boolean getSuggestionsGenerated()
          Gets whether or not suggestions were generated for this search.
 void setCategoryRestriction(long categoryRestriction)
          Sets the category restriction for this search.
 void setKeywords(java.lang.String keywords)
          Sets the keywords that were used to search.
 void setResultCount(int resultCount)
          Sets the number of results returned by the search.
 void setSearchTime(java.util.Date searchTime)
          Sets the date that this search was executed.
 void setSuggestionsGenerated(boolean suggestionsGenerated)
          Sets whether or not suggestions were generated for this search.
 
Methods inherited from interface com.elasticpath.domain.Persistence
executeBeforePersistAction, getUidPk, isPersistent, setDefaultValues, setUidPk
 
Methods inherited from interface com.elasticpath.domain.EpDomain
getElasticPath, setElasticPath
 

Method Detail

getCategoryRestriction

long getCategoryRestriction()
Gets the category restriction for this search.

Returns:
the category restriction for this search

getKeywords

java.lang.String getKeywords()
Gets the keywords that were used to search.

Returns:
the keywords that were used to search

getResultCount

int getResultCount()
Gets the number of results returned by the search.

Returns:
the number of results returned by the search

getSearchTime

java.util.Date getSearchTime()
Returns the date that this search was executed.

Returns:
the date this search was executed

getSuggestionsGenerated

boolean getSuggestionsGenerated()
Gets whether or not suggestions were generated for this search.

Returns:
whether or not suggestions were generated for this search

setCategoryRestriction

void setCategoryRestriction(long categoryRestriction)
Sets the category restriction for this search.

Parameters:
categoryRestriction - the category restriction for this search

setKeywords

void setKeywords(java.lang.String keywords)
Sets the keywords that were used to search.

Parameters:
keywords - the keywords that were used to search

setResultCount

void setResultCount(int resultCount)
Sets the number of results returned by the search.

Parameters:
resultCount - the number of results returned by the search

setSearchTime

void setSearchTime(java.util.Date searchTime)
Sets the date that this search was executed.

Parameters:
searchTime - the date this search was executed

setSuggestionsGenerated

void setSuggestionsGenerated(boolean suggestionsGenerated)
Sets whether or not suggestions were generated for this search.

Parameters:
suggestionsGenerated - whether or not suggestions were generated for this search