com.atlassian.confluence.api.model.search

Class SearchContext

java.lang.Object

com.atlassian.confluence.api.model.search.SearchContext

@ExperimentalApi
public class SearchContext
extends Object

JSON serializable search context object to allow a user to specify the context they want a search to execute in.

Since:

5.7

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchContext.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static SearchContext	EMPTY

Method Summary

Modifier and Type	Method and Description
static SearchContext.Builder	builder()
Optional<ContentId>	contentId()
Optional<List<ContentStatus>>	contentStatuses()
static SearchContext	deserialize(String searchContextJson, org.codehaus.jackson.map.ObjectMapper objectMapper)
com.atlassian.fugue.Option<ContentId>	getContentId() Deprecated. since 7.0.1. Use contentId()
com.atlassian.fugue.Option<List<ContentStatus>>	getContentStatuses() Deprecated. since 7.0.1. Use contentStatuses()
com.atlassian.fugue.Option<String>	getSpaceKey() Deprecated. since 7.0.1. Use spaceKey()
Optional<String>	spaceKey()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final SearchContext EMPTY

Method Detail

getContentId

@Deprecated
public com.atlassian.fugue.Option<ContentId> getContentId()

Deprecated. since 7.0.1. Use contentId()

contentId

public Optional<ContentId> contentId()

Since:

7.0.1

getSpaceKey

@Deprecated
public com.atlassian.fugue.Option<String> getSpaceKey()

Deprecated. since 7.0.1. Use spaceKey()

spaceKey

public Optional<String> spaceKey()

Since:

7.0.1

getContentStatuses

@Deprecated
public com.atlassian.fugue.Option<List<ContentStatus>> getContentStatuses()

Deprecated. since 7.0.1. Use contentStatuses()

contentStatuses

public Optional<List<ContentStatus>> contentStatuses()

Since:

7.0.1

builder

public static SearchContext.Builder builder()

deserialize

public static SearchContext deserialize(String searchContextJson,
                                        org.codehaus.jackson.map.ObjectMapper objectMapper)