Package com.broadleafcommerce.common.dataexport.support

Enum ExportStatus

java.lang.Object

java.lang.Enum<ExportStatus>

com.broadleafcommerce.common.dataexport.support.ExportStatus

All Implemented Interfaces:

Serializable, Comparable<ExportStatus>

public enum ExportStatus
extends Enum<ExportStatus>

Represents the status of a Export operation.

Author:

Samarth Dhruva (samarthd)

See Also:

Export.status

Enum Constant Summary

Enum Constants

Enum Constant	Description
ERROR	Indicates that the export encountered an error and did not complete successfully.
FINISHED	Indicates that the export has completed successfully.
PROCESSING	Indicates that the export is currently being processed.
REQUESTED	Indicates that the export has been created, but has not yet begun processing.

Method Summary

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

REQUESTED

public static final ExportStatus REQUESTED

Indicates that the export has been created, but has not yet begun processing.

PROCESSING

public static final ExportStatus PROCESSING

Indicates that the export is currently being processed.

This should be set by the ProcessExportRequestListener when it begins processing an export.

FINISHED

public static final ExportStatus FINISHED

Indicates that the export has completed successfully.

ERROR

public static final ExportStatus ERROR

Indicates that the export encountered an error and did not complete successfully.

Method Detail

values

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

Returns:

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

valueOf

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