Package com.atlassian.confluence.search.v2.query

Class ContentStatusQuery

java.lang.Object

com.atlassian.confluence.search.v2.query.ContentStatusQuery

All Implemented Interfaces:

Expandable<SearchQuery>, SearchQuery

public class ContentStatusQuery
extends Object
implements SearchQuery

SearchQuery which matches content by their content status.

Since:

7.20

Field Summary

Fields

Modifier and Type	Field	Description
static ContentStatusQuery	CURRENT
static String	KEY

Constructor Summary

Constructors

Constructor	Description
ContentStatusQuery(ContentStatus... contentStatuses)
ContentStatusQuery(Collection<ContentStatus> contentStatuses)	Constructs a SearchQuery which matches content by their content statuses.

Method Summary

Modifier and Type	Method	Description
SearchQuery	expand()	Expands this query into a composite query (that composes other queries).
Collection<ContentStatus>	getContentStatuses()
static SearchQuery	getDefaultContentStatusQuery()	The default SearchQuery will only match content which has the current status.
String	getKey()
List	getParameters()	List of parameters as Strings or SearchQuerys.

Methods inherited from class java.lang.Object

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

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

getBoost, getSubClauses

Field Detail

KEY

public static final String KEY

See Also:

Constant Field Values

CURRENT

public static final ContentStatusQuery CURRENT

Constructor Detail

ContentStatusQuery

public ContentStatusQuery(Collection<ContentStatus> contentStatuses)

Constructs a SearchQuery which matches content by their content statuses. Content must match at least one of the provided content statuses.

ContentStatusQuery

public ContentStatusQuery(ContentStatus... contentStatuses)

Method Detail

getDefaultContentStatusQuery

public static SearchQuery getDefaultContentStatusQuery()

The default SearchQuery will only match content which has the current status.

getKey

public String getKey()

Specified by:

getKey in interface SearchQuery

Returns:

the plugin key

getParameters

public List getParameters()

Description copied from interface: SearchQuery

List of parameters as Strings or SearchQuerys.

Specified by:

getParameters in interface SearchQuery

Returns:

Strings or SearchQuerys.

expand

public SearchQuery expand()

Description copied from interface: SearchQuery

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

Specified by:

expand in interface Expandable<SearchQuery>

Specified by:

expand in interface SearchQuery

Returns:

a query

getContentStatuses

public Collection<ContentStatus> getContentStatuses()