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

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

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

Method Summary

Set<Attachment.Type>	getAttachmentTypes()
SpaceCategoryEnum	getCategory()
Set<ContentTypeEnum>	getContentTypes()
String	getContributor()
DateRangeQuery.DateRange	getLastModified()
String	getQuery()
Set<String>	getSpaceKeys()
void	setAttachmentTypes(Set<Attachment.Type> attachmentTypes)
void	setCategory(SpaceCategoryEnum category)
void	setContentType(ContentTypeEnum contentType)
void	setContentTypes(Set<ContentTypeEnum> contentTypes)
void	setContributor(String creator)
void	setLastModified(DateRangeQuery.DateRange lastModified)
void	setQuery(String query)
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

public void setContributor(String creator)

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 String getContributor()

toString

public String toString()

Overrides:

toString in class Object