Package com.broadleafcommerce.bulk.support

Enum BulkUpdateStatus

java.lang.Object

java.lang.Enum<BulkUpdateStatus>

com.broadleafcommerce.bulk.support.BulkUpdateStatus

All Implemented Interfaces:

Serializable, Comparable<BulkUpdateStatus>

public enum BulkUpdateStatus
extends Enum<BulkUpdateStatus>

Represents the status of a BulkUpdate operation.

Author:

Samarth Dhruva (samarthd)

See Also:

BulkUpdate.status

Enum Constant Summary

Enum Constants

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

Method Summary

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

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

PROCESSING

public static final BulkUpdateStatus PROCESSING

Indicates that the bulk update is currently being processed.

This should be set by the ProcessBulkUpdateRequestListener when it begins processing an update.

FINISHED

public static final BulkUpdateStatus FINISHED

Indicates that the bulk update has completed successfully.

ERROR

public static final BulkUpdateStatus ERROR

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

Method Detail

values

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

Returns:

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

valueOf

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