Package com.smartgwt.client.types

Enum CacheSyncData

java.lang.Object
java.lang.Enum<CacheSyncData>
com.smartgwt.client.types.CacheSyncData
All Implemented Interfaces:
ValueEnum, Serializable, Comparable<CacheSyncData>, Constable
public enum CacheSyncData extends Enum<CacheSyncData> implements ValueEnum
How completely the records involved in a data-changing operation describe the rows they refer to, and so what automatic cache synchronization does with them. Set it on DSRequest.cacheSyncData or DSResponse.cacheSyncData.

Not to be confused with CacheSyncMode, which is a different question: that controls whether a component with no ResultSet picks such updates up at all, where this controls how much of a row each record is claiming to be.

  • Enum Constant Details

    • FULL

      public static final CacheSyncData FULL
      each record is the complete row. A field absent from a record is cleared, and a record matching no cached row is added. The default.

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

    • PARTIAL

      public static final CacheSyncData PARTIAL
      each record carries its primary keys plus only the fields that changed. Absent fields are left alone, explicitly null fields are cleared, and a record matching no cached row is ignored rather than added.

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

  • Method Details

    • values

      public static CacheSyncData[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

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