com.atlassian.confluence.plugins.rest.entities

Class SearchResultEntityList

java.lang.Object

com.atlassian.confluence.plugins.rest.entities.SearchResultEntityList

public class SearchResultEntityList
extends Object

Entity representing a search result

Constructor Summary

Constructors

Constructor and Description
SearchResultEntityList()

Method Summary

Modifier and Type	Method and Description
List<SearchResultGroupEntity>	getGroups() Returns the SearchResultGroupEntity list that was found using the QUICK search.
List<SearchResultEntity>	getResults() Returns the SearchResultEntity list that was found using the FULL search.
int	getTotalSize() Get the number of search results before any result filter was applied.
void	setGroups(List<SearchResultGroupEntity> groups)
void	setResults(List<SearchResultEntity> results)
void	setTotalSize(int totalSize)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResultEntityList

public SearchResultEntityList()

Method Detail

getResults

public List<SearchResultEntity> getResults()

Returns the SearchResultEntity list that was found using the FULL search. NOTE that this list will only be populated if using the full search, otherwise it will be an empty list.

Returns:

list of results

setResults

public void setResults(List<SearchResultEntity> results)

getGroups

public List<SearchResultGroupEntity> getGroups()

Returns the SearchResultGroupEntity list that was found using the QUICK search. NOTE that this list will only be populated if using the quick search, otherwise it will be an empty list.

Returns:

list of results

setGroups

public void setGroups(List<SearchResultGroupEntity> groups)

getTotalSize

public int getTotalSize()

Get the number of search results before any result filter was applied. For example, if you ran a filter to limit the number of results returned, this would give the total number of hits for your query before the limit was taken into account.

Returns:

the number of search results available before filtering was performed

setTotalSize

public void setTotalSize(int totalSize)