com.atlassian.confluence.search.service
Class SearchQueryParameters

java.lang.Object
  com.atlassian.confluence.search.service.SearchQueryParameters

public class SearchQueryParameters
extends java.lang.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

SearchQueryParameters()
Construct a query with no search term or filtering.

SearchQueryParameters(java.lang.String query)
Construct a query for the specified String.

Method Summary

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

Construct a query for the specified String.

Parameters:

query - the String to search for.

Method Detail

setQuery

public void setQuery(java.lang.String query)

setCategory

public void setCategory(SpaceCategoryEnum category)

setSpaceKey

public void setSpaceKey(java.lang.String spaceKey)

setSpaceKeys

public void setSpaceKeys(java.util.Set<java.lang.String> spaceKeys)

setAttachmentTypes

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

setContentType

public void setContentType(ContentTypeEnum contentType)

setContentTypes

public void setContentTypes(java.util.Set<ContentTypeEnum> contentTypes)

setLastModified

public void setLastModified(DateRangeQuery.DateRange lastModified)

setContributor

@Deprecated
public void setContributor(java.lang.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 java.lang.String getQuery()

getCategory

public SpaceCategoryEnum getCategory()

getSpaceKeys

public java.util.Set<java.lang.String> getSpaceKeys()

getAttachmentTypes

public java.util.Set<Attachment.Type> getAttachmentTypes()

getContentTypes

public java.util.Set<ContentTypeEnum> getContentTypes()

getLastModified

public DateRangeQuery.DateRange getLastModified()

getContributor

public ConfluenceUser getContributor()

getLabels

public java.util.Set<java.lang.String> getLabels()

setLabels

public void setLabels(java.util.Set<java.lang.String> labels)

getSort

public SearchSort getSort()

setSort

public void setSort(SearchSort sort)

setPluginContentTypes

public void setPluginContentTypes(java.util.Set<ContentTypeSearchDescriptor> pluginContentTypes)

getPluginContentTypes

public java.util.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 java.lang.String toString()

Overrides:

toString in class java.lang.Object