org.rhq.core.domain.search
Enum SearchSubsystem

java.lang.Object
  java.lang.Enum<SearchSubsystem>
      org.rhq.core.domain.search.SearchSubsystem

All Implemented Interfaces:

Serializable, Comparable<SearchSubsystem>

public enum SearchSubsystem
extends Enum<SearchSubsystem>

The search mechanism is generic and, thus, suited to finding data in any RHQ subsystem, including its own. Each individual page in the UI can have different advanced syntax. This enum will serve as a unique identifier for which subsystem is currently active. You can think of it as a piece of meta-data that annotates each saved search, representing which context it belongs to. This will also affect which grammar is used to auto-complete search expressions.

Enum Constant Summary

GROUP

RESOURCE

Method Summary

static SearchSubsystem	get(Class<?> entityClass)
Class<?>	getEntityClass()
String	getName() A Java bean style getter to allow us to access the enum name from JSP or Facelets pages
static SearchSubsystem	valueOf(String name) Returns the enum constant of this type with the specified name.
static SearchSubsystem[]	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

RESOURCE

public static final SearchSubsystem RESOURCE

GROUP

public static final SearchSubsystem GROUP

Method Detail

values

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

Returns:

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

valueOf

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

getEntityClass

public Class<?> getEntityClass()

get

public static SearchSubsystem get(Class<?> entityClass)

getName

public String getName()

A Java bean style getter to allow us to access the enum name from JSP or Facelets pages

Returns:

the enum name