ArchivedSpacesQuery (Atlassian Confluence 8.7.1 API)

java.lang.Object
- com.atlassian.confluence.search.v2.query.ArchivedSpacesQuery

All Implemented Interfaces:

Expandable<SearchQuery>, SearchQuery
```
public class ArchivedSpacesQuery
extends Object
implements SearchQuery
```
Filters archived spaces (and their contents) out of search results. Can be inverted to only include archived spaces.

Since:

7.20

Field Summary

Fields
Modifier and Type Field Description

static String KEY
- Fields inherited from interface com.atlassian.confluence.search.v2.SearchQuery
  DEFAULT_BOOST

Constructor Summary

Constructors
Constructor Description

ArchivedSpacesQuery(boolean inverse, SpaceManager spaceManager)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`SearchQuery`	`expand()`	Expands this query into a composite query (that composes other queries).
`String`	`getKey()`
`List`	`getParameters()`	List of parameters as `String`s or `SearchQuery`s.
`int`	`hashCode()`
`boolean`	`isInverse()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, 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
- Constructor Detail
  - ArchivedSpacesQuery
```
public ArchivedSpacesQuery(boolean inverse,
                           SpaceManager spaceManager)
```
- 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.
  - 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
  - isInverse
```
public boolean isInverse()
```
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object