com.inet.usersandgroups.api.user

Enum UserAccountType

java.lang.Object

java.lang.Enum<UserAccountType>

com.inet.usersandgroups.api.user.UserAccountType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<UserAccountType>

public enum UserAccountType
extends java.lang.Enum<UserAccountType>

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
Administrator
Guest
Standard

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCreateLabel() Returns localized label for adding a new user of this type.
java.lang.String	getDescription() Returns localized description for the user account type.
java.lang.String	getDisplayName() Returns the localized display name of the user account type.
static UserAccountType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static UserAccountType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Enum Constant Detail

Administrator

public static final UserAccountType Administrator

Guest

public static final UserAccountType Guest

Standard

public static final UserAccountType Standard

Method Detail

values

public static UserAccountType[] 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 (UserAccountType c : UserAccountType.values())
    System.out.println(c);

Returns:

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

valueOf

public static UserAccountType valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getDisplayName

public java.lang.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 java.lang.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 java.lang.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