com.smartgwt.client.types

Enum AdminSearches

java.lang.Object

java.lang.Enum<AdminSearches>

com.smartgwt.client.types.AdminSearches

All Implemented Interfaces:

ValueEnum, java.io.Serializable, java.lang.Comparable<AdminSearches>

public enum AdminSearches
extends java.lang.Enum<AdminSearches>
implements ValueEnum

Policy for choosing between admin searches fetched from the DataSource vs. those declared locally on a component.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOCALONLY Only report the records from adminSavedSearches.
PREFERLOCAL Combine both sets of records, but report the search record from adminSavedSearches if two records have the same search name.
PREFERSAVED Combine both sets of records, but report the search record from the DataSource if two records have the same search name.

Method Summary

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

PREFERSAVED

public static final AdminSearches PREFERSAVED

Combine both sets of records, but report the search record from the DataSource if two records have the same search name.

If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "preferSaved".

PREFERLOCAL

public static final AdminSearches PREFERLOCAL

Combine both sets of records, but report the search record from adminSavedSearches if two records have the same search name.

If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "preferLocal".

LOCALONLY

public static final AdminSearches LOCALONLY

Only report the records from adminSavedSearches.

If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "localOnly".

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public java.lang.String getValue()

Specified by:

getValue in interface ValueEnum