Package org.exoplatform.portal.rest

Enum Class UserAccountRole

java.lang.Object

java.lang.Enum<UserAccountRole>

org.exoplatform.portal.rest.UserAccountRole

All Implemented Interfaces:

Serializable, Comparable<UserAccountRole>, Constable

public enum UserAccountRole
extends Enum<UserAccountRole>

The role an administrator gives to an account at its creation. It is the only client value that decides the account's memberships, among these three fixed values: no client value names a group or a membership type.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADMINISTRATOR	An internal user holding the membership the platform requires to grant administration rights
EXTERNAL	A member of the platform externals group instead of the platform users group
INTERNAL	A member of the platform users group, the membership every new account receives

Method Summary

Modifier and Type	Method	Description
static UserAccountRole	parse(String value)
static UserAccountRole	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UserAccountRole[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INTERNAL

public static final UserAccountRole INTERNAL

A member of the platform users group, the membership every new account receives

EXTERNAL

public static final UserAccountRole EXTERNAL

A member of the platform externals group instead of the platform users group

ADMINISTRATOR

public static final UserAccountRole ADMINISTRATOR

An internal user holding the membership the platform requires to grant administration rights

Method Details

values

public static UserAccountRole[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static UserAccountRole valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

parse

public static UserAccountRole parse(String value)

Parameters:

value - the role as sent by a client, case-insensitive

Returns:

the role, INTERNAL when the value is blank

Throws:

IllegalArgumentException - with message ROLE:INVALID when the value names none of the roles