com.atlassian.confluence.search.service

Class SearchQueryParameters

java.lang.Object

com.atlassian.confluence.search.service.SearchQueryParameters

public class SearchQueryParameters
extends Object

A bean encapsulating the query being issued to the search service.

All properties on this bean are optional. If not set then a property has no affect on the search.

Constructor Summary

Constructors

Constructor and Description
SearchQueryParameters() Construct a query with no search term or filtering.
SearchQueryParameters(String query) Construct a query for the specified String.

Method Summary

Modifier and Type	Method and Description
Set<Attachment.Type>	getAttachmentTypes()
SpaceCategoryEnum	getCategory()
Set<ContentTypeEnum>	getContentTypes()
ConfluenceUser	getContributor()
Set<String>	getLabels()
DateRangeQuery.DateRange	getLastModified()
Set<ContentTypeSearchDescriptor>	getPluginContentTypes()
String	getQuery()
SearchSort	getSort()
Set<String>	getSpaceKeys()
boolean	isIncludeArchivedSpaces()
boolean	isOnlyArchivedSpaces()
void	setAttachmentTypes(Set<Attachment.Type> attachmentTypes)
void	setCategory(SpaceCategoryEnum category)
void	setContentType(ContentTypeEnum contentType)
void	setContentTypes(Set<ContentTypeEnum> contentTypes)
void	setContributor(ConfluenceUser contributor) Limits results to ones where the given user has been a contributor
void	setContributor(String contributor) Deprecated. since 5.2. This method can be slow. Use setContributor(ConfluenceUser) instead.
void	setIncludeArchivedSpaces(boolean includeArchivedSpaces)
void	setLabels(Set<String> labels)
void	setLastModified(DateRangeQuery.DateRange lastModified)
void	setOnlyArchivedSpaces(boolean onlyArchivedSpaces)
void	setPluginContentTypes(Set<ContentTypeSearchDescriptor> pluginContentTypes)
void	setQuery(String query)
void	setSort(SearchSort sort)
void	setSpaceKey(String spaceKey)
void	setSpaceKeys(Set<String> spaceKeys)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchQueryParameters

public SearchQueryParameters()

Construct a query with no search term or filtering.

SearchQueryParameters

public SearchQueryParameters(String query)

Construct a query for the specified String.

Parameters:

query - the String to search for.

Method Detail

setQuery

public void setQuery(String query)

setCategory

public void setCategory(SpaceCategoryEnum category)

setSpaceKey

public void setSpaceKey(String spaceKey)

setSpaceKeys

public void setSpaceKeys(Set<String> spaceKeys)

setAttachmentTypes

public void setAttachmentTypes(Set<Attachment.Type> attachmentTypes)

setContentType

public void setContentType(ContentTypeEnum contentType)

setContentTypes

public void setContentTypes(Set<ContentTypeEnum> contentTypes)

setLastModified

public void setLastModified(DateRangeQuery.DateRange lastModified)

setContributor

@Deprecated
public void setContributor(String contributor)

Deprecated. since 5.2. This method can be slow. Use setContributor(ConfluenceUser) instead.

Limits results to ones where the given user has been a contributor

Parameters:

contributor - username of the contributor

setContributor

public void setContributor(ConfluenceUser contributor)

Limits results to ones where the given user has been a contributor

Parameters:

contributor - the contributor

Since:

5.2

getQuery

public String getQuery()

getCategory

public SpaceCategoryEnum getCategory()

getSpaceKeys

public Set<String> getSpaceKeys()

getAttachmentTypes

public Set<Attachment.Type> getAttachmentTypes()

getContentTypes

public Set<ContentTypeEnum> getContentTypes()

getLastModified

public DateRangeQuery.DateRange getLastModified()

getContributor

public ConfluenceUser getContributor()

getLabels

public Set<String> getLabels()

setLabels

public void setLabels(Set<String> labels)

getSort

public SearchSort getSort()

setSort

public void setSort(SearchSort sort)

setPluginContentTypes

public void setPluginContentTypes(Set<ContentTypeSearchDescriptor> pluginContentTypes)

getPluginContentTypes

public Set<ContentTypeSearchDescriptor> getPluginContentTypes()

isIncludeArchivedSpaces

public boolean isIncludeArchivedSpaces()

setIncludeArchivedSpaces

public void setIncludeArchivedSpaces(boolean includeArchivedSpaces)

setOnlyArchivedSpaces

public void setOnlyArchivedSpaces(boolean onlyArchivedSpaces)

isOnlyArchivedSpaces

public boolean isOnlyArchivedSpaces()

toString

public String toString()

Overrides:

toString in class Object