Scope (XWiki Platform - Old Core 14.10.19 API)

java.lang.Object
- com.xpn.xwiki.criteria.impl.Scope

```
public class Scope
extends Object
```
Immutable scope for retrieving statistics. A scope is associated with a single document but it can match any number of documents. Here, a document can be a page, a space, a wiki or the entire application as a unit. For instance, a scope associated with a space can match all the pages within that space.

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`GLOBAL_SCOPE`	The scope that is associated with the entire application as a unit
`static int`	`PAGE_SCOPE`	Any scope that is associated with a page
`static int`	`SPACE_SCOPE`	Any scope that is associated with a space
`static int`	`WIKI_SCOPE`	Any scope that is associated with a wiki

Constructor Summary

Constructors
Constructor Description

Scope(int type, String name, boolean deep)
Creates a new Scope instance with the specified field values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

String getName()

String getPattern()

int getType()

boolean isDeep()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PAGE_SCOPE
```
public static final int PAGE_SCOPE
```
    Any scope that is associated with a page
    
    See Also:
    
    Constant Field Values
  - SPACE_SCOPE
```
public static final int SPACE_SCOPE
```
    Any scope that is associated with a space
    
    See Also:
    
    Constant Field Values
  - WIKI_SCOPE
```
public static final int WIKI_SCOPE
```
    Any scope that is associated with a wiki
    
    See Also:
    
    Constant Field Values
  - GLOBAL_SCOPE
```
public static final int GLOBAL_SCOPE
```
    The scope that is associated with the entire application as a unit
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Scope
```
public Scope(int type,
             String name,
             boolean deep)
```
    Creates a new Scope instance with the specified field values.
    
    Parameters:
    
    type - The type of the scope
    
    name - The name of the document associated with this scope
    
    deep - true for matching all sub documents; false for matching the associated document as a unit
- Method Detail
  - getType
```
public int getType()
```
    See Also:
    
    type
  - getName
```
public String getName()
```
    See Also:
    
    name
  - isDeep
```
public boolean isDeep()
```
    See Also:
    
    deep
  - getPattern
```
public String getPattern()
```
    Returns:
    
    The pattern used for matching document names in the database