| Class and Description |
|---|
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
| Class and Description |
|---|
| InvalidSearchException
Superclass for exceptions thrown due to errors converting from a Search to the native search type.
|
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
| SearchResult
An individual search result.
|
| SearchResults
The results of a search.
|
| Class and Description |
|---|
| SearchResult
An individual search result.
|
| Class and Description |
|---|
| SearchQuery
A query to be performed against the search index.
|
| Class and Description |
|---|
| AbstractChainableSearchFilter
Deprecated.
since 7.20. There will be no replacement to extend. Use
BooleanQuery to chain equivalent SearchQuery.
See |
| Expandable
Interface that allows classes implemented it to be transformed into composition of primitive ones.
|
| SearchFilter
Deprecated.
since 7.20,
SearchFilter has been replaced by SearchQuery. It will be removed when Lucene is upgraded to a version which no longer supports Filter.
e.g.
Add filters to a query using |
| Class and Description |
|---|
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
| Class and Description |
|---|
| SearchQuery
A query to be performed against the search index.
|
| Class and Description |
|---|
| ContentPermissionCalculator
Calculates encoded string of content permission.
|
| ContentPermissionsQueryFactory
This factory creates a new
ContentPermissionsQuery instance if the user is not a superuser |
| Expandable
Interface that allows classes implemented it to be transformed into composition of primitive ones.
|
| SearchQuery
A query to be performed against the search index.
|
| SiteSearchPermissionsQueryFactory
This factory class creates a
SearchQuery instance for filtering the documents by permissions. |
| SpacePermissionQueryFactory
This factory class creates a
SearchQuery that takes the user's space permissions into account. |
| Class and Description |
|---|
| SearchResult
An individual search result.
|
| Class and Description |
|---|
| SearchQuery
A query to be performed against the search index.
|
| Class and Description |
|---|
| AtlassianDocumentBuilder |
| BatchUpdateAction
A simple functional interface for the batch update action
|
| CustomSearchIndexRegistry
This interface is available to plugins and allows 3rd-party vendors to add their own custom indexes
|
| InvalidSearchException
Superclass for exceptions thrown due to errors converting from a Search to the native search type.
|
| ISearch
A representation of a search to be performed.
|
| ScannedDocument
Contains the score and a field-value map of the underlying document returned by Lucene.
|
| ScoringStrategy
This enum contains all supported scoring strategies for index.
|
| SearchIndexAccessException |
| SearchIndexAccessor
An V2 interface which provides the following thread-safe actions on a search index:
Searching by
SearchIndexAccessor.search(ISearch, Set), SearchIndexAccessor.scan(SearchQuery, Set, Consumer)
Writing by SearchIndexAccessor.execute(SearchIndexAction)
Transactional execution of searches and writes via SearchIndexAccessor.withBatchUpdate(BatchUpdateAction)
Resets via SearchIndexAccessor.reset(Runnable)
Snapshotting via SearchIndexAccessor.reset(Runnable)
To hook into core search indexes behaviour (content and change index), inject the exposed beans via Spring. |
| SearchIndexAction |
| SearchIndexWriter
A mean to write to or remove a document from a search index.
|
| SearchQuery
A query to be performed against the search index.
|
| SearchResults
The results of a search.
|
| Class and Description |
|---|
| AtlassianDocument |
| AtlassianDocumentBuilder |
| Class and Description |
|---|
| InvalidSearchException
Superclass for exceptions thrown due to errors converting from a Search to the native search type.
|
| ISearch
A representation of a search to be performed.
|
| SearchFilter
Deprecated.
since 7.20,
SearchFilter has been replaced by SearchQuery. It will be removed when Lucene is upgraded to a version which no longer supports Filter.
e.g.
Add filters to a query using |
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
| SearchManager.Categorizer |
| SearchManager.EntityVersionPolicy
Determines how search results will be converted into entities by
SearchManager.convertToEntities(SearchResults, EntityVersionPolicy) and
SearchManager.searchEntities(ISearch, EntityVersionPolicy). |
| SearchQuery
A query to be performed against the search index.
|
| SearchResults
The results of a search.
|
| SearchTokenExpiredException
An exception thrown when the search token has expired.
|
| SearchWithToken
A search that additionally specifies a search token.
|
| Class and Description |
|---|
| BooleanQueryBuilder
Since 5.9
|
| SearchDecorator
Decorates a
ISearch with a custom logic e.g. |
| Class and Description |
|---|
| BooleanQueryBuilder
Since 5.9
|
| Class and Description |
|---|
| SearchResult
An individual search result.
|
| Class and Description |
|---|
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
| Class and Description |
|---|
| SearchSort
Represents some method for sorting search results, and the order in which to search them.
|
| Class and Description |
|---|
| SearchQuery
A query to be performed against the search index.
|
| Class and Description |
|---|
| ContentPermissionsQueryFactory
This factory creates a new
ContentPermissionsQuery instance if the user is not a superuser |
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
| SpacePermissionQueryFactory
This factory class creates a
SearchQuery that takes the user's space permissions into account. |
| Class and Description |
|---|
| SearchResult
An individual search result.
|
| Class and Description |
|---|
| SearchDecorator
Decorates a
ISearch with a custom logic e.g. |
| Class and Description |
|---|
| SearchQuery
A query to be performed against the search index.
|
| Class and Description |
|---|
| SearchQuery
A query to be performed against the search index.
|
| SearchSort
Represents some method for sorting search results, and the order in which to search them.
|
| SearchSort.Order
Enum defining the types of ordering supported.
|
| Class and Description |
|---|
| Range
Represent a set of data needed to perform a Lucene range queries.
|
| SearchQuery
A query to be performed against the search index.
|
| SearchSort
Represents some method for sorting search results, and the order in which to search them.
|
| SearchSort.Order
Enum defining the types of ordering supported.
|
| SearchSort.Type |
| Class and Description |
|---|
| AtlassianDocument |
| ContentPermissionCalculator
Calculates encoded string of content permission.
|
| CustomSearchIndexRegistry
This interface is available to plugins and allows 3rd-party vendors to add their own custom indexes
|
| DelegatingSearchIndexAccessor
An abstract delegating
SearchIndexAccessor that can be extended by a custom accessor. |
| SearchIndexAccessor
An V2 interface which provides the following thread-safe actions on a search index:
Searching by
SearchIndexAccessor.search(ISearch, Set), SearchIndexAccessor.scan(SearchQuery, Set, Consumer)
Writing by SearchIndexAccessor.execute(SearchIndexAction)
Transactional execution of searches and writes via SearchIndexAccessor.withBatchUpdate(BatchUpdateAction)
Resets via SearchIndexAccessor.reset(Runnable)
Snapshotting via SearchIndexAccessor.reset(Runnable)
To hook into core search indexes behaviour (content and change index), inject the exposed beans via Spring. |
| SpacePermissionQueryFactory
This factory class creates a
SearchQuery that takes the user's space permissions into account. |
| Class and Description |
|---|
| AtlassianDocument |
| ContentPermissionCalculator
Calculates encoded string of content permission.
|
| SearchIndexWriter
A mean to write to or remove a document from a search index.
|
| Class and Description |
|---|
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
| SiteSearchPermissionsQueryFactory
This factory class creates a
SearchQuery instance for filtering the documents by permissions. |
| Class and Description |
|---|
| InvalidSearchException
Superclass for exceptions thrown due to errors converting from a Search to the native search type.
|
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
| SearchResult
An individual search result.
|
| Class and Description |
|---|
| SearchResult
An individual search result.
|
| Class and Description |
|---|
| SearchResult
An individual search result.
|
| Class and Description |
|---|
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
| Class and Description |
|---|
| InvalidSearchException
Superclass for exceptions thrown due to errors converting from a Search to the native search type.
|
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
| SearchResults
The results of a search.
|
| SiteSearchPermissionsQueryFactory
This factory class creates a
SearchQuery instance for filtering the documents by permissions. |
| Class and Description |
|---|
| Expandable
Interface that allows classes implemented it to be transformed into composition of primitive ones.
|
| SearchQuery
A query to be performed against the search index.
|
| Class and Description |
|---|
| SearchResult
An individual search result.
|
| SearchResults
The results of a search.
|
| Class and Description |
|---|
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
| Class and Description |
|---|
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
| SearchResult
An individual search result.
|
| Class and Description |
|---|
| SearchResult
An individual search result.
|
| Class and Description |
|---|
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
| Class and Description |
|---|
| ISearch
A representation of a search to be performed.
|
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
| SearchQuery
A query to be performed against the search index.
|
| Class and Description |
|---|
| SearchIndexAccessor
An V2 interface which provides the following thread-safe actions on a search index:
Searching by
SearchIndexAccessor.search(ISearch, Set), SearchIndexAccessor.scan(SearchQuery, Set, Consumer)
Writing by SearchIndexAccessor.execute(SearchIndexAction)
Transactional execution of searches and writes via SearchIndexAccessor.withBatchUpdate(BatchUpdateAction)
Resets via SearchIndexAccessor.reset(Runnable)
Snapshotting via SearchIndexAccessor.reset(Runnable)
To hook into core search indexes behaviour (content and change index), inject the exposed beans via Spring. |
| SearchQuery
A query to be performed against the search index.
|
| SearchResult
An individual search result.
|
| Class and Description |
|---|
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
| SearchResult
An individual search result.
|
| Class and Description |
|---|
| SearchFilter
Deprecated.
since 7.20,
SearchFilter has been replaced by SearchQuery. It will be removed when Lucene is upgraded to a version which no longer supports Filter.
e.g.
Add filters to a query using |
| SearchQuery
A query to be performed against the search index.
|
| Class and Description |
|---|
| SearchIndexAccessor
An V2 interface which provides the following thread-safe actions on a search index:
Searching by
SearchIndexAccessor.search(ISearch, Set), SearchIndexAccessor.scan(SearchQuery, Set, Consumer)
Writing by SearchIndexAccessor.execute(SearchIndexAction)
Transactional execution of searches and writes via SearchIndexAccessor.withBatchUpdate(BatchUpdateAction)
Resets via SearchIndexAccessor.reset(Runnable)
Snapshotting via SearchIndexAccessor.reset(Runnable)
To hook into core search indexes behaviour (content and change index), inject the exposed beans via Spring. |
| SearchQuery
A query to be performed against the search index.
|
| Class and Description |
|---|
| AtlassianDocumentBuilder |
| SearchIndexAccessor
An V2 interface which provides the following thread-safe actions on a search index:
Searching by
SearchIndexAccessor.search(ISearch, Set), SearchIndexAccessor.scan(SearchQuery, Set, Consumer)
Writing by SearchIndexAccessor.execute(SearchIndexAction)
Transactional execution of searches and writes via SearchIndexAccessor.withBatchUpdate(BatchUpdateAction)
Resets via SearchIndexAccessor.reset(Runnable)
Snapshotting via SearchIndexAccessor.reset(Runnable)
To hook into core search indexes behaviour (content and change index), inject the exposed beans via Spring. |
| SearchIndexWriter
A mean to write to or remove a document from a search index.
|
| Class and Description |
|---|
| SearchQuery
A query to be performed against the search index.
|
| Class and Description |
|---|
| ISearch
A representation of a search to be performed.
|
| SearchQuery
A query to be performed against the search index.
|
| SearchSort
Represents some method for sorting search results, and the order in which to search them.
|
| SiteSearchPermissionsQueryFactory
This factory class creates a
SearchQuery instance for filtering the documents by permissions. |
| Class and Description |
|---|
| AbstractSearch
An abstract representation of a search to be performed.
|
| AtlassianDocument |
| BaseSearchResult
A simpler super interface of SearchResult.
|
| BatchUpdateAction
A simple functional interface for the batch update action
|
| BooleanOperator |
| BooleanQueryBuilder
Since 5.9
|
| ClauseType
Clause type in boolean query.
|
| CustomSearchIndexRegistry
This interface is available to plugins and allows 3rd-party vendors to add their own custom indexes
|
| Expandable
Interface that allows classes implemented it to be transformed into composition of primitive ones.
|
| HightlightParams
Parameters for highlighting in search.
|
| InvalidQueryException
Thrown when a smart list query could not be converted to an index query.
|
| InvalidSearchException
Superclass for exceptions thrown due to errors converting from a Search to the native search type.
|
| ISearch
A representation of a search to be performed.
|
| QueryFactory
Used by the query deserializer to map between key/parameters and
SearchQuery objects. |
| Range
Represent a set of data needed to perform a Lucene range queries.
|
| Range.Builder |
| ResultFilter
Deprecated.
since 5.5. Please consider implementing
SearchFilter. If you must
perform post search filtering, you can filter SearchResults returned by
the methods on SearchManager. |
| ScannedDocument
Contains the score and a field-value map of the underlying document returned by Lucene.
|
| ScoringStrategy
This enum contains all supported scoring strategies for index.
|
| SearchFilter
Deprecated.
since 7.20,
SearchFilter has been replaced by SearchQuery. It will be removed when Lucene is upgraded to a version which no longer supports Filter.
e.g.
Add filters to a query using |
| SearchIndexAccessException |
| SearchIndexAccessor
An V2 interface which provides the following thread-safe actions on a search index:
Searching by
SearchIndexAccessor.search(ISearch, Set), SearchIndexAccessor.scan(SearchQuery, Set, Consumer)
Writing by SearchIndexAccessor.execute(SearchIndexAction)
Transactional execution of searches and writes via SearchIndexAccessor.withBatchUpdate(BatchUpdateAction)
Resets via SearchIndexAccessor.reset(Runnable)
Snapshotting via SearchIndexAccessor.reset(Runnable)
To hook into core search indexes behaviour (content and change index), inject the exposed beans via Spring. |
| SearchIndexAction |
| SearchIndexWriter
A mean to write to or remove a document from a search index.
|
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
| SearchManager.Categorizer |
| SearchManager.EntityVersionPolicy
Determines how search results will be converted into entities by
SearchManager.convertToEntities(SearchResults, EntityVersionPolicy) and
SearchManager.searchEntities(ISearch, EntityVersionPolicy). |
| SearchQuery
A query to be performed against the search index.
|
| SearchResult
An individual search result.
|
| SearchResults
The results of a search.
|
| SearchResultType
Represents a confluence search result type.
|
| SearchSort
Represents some method for sorting search results, and the order in which to search them.
|
| SearchSort.Order
Enum defining the types of ordering supported.
|
| SearchSort.Type |
| SearchTokenExpiredException
An exception thrown when the search token has expired.
|
| SearchWithToken
A search that additionally specifies a search token.
|
| SubClause
A data class representing a sub clause within a query designed to easy traversal a query tree.
|
| Class and Description |
|---|
| ResultFilter
Deprecated.
since 5.5. Please consider implementing
SearchFilter. If you must
perform post search filtering, you can filter SearchResults returned by
the methods on SearchManager. |
| Class and Description |
|---|
| AbstractSearchResult
Abstract base implementation of SearchResult taken from LuceneSearchResult after removing dependency from Lucene classes
|
| BaseSearchResult
A simpler super interface of SearchResult.
|
| DefaultSearchResults
Default implementation of SearchResults
|
| InvalidSearchException
Superclass for exceptions thrown due to errors converting from a Search to the native search type.
|
| ISearch
A representation of a search to be performed.
|
| ResultFilter
Deprecated.
since 5.5. Please consider implementing
SearchFilter. If you must
perform post search filtering, you can filter SearchResults returned by
the methods on SearchManager. |
| SearchFilter
Deprecated.
since 7.20,
SearchFilter has been replaced by SearchQuery. It will be removed when Lucene is upgraded to a version which no longer supports Filter.
e.g.
Add filters to a query using |
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
| SearchManager.Categorizer |
| SearchManager.EntityVersionPolicy
Determines how search results will be converted into entities by
SearchManager.convertToEntities(SearchResults, EntityVersionPolicy) and
SearchManager.searchEntities(ISearch, EntityVersionPolicy). |
| SearchQuery
A query to be performed against the search index.
|
| SearchResult
An individual search result.
|
| SearchResultConverter |
| SearchResults
The results of a search.
|
| SearchSort
Represents some method for sorting search results, and the order in which to search them.
|
| SearchTokenExpiredException
An exception thrown when the search token has expired.
|
| SearchWithToken
A search that additionally specifies a search token.
|
| Class and Description |
|---|
| BooleanOperator |
| ResultFilter
Deprecated.
since 5.5. Please consider implementing
SearchFilter. If you must
perform post search filtering, you can filter SearchResults returned by
the methods on SearchManager. |
| SearchFilter
Deprecated.
since 7.20,
SearchFilter has been replaced by SearchQuery. It will be removed when Lucene is upgraded to a version which no longer supports Filter.
e.g.
Add filters to a query using |
| SearchQuery
A query to be performed against the search index.
|
| SearchSort
Represents some method for sorting search results, and the order in which to search them.
|
| Class and Description |
|---|
| BooleanOperator |
| BooleanQueryBuilder
Since 5.9
|
| Expandable
Interface that allows classes implemented it to be transformed into composition of primitive ones.
|
| Range
Represent a set of data needed to perform a Lucene range queries.
|
| SearchPrimitive
The annotated element as v2 search primitive means it is a building block for composing higher level search classes.
|
| SearchQuery
A query to be performed against the search index.
|
| SubClause
A data class representing a sub clause within a query designed to easy traversal a query tree.
|
| Class and Description |
|---|
| AbstractChainableSearchFilter
Deprecated.
since 7.20. There will be no replacement to extend. Use
BooleanQuery to chain equivalent SearchQuery.
See |
| BooleanOperator |
| BooleanQueryBuilder
Since 5.9
|
| Expandable
Interface that allows classes implemented it to be transformed into composition of primitive ones.
|
| Range
Represent a set of data needed to perform a Lucene range queries.
|
| SearchFilter
Deprecated.
since 7.20,
SearchFilter has been replaced by SearchQuery. It will be removed when Lucene is upgraded to a version which no longer supports Filter.
e.g.
Add filters to a query using |
| SearchPrimitive
The annotated element as v2 search primitive means it is a building block for composing higher level search classes.
|
| SearchQuery
A query to be performed against the search index.
|
| SearchResultType
Represents a confluence search result type.
|
| SubClause
A data class representing a sub clause within a query designed to easy traversal a query tree.
|
| Class and Description |
|---|
| Expandable
Interface that allows classes implemented it to be transformed into composition of primitive ones.
|
| SearchPrimitive
The annotated element as v2 search primitive means it is a building block for composing higher level search classes.
|
| SearchSort
Represents some method for sorting search results, and the order in which to search them.
|
| SearchSort.Order
Enum defining the types of ordering supported.
|
| SearchSort.Type |
| Class and Description |
|---|
| ISearch
A representation of a search to be performed.
|
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
| SiteSearchPermissionsQueryFactory
This factory class creates a
SearchQuery instance for filtering the documents by permissions. |
| Class and Description |
|---|
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
| Class and Description |
|---|
| InvalidSearchException
Superclass for exceptions thrown due to errors converting from a Search to the native search type.
|
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
| SearchTokenExpiredException
An exception thrown when the search token has expired.
|
| Class and Description |
|---|
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
| SiteSearchPermissionsQueryFactory
This factory class creates a
SearchQuery instance for filtering the documents by permissions. |
| Class and Description |
|---|
| SearchResult
An individual search result.
|
| Class and Description |
|---|
| SearchManager
A V2 interface which provides searching functionality on a search index.
|
Copyright © 2003–2022 Atlassian. All rights reserved.