com.atlassian.confluence.search.v2

Interface SearchFilter

All Superinterfaces:

Expandable<SearchFilter>

All Known Implementing Classes:

AbstractChainableSearchFilter, AnonymousUserInfoSearchFilter, ArchivedSpacesSearchFilter, AuthorSearchFilter, BooleanSearchFilter, ChainedSearchFilter, ContentPermissionsSearchFilter, ContentStatusFilter, CustomContentTypeSearchFilter, DeactivatedUserSearchFilter, DisabledContentTypeSearchFilter, ExcludedContentTypeSearchFilter, ExcludePersonalInformationSearchFilter, ExternallyDeletedUserSearchFilter, FieldValueSearchFilter, InSpaceSearchFilter, LabelsSearchFilter, LastModifierSearchFilter, LastModifierUserSearchFilter, MatchAllDocsFilter, MatchNoDocsFilter, NonViewableContentTypeSearchFilter, PrefixSearchFilter, SearchResultTypeSearchFilter, ShadowedUserSearchFilter, SiteSearchPermissionsSearchFilter, SpaceCategorySearchFilter, SpacePermissionsSearchFilter, TermRangeSearchFilter, TermSearchFilter, TextSearchFilter, UnlicensedUserSearchFilter, ViewUserProfilePermissionsSearchFilter

public interface SearchFilter
extends Expandable<SearchFilter>

A filter to be performed against the search index during search time (not post results). Implementations should be immutable.

Search filters consist of a key (a unique string, usually a plugin module complete key, to identify the type of search filter being performed).

Method Summary

Modifier and Type	Method and Description
SearchFilter	and(SearchFilter other) Combines this filter with the one specified, returning a new filter.
default SearchFilter	expand() Expands this filter into a composite filter (that composes other filters).
String	getKey()
SearchFilter	or(SearchFilter other) Combines this filter with the one specified, returning a new filter.

Method Detail

getKey

String getKey()

Returns:

the plugin key

and

SearchFilter and(SearchFilter other)

Combines this filter with the one specified, returning a new filter. To pass the new filter, matches to both the original filters are required.

Parameters:

other - the other filter.

Returns:

a new filter

or

SearchFilter or(SearchFilter other)

Combines this filter with the one specified, returning a new filter. To pass the new filter, there must be a match in at least one of the original filters.

Parameters:

other - the other filter

Returns:

a new filter

expand

default SearchFilter expand()

Expands this filter into a composite filter (that composes other filters). By overriding this method, one can specify a new filter that is composition of the behaviour of the composed filters.

Specified by:

expand in interface Expandable<SearchFilter>

Returns:

a filter