com.liferay.portal.kernel.search

Class SearchContext

java.lang.Object

com.liferay.portal.kernel.search.SearchContext

All Implemented Interfaces:

java.io.Serializable

public class SearchContext
extends java.lang.Object
implements java.io.Serializable

Author:

Brian Wing Shun Chan, Julio Camarero

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchContext()

Method Summary

Modifier and Type	Method and Description
void	addFacet(Facet facet)
void	addFullQueryEntryClassName(java.lang.String entryClassName)
void	addStats(Stats stats)
void	clearFullQueryEntryClassNames()
long[]	getAssetCategoryIds()
java.lang.String[]	getAssetTagNames()
java.io.Serializable	getAttribute(java.lang.String name)
java.util.Map<java.lang.String,java.io.Serializable>	getAttributes()
BooleanClause<Query>[]	getBooleanClauses()
long[]	getCategoryIds()
long[]	getClassTypeIds()
long	getCompanyId()
int	getEnd()
java.lang.String[]	getEntryClassNames()
Facet	getFacet(java.lang.String fieldName)
java.util.Map<java.lang.String,Facet>	getFacets()
long[]	getFolderIds()
java.lang.String[]	getFullQueryEntryClassNames()
GroupBy	getGroupBy()
long[]	getGroupIds()
java.lang.String	getKeywords()
java.lang.String	getLanguageId()
Layout	getLayout()
java.util.Locale	getLocale()
long[]	getNodeIds()
long	getOwnerUserId()
java.lang.String[]	getPortletIds()
QueryConfig	getQueryConfig()
float	getScoresThreshold()
java.lang.String	getSearchEngineId()
Sort[]	getSorts()
int	getStart()
java.util.Map<java.lang.String,Stats>	getStats()
Stats	getStats(java.lang.String fieldName)
java.util.TimeZone	getTimeZone()
long	getUserId()
boolean	hasOverridenKeywords()
boolean	isAndSearch()
boolean	isCommitImmediately()
boolean	isIncludeAttachments()
boolean	isIncludeDiscussions()
boolean	isIncludeFolders()
boolean	isIncludeLiveGroups()
boolean	isIncludeStagingGroups()
boolean	isLike()
boolean	isScopeStrict()
void	overrideKeywords(java.lang.String keywords)
void	setAndSearch(boolean andSearch)
void	setAssetCategoryIds(long[] assetCategoryIds)
void	setAssetTagNames(java.lang.String[] assetTagNames)
void	setAttribute(java.lang.String name, java.io.Serializable value)
void	setAttributes(java.util.Map<java.lang.String,java.io.Serializable> attributes)
void	setBooleanClauses(BooleanClause<Query>[] booleanClauses)
void	setCategoryIds(long[] categoryIds)
void	setClassTypeIds(long[] classTypeIds)
void	setCommitImmediately(boolean commitImmediately)
void	setCompanyId(long companyId)
void	setEnd(int end)
void	setEntryClassNames(java.lang.String[] entryClassNames)
void	setFacets(java.util.List<Facet> facets)
void	setFolderIds(java.util.List<java.lang.Long> folderIds)
void	setFolderIds(long[] folderIds)
void	setGroupBy(GroupBy groupBy)
void	setGroupIds(long[] groupIds)
void	setIncludeAttachments(boolean includeAttachments)
void	setIncludeDiscussions(boolean includeDiscussions)
void	setIncludeFolders(boolean includeFolders)
void	setIncludeLiveGroups(boolean includeLiveGroups)
void	setIncludeStagingGroups(boolean includeStagingGroups)
void	setKeywords(java.lang.String keywords)
void	setLayout(Layout layout)
void	setLike(boolean like)
void	setLocale(java.util.Locale locale)
void	setNodeIds(long[] nodeIds)
void	setOwnerUserId(long ownerUserId)
void	setPortletIds(java.lang.String[] portletIds)
void	setQueryConfig(QueryConfig queryConfig)
void	setScopeStrict(boolean scopeStrict)
void	setScoresThreshold(float scoresThreshold)
void	setSearchEngineId(java.lang.String searchEngineId)
void	setSorts(Sort... sorts)
void	setStart(int start)
void	setTimeZone(java.util.TimeZone timeZone)
void	setUserId(long userId)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchContext

public SearchContext()

Method Detail

addFacet

public void addFacet(Facet facet)

addFullQueryEntryClassName

public void addFullQueryEntryClassName(java.lang.String entryClassName)

addStats

public void addStats(Stats stats)

clearFullQueryEntryClassNames

public void clearFullQueryEntryClassNames()

getAssetCategoryIds

public long[] getAssetCategoryIds()

getAssetTagNames

public java.lang.String[] getAssetTagNames()

getAttribute

public java.io.Serializable getAttribute(java.lang.String name)

getAttributes

public java.util.Map<java.lang.String,java.io.Serializable> getAttributes()

