Package com.atlassian.confluence.search.v2

Class ChangesSearch

java.lang.Object

com.atlassian.confluence.search.v2.AbstractSearch

com.atlassian.confluence.search.v2.ChangesSearch

All Implemented Interfaces:

ISearch

public class ChangesSearch
extends AbstractSearch

Represents a search against change information. Change information is generated each time a person creates or edits content. This information can be queried to allow clients to track content updates.

Clients are also provided with filtering capabilities similar to the ContentSearch. For example, you can track all updates by one or more users by using the LastModifierUserQuery.

A parameterised version of this search is provided in PredefinedSearchBuilder.buildRecentUpdateSearch(RecentUpdateQueryParameters, int, int)

See Also:

• PredefinedSearchBuilder.buildRecentUpdateSearch(RecentUpdateQueryParameters, int, int)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChangesSearch.Builder

Nested classes/interfaces inherited from class com.atlassian.confluence.search.v2.AbstractSearch

AbstractSearch.AbstractBuilder<SELF extends AbstractSearch.AbstractBuilder<SELF>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGES_SEARCH
static final String	NETWORK_FEED_SEARCH
static final String	RECENT_UPDATES_SEARCH

Fields inherited from class com.atlassian.confluence.search.v2.AbstractSearch

generatesToken, indices, limit, query, sort, startOffset

Constructor Summary

Constructors

Constructor	Description
ChangesSearch(@NonNull SearchQuery query, SearchSort sort)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.0.
ChangesSearch(@NonNull SearchQuery query, SearchSort sort, int startOffset, int limit)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.0.
ChangesSearch(List<Index> indices, @NonNull SearchQuery query, SearchSort sort, int startOffset, int limit)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.0.

Method Summary

Modifier and Type	Method	Description
static ChangesSearch.Builder	builder()
String	getSearchType()	Returns type of search e.g.
ChangesSearch.Builder	toBuilder()

Methods inherited from class com.atlassian.confluence.search.v2.AbstractSearch

equals, generatesToken, getIndices, getLimit, getQuery, getSearchIndexes, getSort, getStartOffset, hashCode

Methods inherited from class java.lang.Object

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

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

getHighlight, isExplain, withIndices, withLimit, withQuery

Field Details

RECENT_UPDATES_SEARCH

public static final String RECENT_UPDATES_SEARCH

See Also:

• Constant Field Values

NETWORK_FEED_SEARCH

public static final String NETWORK_FEED_SEARCH

See Also:

• Constant Field Values

CHANGES_SEARCH

public static final String CHANGES_SEARCH

See Also:

• Constant Field Values

Constructor Details

ChangesSearch

@Deprecated(forRemoval=true)
public ChangesSearch(@NonNull SearchQuery query,
 SearchSort sort)

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.0. Use builder()

Constructs a search against change information. The maximum number of results returned will be a system provided default.

Parameters:

query - the non-null query to perform against change information

sort - how to order the results of the query

Since:

7.20

ChangesSearch

@Deprecated(forRemoval=true)
public ChangesSearch(@NonNull SearchQuery query,
 SearchSort sort,
 int startOffset,
 int limit)

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.0. Use builder()

Constructs a search against change information.

Parameters:

query - the non-null query to perform against change information

sort - how to order the results of the query

startOffset - the zero-based offset of the first content result to return

limit - the maximum number content results to return

Since:

7.20

ChangesSearch

@Deprecated(forRemoval=true)
public ChangesSearch(List<Index> indices,
 @NonNull SearchQuery query,
 SearchSort sort,
 int startOffset,
 int limit)

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.0. Use builder()

Since:

8.7.0

Method Details

getSearchType

public String getSearchType()

Description copied from interface: ISearch

Returns type of search e.g. SiteSearch, RecentUpdate, NetworkFeed, BlogUpdate, which can be used by search manager to switch between different implementations to support incremental roll out.

Returns:

type of search

toBuilder

public ChangesSearch.Builder toBuilder()

Returns:

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

builder

public static ChangesSearch.Builder builder()