com.flexive.shared.search
Enum FxSQLSearchParams.CacheMode

java.lang.Object
  extended by java.lang.Enum<FxSQLSearchParams.CacheMode>
      extended by com.flexive.shared.search.FxSQLSearchParams.CacheMode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<FxSQLSearchParams.CacheMode>
Enclosing class:
FxSQLSearchParams

public static enum FxSQLSearchParams.CacheMode
extends java.lang.Enum<FxSQLSearchParams.CacheMode>

The cache modes of the search.

  • OFF: No caching will be used at all.
  • ON: The search will try to find the query result from its cache, and writes the result to the cache for the next similar querys to find it
  • READ_ONLY: The search will try to find the query result from its cache, but will not write the result to the cache

  • Enum Constant Summary
    OFF
               
    ON
               
    READ_ONLY
               
     
    Method Summary
    static FxSQLSearchParams.CacheMode getById(int id)
              Get a CacheMode by its id
     int getId()
              Getter for the internal id
    static FxSQLSearchParams.CacheMode valueOf(java.lang.String name)
              Returns the enum constant of this type with the specified name.
    static FxSQLSearchParams.CacheMode[] 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

    OFF

    public static final FxSQLSearchParams.CacheMode OFF

    READ_ONLY

    public static final FxSQLSearchParams.CacheMode READ_ONLY

    ON

    public static final FxSQLSearchParams.CacheMode ON
    Method Detail

    values

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

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

    valueOf

    public static FxSQLSearchParams.CacheMode valueOf(java.lang.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:
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    java.lang.NullPointerException - if the argument is null

    getId

    public int getId()
    Getter for the internal id

    Returns:
    internal id

    getById

    public static FxSQLSearchParams.CacheMode getById(int id)
                                               throws FxNotFoundException
    Get a CacheMode by its id

    Parameters:
    id - the id
    Returns:
    CacheMode the type
    Throws:
    FxNotFoundException - if the mode does not exist