Package org.ametys.web.frontoffice.search.instance.model

Enum Class SiteContextType

java.lang.Object

java.lang.Enum<SiteContextType>

org.ametys.web.frontoffice.search.instance.model.SiteContextType

All Implemented Interfaces:

Serializable, Comparable<SiteContextType>, java.lang.constant.Constable

public enum SiteContextType
extends Enum<SiteContextType>

A site context 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
ALL	The site of the context can be any site.
AMONG	The site of the context can be one among the ones returned by SiteContext.getSites().
CURRENT	The site of the context is the current one.
OTHERS	The site of the context can be any site but the current one.

Method Summary

Modifier and Type	Method	Description
String	clientSideName()	Gets the client side name of the type of site context
static SiteContextType	fromClientSideName(String clientSideName)	Gets a SiteContextType from its client-side name
static SiteContextType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SiteContextType[]	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

CURRENT

public static final SiteContextType CURRENT

The site of the context is the current one.

AMONG

public static final SiteContextType AMONG

The site of the context can be one among the ones returned by SiteContext.getSites().

ALL

public static final SiteContextType ALL

The site of the context can be any site.

OTHERS

public static final SiteContextType OTHERS

The site of the context can be any site but the current one.

Method Details

values

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

clientSideName

public String clientSideName()

Gets the client side name of the type of site context

Returns:

the client side name of the type of site context

fromClientSideName

public static SiteContextType fromClientSideName(String clientSideName)

Gets a SiteContextType from its client-side name

Parameters:

clientSideName - the client-side name

Returns:

the SiteContextType