Package com.atlassian.confluence.search.v2

Interface SearchWithToken

All Superinterfaces:

ISearch

All Known Implementing Classes:

DefaultSearchWithToken

public interface SearchWithToken
extends ISearch

A search that additionally specifies a search token.

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.confluence.search.v2.ISearch

ISearch.Builder<SEARCH extends ISearch>

Field Summary

Fields

Modifier and Type	Field	Description
static final long	TOKEN_UNDEFINED	A constant that represent the absence of token, i.e.

Method Summary

Modifier and Type	Method	Description
long	getSearchToken()
ISearch.Builder<SearchWithToken>	toBuilder()

Methods inherited from interface com.atlassian.confluence.search.v2.ISearch

generatesToken, getHighlight, getIndices, getLimit, getQuery, getSearchIndexes, getSearchType, getSort, getStartOffset, isExplain, withIndices, withLimit, withQuery

Field Details

TOKEN_UNDEFINED

static final long TOKEN_UNDEFINED

A constant that represent the absence of token, i.e. the search will be performed without any token. This value is returned when ISearch.generatesToken() is false when using OpenSearch.

See Also:

• Constant Field Values

Method Details

getSearchToken

long getSearchToken()

Returns:

a search token that allows additional searching to be performed against a specific version of the index (perhaps older version).

toBuilder

ISearch.Builder<SearchWithToken> toBuilder()

Specified by:

toBuilder in interface ISearch

Returns:

a builder that's initialised with the values of the current search object