Package com.atlassian.confluence.search.service

Class SearchQueryParameters

java.lang.Object
com.atlassian.confluence.search.service.SearchQueryParameters
public class SearchQueryParameters extends Object

Encapsulates parameters which describes search terms and additional filtering.

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

  • Field Details

  • Constructor Details

    • 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 Details

    • 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(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)

    • setLabels

      public void setLabels(Set<String> labels, boolean makeGlobalIfNecessary)

    • getSort

      public SearchSort getSort()

    • getSearchQueryFilter

      public SearchQuery getSearchQueryFilter()

    • 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()

    • isUseSiteTextSearchQuery

      public boolean isUseSiteTextSearchQuery()

    • setUseSiteTextSearchQuery

      public void setUseSiteTextSearchQuery(boolean useSiteTextSearchQuery)

    • getExtraFields

      public Set<String> getExtraFields()

    • setExtraFields

      public void setExtraFields(Set<String> extraFields)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setSearchQueryFilter

      public void setSearchQueryFilter(SearchQuery searchQueryFilter)

    • getSearchContext

      public SearchContext getSearchContext()

    • setSearchContext

      public void setSearchContext(SearchContext searchContext)