com.smartgwt.client.types
Enum FetchMode

java.lang.Object
  extended by java.lang.Enum<FetchMode>
      extended by com.smartgwt.client.types.FetchMode
All Implemented Interfaces:
ValueEnum, Serializable, Comparable<FetchMode>

public enum FetchMode
extends Enum<FetchMode>
implements ValueEnum

Mode of fetching records from the server.

Generally, "paged" mode should be used unless the maximum number of records is guaranteed to be small.


Enum Constant Summary
BASIC
          All records that match the current filter are fetched.
LOCAL
          All records available from the DataSource are fetched.
PAGED
          Only requested ranges of records are fetched, with predictive fetch ahead.
 
Method Summary
 String getValue()
           
static FetchMode valueOf(String name)
          Returns the enum constant of this type with the specified name.
static FetchMode[] 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

BASIC

public static final FetchMode BASIC
All records that match the current filter are fetched. Sorting is performed on the client


PAGED

public static final FetchMode PAGED
Only requested ranges of records are fetched, with predictive fetch ahead. Sorting is performed on the server.


LOCAL

public static final FetchMode LOCAL
All records available from the DataSource are fetched. Filtering by search criteria and sorting are both performed on the client

Method Detail

values

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

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

valueOf

public static FetchMode 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 String getValue()
Specified by:
getValue in interface ValueEnum