Package org.ametys.plugins.odfweb.service.search

Enum ProgramReturnable.DisplaySubprogramMode

java.lang.Object

java.lang.Enum<ProgramReturnable.DisplaySubprogramMode>

org.ametys.plugins.odfweb.service.search.ProgramReturnable.DisplaySubprogramMode

All Implemented Interfaces:

Serializable, Comparable<ProgramReturnable.DisplaySubprogramMode>

Enclosing class:

ProgramReturnable

static enum ProgramReturnable.DisplaySubprogramMode
extends Enum<ProgramReturnable.DisplaySubprogramMode>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Display all subprograms
ALL_WITH_HIGHLIGHT	Display all subprograms with highlighting those which match the search criteria
MATCHING_SEARCH_ONLY	Display matching subprograms only
NONE	Display no subprogram

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DisplaySubprogramMode()

Method Summary

Modifier and Type	Method	Description
static ProgramReturnable.DisplaySubprogramMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ProgramReturnable.DisplaySubprogramMode[]	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

NONE

public static final ProgramReturnable.DisplaySubprogramMode NONE

Display no subprogram

ALL

public static final ProgramReturnable.DisplaySubprogramMode ALL

Display all subprograms

ALL_WITH_HIGHLIGHT

public static final ProgramReturnable.DisplaySubprogramMode ALL_WITH_HIGHLIGHT

Display all subprograms with highlighting those which match the search criteria

MATCHING_SEARCH_ONLY

public static final ProgramReturnable.DisplaySubprogramMode MATCHING_SEARCH_ONLY

Display matching subprograms only

Constructor Detail

DisplaySubprogramMode

private DisplaySubprogramMode()

Method Detail

values

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

Returns:

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

valueOf

public static ProgramReturnable.DisplaySubprogramMode 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