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

Enum FOSearchCriterionMode

java.lang.Object

java.lang.Enum<FOSearchCriterionMode>

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

All Implemented Interfaces:

Serializable, Comparable<FOSearchCriterionMode>

public enum FOSearchCriterionMode
extends Enum<FOSearchCriterionMode>

The mode of a FOSearchCriterion

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FOSearchCriterionMode.FoWrappedValue	A WrappedValue, being the return type of getValue(org.ametys.web.frontoffice.search.instance.model.FOSearchCriterion, java.util.Map<java.lang.String, java.lang.Object>, java.util.Map<java.lang.String, java.lang.Object>).

Enum Constant Summary

Enum Constants

Enum Constant	Description
PROFILED_GROUPS_TAGS_INPUT	The criterion is proposed for content profiled by user group tag.
RESTRICTED_USER_INPUT	The criterion is proposed to the final user, with a restricted enumeration of choices.
STATIC	The criterion is static, i.e.
USER_INPUT	The criterion is proposed to the final user.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static org.slf4j.Logger	__LOGGER
static String	NONE_VALUE	The none value
static String	PROFILED_GROUPS_TAGS_VALUE	The profiled groups tags value

Constructor Summary

Constructors

Modifier	Constructor	Description
private	FOSearchCriterionMode()

Method Summary

Modifier and Type	Method	Description
abstract FOSearchCriterionMode.FoWrappedValue	getValue(FOSearchCriterion searchCriterion, Map<String,Object> finalUserCriteria, Map<String,Object> contextualParameters)	Gets the value from the criterion and the final user criteria.
boolean	isStatic()	true if the criterion is static
static FOSearchCriterionMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FOSearchCriterionMode[]	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

STATIC

public static final FOSearchCriterionMode STATIC

The criterion is static, i.e. valued by the webmaster and is not a proposed criterion to the final user.

USER_INPUT

public static final FOSearchCriterionMode USER_INPUT

The criterion is proposed to the final user.

RESTRICTED_USER_INPUT

public static final FOSearchCriterionMode RESTRICTED_USER_INPUT

The criterion is proposed to the final user, with a restricted enumeration of choices.

PROFILED_GROUPS_TAGS_INPUT

public static final FOSearchCriterionMode PROFILED_GROUPS_TAGS_INPUT

The criterion is proposed for content profiled by user group tag.

Field Detail

NONE_VALUE

public static final String NONE_VALUE

The none value

See Also:

Constant Field Values

PROFILED_GROUPS_TAGS_VALUE

public static final String PROFILED_GROUPS_TAGS_VALUE

The profiled groups tags value

See Also:

Constant Field Values

__LOGGER

static final org.slf4j.Logger __LOGGER

Constructor Detail

FOSearchCriterionMode

private FOSearchCriterionMode()

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public abstract FOSearchCriterionMode.FoWrappedValue getValue(FOSearchCriterion searchCriterion,
                                                              Map<String,Object> finalUserCriteria,
                                                              Map<String,Object> contextualParameters)

Gets the value from the criterion and the final user criteria.

Parameters:

searchCriterion - The FOSearchCriterion which is in this mode

finalUserCriteria - The criteria from the final user

contextualParameters - The contextual parameters

Returns:

the value

isStatic

public boolean isStatic()

true if the criterion is static

Returns:

true if the criterion is static