de.fraunhofer.fokus.oefit.adhoc.custom

Enum E_Role

java.lang.Object

java.lang.Enum<E_Role>

de.fraunhofer.fokus.oefit.adhoc.custom.E_Role

All Implemented Interfaces:

Serializable, Comparable<E_Role>

public enum E_Role
extends Enum<E_Role>

An enum describing supported roles along with their default locations to redirect to after login. TODO: Should be made configurable in the settings

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADMIN The admin.
MGMT The mgmt.
NULL The null.
ORG The org.
SITEADMIN The siteadmin.
SITEGUEST The default site user = guest.

Method Summary

Modifier and Type	Method and Description
String	getDefaultName() Get the role's default name NOTE: If there is a getKey() referenced, this value might have changed in the system configuration.
String	getHomeUrl() Gets the home url.
E_ConfigKey	getKey() Gets the configuration key
int	getType() Gets the type.
static E_Role	valueOf(String name) Returns the enum constant of this type with the specified name.
static E_Role[]	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

NULL

public static final E_Role NULL

The null.

SITEGUEST

public static final E_Role SITEGUEST

The default site user = guest.

SITEADMIN

public static final E_Role SITEADMIN

The siteadmin.

ADMIN

public static final E_Role ADMIN

The admin.

ORG

public static final E_Role ORG

The org.

MGMT

public static final E_Role MGMT

The mgmt.

Method Detail

values

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

Returns:

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

valueOf

public static E_Role 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

getHomeUrl

public String getHomeUrl()

Gets the home url.

Returns:

the home url

getKey

public E_ConfigKey getKey()

Gets the configuration key

Returns:

the config key enum

getDefaultName

public String getDefaultName()

Get the role's default name NOTE: If there is a getKey() referenced, this value might have changed in the system configuration. Use CustomPortalServiceHandler.getRoleName() instead

Returns:

getType

public int getType()

Gets the type.

Returns:

the type