Package com.broadleafcommerce.dataimport.domain

Enum ImportStatus

java.lang.Object
java.lang.Enum<ImportStatus>
com.broadleafcommerce.dataimport.domain.ImportStatus
All Implemented Interfaces:
Serializable, Comparable<ImportStatus>
public enum ImportStatus extends Enum<ImportStatus>
Author:
Phillip Verheyden (phillipuniverse)

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CANCELLED
    The import has some partial success/failure but the user indicated that it should be cancelled
    COMPLETED
    The entire import completed.
    FAILED
    The import was hanging or encountered some error that prevented it from completing.
    PAUSED
    The import is not currently running but can be resumed later
    PROCESSING
    The import is currently being processed
    REQUESTED
    The user has uploaded the file and the import has been scheduled but it has not attempted processing yet

  • Method Summary

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

    • REQUESTED

      public static final ImportStatus REQUESTED
      The user has uploaded the file and the import has been scheduled but it has not attempted processing yet

    • PROCESSING

      public static final ImportStatus PROCESSING
      The import is currently being processed

    • CANCELLED

      public static final ImportStatus CANCELLED
      The import has some partial success/failure but the user indicated that it should be cancelled

    • PAUSED

      public static final ImportStatus PAUSED
      The import is not currently running but can be resumed later

    • FAILED

      public static final ImportStatus FAILED
      The import was hanging or encountered some error that prevented it from completing.

    • COMPLETED

      public static final ImportStatus COMPLETED
      The entire import completed. It may have completed with no errors, or completed with some errors. For these details, the Import.errorCount and Import.successCount should be checked.

  • Method Details

    • values

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