SearchOptions (Atlassian Confluence 8.1.0 API)

java.lang.Object
- com.atlassian.confluence.api.model.search.SearchOptions

public class SearchOptions
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SearchOptions.Builder

static class SearchOptions.Excerpt

Constructor Summary

Constructors
Constructor Description

SearchOptions(SearchOptions.Builder builder)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SearchOptions`	`buildDefault()`
`static SearchOptions.Builder`	`builder()`
`SearchOptions.Excerpt`	`getExcerptStrategy()`
`SearchContext`	`getSearchContext()`
`boolean`	`isFireSearchPerformed()`
`boolean`	`isIncludeArchivedSpaces()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SearchOptions
```
public SearchOptions(SearchOptions.Builder builder)
```
- Method Detail
  - getExcerptStrategy
```
public SearchOptions.Excerpt getExcerptStrategy()
```
    Returns:
    
    The excerpt strategy to apply when building the search result
  - getSearchContext
```
public SearchContext getSearchContext()
```
  - isIncludeArchivedSpaces
```
public boolean isIncludeArchivedSpaces()
```
  - isFireSearchPerformed
```
public boolean isFireSearchPerformed()
```
    Returns:
    
    true if a com.atlassian.confluence.event.events.search.SearchPerformedEvent should be fired for this search
  - buildDefault
```
public static SearchOptions buildDefault()
```
    Returns:
    
    a SearchOptions with an empty context and no excerpt
  - builder
```
public static SearchOptions.Builder builder()
```