UserScope (XWiki Platform - Wiki - User - API 14.10.7 API)

java.lang.Object
- java.lang.Enum<UserScope>
- - org.xwiki.wiki.user.UserScope

All Implemented Interfaces:

Serializable, Comparable<UserScope>
```
public enum UserScope
extends Enum<UserScope>
```
Used to specify what kind of users are enabled on a wiki.

Since:

5.3M2

Version:

$Id: 60048edfcde84f0af9d147eafdd1654546529d41 $

Enum Constant Summary

Enum Constants
Enum Constant	Description
`GLOBAL_ONLY`	Only global users are available in the wiki.
`LOCAL_AND_GLOBAL`	Global and local users are both available in the wiki.
`LOCAL_ONLY`	Only local users are available in the wiki.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static UserScope`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static UserScope[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - LOCAL_ONLY
```
public static final UserScope LOCAL_ONLY
```
    Only local users are available in the wiki.
  - GLOBAL_ONLY
```
public static final UserScope GLOBAL_ONLY
```
    Only global users are available in the wiki.
  - LOCAL_AND_GLOBAL
```
public static final UserScope LOCAL_AND_GLOBAL
```
    Global and local users are both available in the wiki.
- Method Detail
  - values
```
public static UserScope[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (UserScope c : UserScope.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static UserScope valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null