com.atlassian.confluence.search.v2

Interface SearchFilter

All Known Implementing Classes:

AbstractChainableSearchFilter, AnonymousUserInfoSearchFilter, ArchivedSpacesSearchFilter, AuthorSearchFilter, ChainedSearchFilter, ContentPermissionsSearchFilter, DeactivatedUserSearchFilter, ExcludePersonalInformationSearchFilter, ExternallyDeletedUserSearchFilter, InSpaceSearchFilter, LabelsSearchFilter, LastModifierSearchFilter, LastModifierUserSearchFilter, SearchResultTypeSearchFilter, SiteSearchPermissionsSearchFilter, SpacePermissionsSearchFilter, ViewUserProfilePermissionsSearchFilter

public interface 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

Methods

Modifier and Type	Method and Description
SearchFilter	and(SearchFilter other) Combines this filter with the one specified, returning a new filter.
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