SearchContext (Liferay 7.0.10 portal-kernel API)

Object
- com.liferay.portal.kernel.search.SearchContext

All Implemented Interfaces:

Serializable
```
public class SearchContext
extends Object
implements Serializable
```
Author:

Brian Wing Shun Chan, Julio Camarero

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

SearchContext()

Constructors
Constructor and Description
`SearchContext()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFacet(Facet facet)`
`void`	`addFullQueryEntryClassName(String entryClassName)`
`void`	`addStats(Stats stats)`
`void`	`clearFullQueryEntryClassNames()`
`long[]`	`getAssetCategoryIds()`
`String[]`	`getAssetTagNames()`
`Serializable`	`getAttribute(String name)`
`Map<String,Serializable>`	`getAttributes()`
`BooleanClause<Query>[]`	`getBooleanClauses()`
`long[]`	`getCategoryIds()`
`long[]`	`getClassTypeIds()`
`long`	`getCompanyId()`
`int`	`getEnd()`
`String[]`	`getEntryClassNames()`
`Facet`	`getFacet(String fieldName)`
`Map<String,Facet>`	`getFacets()`
`long[]`	`getFolderIds()`
`String[]`	`getFullQueryEntryClassNames()`
`GroupBy`	`getGroupBy()`
`long[]`	`getGroupIds()`
`String`	`getKeywords()`
`String`	`getLanguageId()`
`Layout`	`getLayout()`
`Locale`	`getLocale()`
`long[]`	`getNodeIds()`
`long`	`getOwnerUserId()`
`String[]`	`getPortletIds()`
`QueryConfig`	`getQueryConfig()`
`float`	`getScoresThreshold()`
`String`	`getSearchEngineId()`
`Sort[]`	`getSorts()`
`int`	`getStart()`
`Map<String,Stats>`	`getStats()`
`Stats`	`getStats(String fieldName)`
`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(String keywords)`
`void`	`setAndSearch(boolean andSearch)`
`void`	`setAssetCategoryIds(long[] assetCategoryIds)`
`void`	`setAssetTagNames(String[] assetTagNames)`
`void`	`setAttribute(String name, Serializable value)`
`void`	`setAttributes(Map<String,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(String[] entryClassNames)`
`void`	`setFacets(List<Facet> facets)`
`void`	`setFolderIds(List<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(String keywords)`
`void`	`setLayout(Layout layout)`
`void`	`setLike(boolean like)`
`void`	`setLocale(Locale locale)`
`void`	`setNodeIds(long[] nodeIds)`
`void`	`setOwnerUserId(long ownerUserId)`
`void`	`setPortletIds(String[] portletIds)`
`void`	`setQueryConfig(QueryConfig queryConfig)`
`void`	`setScopeStrict(boolean scopeStrict)`
`void`	`setScoresThreshold(float scoresThreshold)`
`void`	`setSearchEngineId(String searchEngineId)`
`void`	`setSorts(Sort... sorts)`
`void`	`setStart(int start)`
`void`	`setTimeZone(TimeZone timeZone)`
`void`	`setUserId(long userId)`

Methods inherited from class 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(String entryClassName)

addStats
```
public void addStats(Stats stats)
```

clearFullQueryEntryClassNames

public void clearFullQueryEntryClassNames()

getAssetCategoryIds
```
public long[] getAssetCategoryIds()
```

getAssetTagNames
```
public String[] getAssetTagNames()
```

getAttribute

public Serializable getAttribute(String name)

getAttributes

public Map<String,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 String[] getEntryClassNames()
```

getFacet

public Facet getFacet(String fieldName)

getFacets
```
public Map<String,Facet> getFacets()
```

getFolderIds
```
public long[] getFolderIds()
```

getFullQueryEntryClassNames

public String[] getFullQueryEntryClassNames()

getGroupBy
```
public GroupBy getGroupBy()
```

getGroupIds
```
public long[] getGroupIds()
```

getKeywords
```
public String getKeywords()
```

getLanguageId
```
public String getLanguageId()
```

getLayout
```
public Layout getLayout()
```

getLocale
```
public Locale getLocale()
```

getNodeIds
```
public long[] getNodeIds()
```

getOwnerUserId
```
public long getOwnerUserId()
```

getPortletIds
```
public String[] getPortletIds()
```

getQueryConfig
```
public QueryConfig getQueryConfig()
```

getScoresThreshold
```
public float getScoresThreshold()
```

getSearchEngineId
```
public String getSearchEngineId()
```

getSorts
```
public Sort[] getSorts()
```

getStart
```
public int getStart()
```

getStats
```
public Map<String,Stats> getStats()
```

getStats

public Stats getStats(String fieldName)

getTimeZone
```
public 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(String keywords)

setAndSearch

public void setAndSearch(boolean andSearch)

setAssetCategoryIds

public void setAssetCategoryIds(long[] assetCategoryIds)

setAssetTagNames

public void setAssetTagNames(String[] assetTagNames)

setAttribute

public void setAttribute(String name,
                         Serializable value)

setAttributes

public void setAttributes(Map<String,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(String[] entryClassNames)

setFacets

public void setFacets(List<Facet> facets)

setFolderIds

public void setFolderIds(List<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(String keywords)

setLayout
```
public void setLayout(Layout layout)
```

setLike
```
public void setLike(boolean like)
```

setLocale
```
public void setLocale(Locale locale)
```

setNodeIds

public void setNodeIds(long[] nodeIds)

setOwnerUserId

public void setOwnerUserId(long ownerUserId)

setPortletIds

public void setPortletIds(String[] portletIds)

setQueryConfig

public void setQueryConfig(QueryConfig queryConfig)

setScopeStrict

public void setScopeStrict(boolean scopeStrict)

setScoresThreshold

public void setScoresThreshold(float scoresThreshold)

setSearchEngineId

public void setSearchEngineId(String searchEngineId)

setSorts
```
public void setSorts(Sort... sorts)
```

setStart
```
public void setStart(int start)
```

setTimeZone

public void setTimeZone(TimeZone timeZone)

setUserId
```
public void setUserId(long userId)
```

Class SearchContext

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

SearchContext

Method Detail

addFacet

addFullQueryEntryClassName

addStats

clearFullQueryEntryClassNames

getAssetCategoryIds

getAssetTagNames

getAttribute

getAttributes

getBooleanClauses

getCategoryIds

getClassTypeIds

getCompanyId

getEnd

getEntryClassNames

getFacet

getFacets

getFolderIds

getFullQueryEntryClassNames

getGroupBy

getGroupIds

getKeywords

getLanguageId

getLayout

getLocale

getNodeIds

getOwnerUserId

getPortletIds

getQueryConfig

getScoresThreshold

getSearchEngineId

getSorts

getStart

getStats

getStats

getTimeZone

getUserId

hasOverridenKeywords

isAndSearch

isCommitImmediately

isIncludeAttachments

isIncludeDiscussions

isIncludeFolders

isIncludeLiveGroups

isIncludeStagingGroups

isLike

isScopeStrict

overrideKeywords

setAndSearch

setAssetCategoryIds

setAssetTagNames

setAttribute

setAttributes

setBooleanClauses

setCategoryIds

setClassTypeIds

setCommitImmediately

setCompanyId

setEnd

setEntryClassNames

setFacets

setFolderIds

setFolderIds

setGroupBy

setGroupIds

setIncludeAttachments

setIncludeDiscussions

setIncludeFolders

setIncludeLiveGroups

setIncludeStagingGroups

setKeywords

setLayout

setLike

setLocale