Package com.atlassian.confluence.api.model.search

Class SearchOptions.Builder

java.lang.Object

com.atlassian.confluence.api.model.search.SearchOptions.Builder

Enclosing class:

SearchOptions

public static class SearchOptions.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
SearchOptions	build()
SearchOptions.Builder	excerptStrategy(SearchOptions.Excerpt excerpt)
SearchOptions.Builder	excerptStrategy(String excerptStrategyName)	Sets the excerpt strategy to the excerpt strategy with the given name.
SearchOptions.Builder	fireSearchPerformed(boolean fireIt)
SearchOptions.Builder	includeArchivedSpaces(boolean includeArchivedSpaces)
SearchOptions.Builder	searchContext(SearchContext searchContext)

Methods inherited from class java.lang.Object

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

Method Detail

excerptStrategy

public SearchOptions.Builder excerptStrategy(SearchOptions.Excerpt excerpt)

excerptStrategy

public SearchOptions.Builder excerptStrategy(String excerptStrategyName)

Sets the excerpt strategy to the excerpt strategy with the given name. If there is no built in strategy with this name, the excerpt strategy is set to NONE.

This method is primarily used to deserialize an excerpt strategy from it's name

Parameters:

excerptStrategyName - name of one of the built in excerpt strategies

Returns:

this

searchContext

public SearchOptions.Builder searchContext(SearchContext searchContext)

includeArchivedSpaces

public SearchOptions.Builder includeArchivedSpaces(boolean includeArchivedSpaces)

fireSearchPerformed

public SearchOptions.Builder fireSearchPerformed(boolean fireIt)

build

public SearchOptions build()