getBooleanClauses

public BooleanClause<Query>[] getBooleanClauses()

getCategoryIds

public long[] getCategoryIds()

getClassTypeIds

public long[] getClassTypeIds()

getCompanyId

public long getCompanyId()

getEnd

public int getEnd()

getEntryClassNames

public java.lang.String[] getEntryClassNames()

getFacet

public Facet getFacet(java.lang.String fieldName)

getFacets

public java.util.Map<java.lang.String,Facet> getFacets()

getFolderIds

public long[] getFolderIds()

getFullQueryEntryClassNames

public java.lang.String[] getFullQueryEntryClassNames()

getGroupBy

public GroupBy getGroupBy()

getGroupIds

public long[] getGroupIds()

getKeywords

public java.lang.String getKeywords()

getLanguageId

public java.lang.String getLanguageId()

getLayout

public Layout getLayout()

getLocale

public java.util.Locale getLocale()

getNodeIds

public long[] getNodeIds()

getOwnerUserId

public long getOwnerUserId()

getPortletIds

public java.lang.String[] getPortletIds()

getQueryConfig

public QueryConfig getQueryConfig()

getScoresThreshold

public float getScoresThreshold()

getSearchEngineId

public java.lang.String getSearchEngineId()

getSorts

public Sort[] getSorts()

getStart

public int getStart()

getStats

public java.util.Map<java.lang.String,Stats> getStats()

getStats

public Stats getStats(java.lang.String fieldName)

getTimeZone

public java.util.TimeZone getTimeZone()

getUserId

public long getUserId()

hasOverridenKeywords

public boolean hasOverridenKeywords()

isAndSearch

public boolean isAndSearch()

isCommitImmediately

public boolean isCommitImmediately()

isIncludeAttachments

public boolean isIncludeAttachments()

isIncludeDiscussions

public boolean isIncludeDiscussions()

isIncludeFolders

public boolean isIncludeFolders()

isIncludeLiveGroups

public boolean isIncludeLiveGroups()

isIncludeStagingGroups

public boolean isIncludeStagingGroups()

isLike

public boolean isLike()

isScopeStrict

public boolean isScopeStrict()

overrideKeywords

public void overrideKeywords(java.lang.String keywords)

setAndSearch

public void setAndSearch(boolean andSearch)

setAssetCategoryIds

public void setAssetCategoryIds(long[] assetCategoryIds)

setAssetTagNames

public void setAssetTagNames(java.lang.String[] assetTagNames)

setAttribute

public void setAttribute(java.lang.String name,
                         java.io.Serializable value)

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.io.Serializable> attributes)

setBooleanClauses

public void setBooleanClauses(BooleanClause<Query>[] booleanClauses)

setCategoryIds

public void setCategoryIds(long[] categoryIds)

setClassTypeIds

public void setClassTypeIds(long[] classTypeIds)

setCommitImmediately

public void setCommitImmediately(boolean commitImmediately)

setCompanyId

public void setCompanyId(long companyId)

setEnd

public void setEnd(int end)

setEntryClassNames

public void setEntryClassNames(java.lang.String[] entryClassNames)

setFacets

public void setFacets(java.util.List<Facet> facets)

setFolderIds

public void setFolderIds(java.util.List<java.lang.Long> folderIds)

setFolderIds

public void setFolderIds(long[] folderIds)

setGroupBy

public void setGroupBy(GroupBy groupBy)

setGroupIds

public void setGroupIds(long[] groupIds)

setIncludeAttachments

public void setIncludeAttachments(boolean includeAttachments)

setIncludeDiscussions

public void setIncludeDiscussions(boolean includeDiscussions)

setIncludeFolders

public void setIncludeFolders(boolean includeFolders)

setIncludeLiveGroups

public void setIncludeLiveGroups(boolean includeLiveGroups)

setIncludeStagingGroups

public void setIncludeStagingGroups(boolean includeStagingGroups)

setKeywords

public void setKeywords(java.lang.String keywords)

setLayout

public void setLayout(Layout layout)

setLike

public void setLike(boolean like)

setLocale

public void setLocale(java.util.Locale locale)

setNodeIds

public void setNodeIds(long[] nodeIds)

setOwnerUserId

public void setOwnerUserId(long ownerUserId)

setPortletIds

public void setPortletIds(java.lang.String[] portletIds)

setQueryConfig

public void setQueryConfig(QueryConfig queryConfig)

setScopeStrict

public void setScopeStrict(boolean scopeStrict)

setScoresThreshold

public void setScoresThreshold(float scoresThreshold)

setSearchEngineId

public void setSearchEngineId(java.lang.String searchEngineId)

setSorts

public void setSorts(Sort... sorts)

setStart

public void setStart(int start)

setTimeZone

public void setTimeZone(java.util.TimeZone timeZone)

setUserId

public void setUserId(long userId)