Package com.smartgwt.client.types

# Enum PartialCommitOption

java.lang.Object
java.lang.Enum<PartialCommitOption>
com.smartgwt.client.types.PartialCommitOption

All Implemented Interfaces:
  `ValueEnum`, `Serializable`, `Comparable<PartialCommitOption>`, `Constable`

public enum PartialCommitOption extends Enum<PartialCommitOption> implements ValueEnum
Action to take if a user attempts to save the dataset produced by a `BatchUploader` whilst it still contains errors.

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from class java.lang.Enum

  `Enum.EnumDesc<E extends Enum<E>>`

- ## Enum Constant Summary

  Enum Constants
  Enum Constant
  Description
  `ALLOW`
  Silently allow the partial commit to proceed (note that this will result in the user losing those records that contain errors)
  `PREVENT`
  Pop up a message window showing the `BatchUploader.partialCommitError` and prevent the partial commit
  `PROMPT`
  Pop up a confirmation window with the `BatchUploader.partialCommitPrompt` and allow the user to choose whether or not to proceed
  `RETAIN`
  Commit any records that are error-free and remove them from the grid.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getValue()`
  `static PartialCommitOption`
  `valueOf(String name)`
  Returns the enum constant of this type with the specified name.
  `static PartialCommitOption[]`
  `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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

  ### Methods inherited from class java.lang.Object

  `getClass, notify, notifyAll, wait, wait, wait`

- ## Enum Constant Details

  - ### ALLOW

    public static final PartialCommitOption ALLOW
    Silently allow the partial commit to proceed (note that this will result in the user losing those records that contain errors)

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

  - ### PREVENT

    public static final PartialCommitOption PREVENT
    Pop up a message window showing the `BatchUploader.partialCommitError` and prevent the partial commit

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

  - ### PROMPT

    public static final PartialCommitOption PROMPT
    Pop up a confirmation window with the `BatchUploader.partialCommitPrompt` and allow the user to choose whether or not to proceed

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

  - ### RETAIN

    public static final PartialCommitOption RETAIN
    Commit any records that are error-free and remove them from the grid. If any records had errors, leave them in the grid and leave the grid visible. If no records had errors, run normal cleanup as we would for "allow". This option allows the user to fix errors iteratively, rather than having to fix everything upfront before committing

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

- ## Method Details

  - ### values

    public static PartialCommitOption[] 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 PartialCommitOption 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`