com.atlassian.confluence.search.v2.searchfilter

Class ContentStatusFilter

java.lang.Object

com.atlassian.confluence.search.v2.AbstractChainableSearchFilter

com.atlassian.confluence.search.v2.searchfilter.ContentStatusFilter

All Implemented Interfaces:

Expandable<SearchFilter>, SearchFilter

public class ContentStatusFilter
extends AbstractChainableSearchFilter

Filter content out of search results based on their content status, e.g. This is useful if we want to include drafts in the search results

Since:

6.4

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY

Constructor Summary

Constructors

Constructor and Description
ContentStatusFilter(Collection<ContentStatus> contentStatuses)
ContentStatusFilter(ContentStatus... contentStatuses)

Method Summary

Modifier and Type	Method and Description
SearchFilter	expand() Expands this filter into a composite filter (that composes other filters).
Collection<ContentStatus>	getContentStatuses()
static ContentStatusFilter	getDefaultStatusInstance()
String	getKey()

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

and, or

Methods inherited from class java.lang.Object

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

Field Detail

KEY

public static final String KEY

See Also:

Constant Field Values

Constructor Detail

ContentStatusFilter

public ContentStatusFilter(Collection<ContentStatus> contentStatuses)

ContentStatusFilter

public ContentStatusFilter(ContentStatus... contentStatuses)

Method Detail

getDefaultStatusInstance

public static ContentStatusFilter getDefaultStatusInstance()

getKey

public String getKey()

Returns:

the plugin key

getContentStatuses

public Collection<ContentStatus> getContentStatuses()

expand

public SearchFilter expand()

Description copied from interface: SearchFilter

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.

Returns:

a filter