Package com.inet.usersandgroups.api.user

Enum Class UserAccountType

java.lang.Object

java.lang.Enum<UserAccountType>

com.inet.usersandgroups.api.user.UserAccountType

All Implemented Interfaces:

Serializable, Comparable<UserAccountType>, Constable

public enum UserAccountType
extends Enum<UserAccountType>

The account type determine some possible features of a user and/or login.

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	The master user, has all rights, also with the hosting plugin.
Guest	Shared user for anonymous use if Guest Login Provider is configured.
Standard	The normal users.
Temp	No login is possible.

Method Summary

Modifier and Type	Method	Description
String	getCreateLabel()	Returns localized label for adding a new user of this type.
String	getDescription()	Returns localized description for the user account type.
String	getDisplayName()	Returns the localized display name of the user account type.
static UserAccountType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UserAccountType[]	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

Administrator

public static final UserAccountType Administrator

The master user, has all rights, also with the hosting plugin.

Guest

public static final UserAccountType Guest

Shared user for anonymous use if Guest Login Provider is configured. Member of 'All Users' group. Can't edit its own name and logo. Visible in user manager and maintenance. Login occur via URL prefix /public.

Standard

public static final UserAccountType Standard

The normal users. Counted for license.

Temp

public static final UserAccountType Temp

No login is possible. Creation only via API. Will be deleted if all of its HTTP sessions closed. Is NOT a member of 'All Users' group. All rights must be set explicit via API on creation. Can change its own name and logo. Is not shown in the user manager and maintenance.

Method Details

values

public static UserAccountType[] 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 UserAccountType 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

getDisplayName

public String getDisplayName()

Returns the localized display name of the user account type.

Returns:

the localized display name of the user account type.

Since:

inetcore 4.0

getCreateLabel

public String getCreateLabel()

Returns localized label for adding a new user of this type.

Returns:

localized label for adding a new user of this type.

Since:

inetcore 4.0

getDescription

public String getDescription()

Returns localized description for the user account type.

Returns:

localized description for the user account type. Can be null

Since:

inetcore 4.0