com.atlassian.confluence.plugins.retentionrules.impl.service.search.query

Class RetentionRulesQuery

java.lang.Object

com.atlassian.confluence.plugins.retentionrules.impl.service.search.query.RetentionRulesQuery

All Implemented Interfaces:

Expandable<SearchQuery>, SearchQuery

public class RetentionRulesQuery
extends Object
implements SearchQuery

Retention rules filter marker, which is used in v2 search to filter out spaces without retention policies.

Since:

7.20

Constructor Summary

Constructors

Constructor and Description
RetentionRulesQuery(Collection<String> spacesWithRetentionPolicies) Construct a SearchQuery that filters out spaces without retention policies

Method Summary

Modifier and Type	Method and Description
String	getKey()
List	getParameters() List of parameters as Strings or SearchQuerys.
Collection<String>	getSpacesWithRetentionPolicies()

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

expand, getBoost, getSubClauses

Constructor Detail

RetentionRulesQuery

public RetentionRulesQuery(Collection<String> spacesWithRetentionPolicies)

Construct a SearchQuery that filters out spaces without retention policies

Parameters:

spacesWithRetentionPolicies - a list of spaces with retention policies

Throws:

IllegalArgumentException - if spacesWithRetentionPolicies is null

Method Detail

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.

getSpacesWithRetentionPolicies

public Collection<String> getSpacesWithRetentionPolicies()