Package com.broadleafcommerce.billing.job.domain.enums

Enum Class TaxProcessingResultEnum

java.lang.Object

java.lang.Enum<TaxProcessingResultEnum>

com.broadleafcommerce.billing.job.domain.enums.TaxProcessingResultEnum

All Implemented Interfaces:

Serializable, Comparable<TaxProcessingResultEnum>, Constable

public enum TaxProcessingResultEnum
extends Enum<TaxProcessingResultEnum>

Enumeration result values for tax calculation in TaxCalculationProcessorHandler.

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
FAILURE	Deprecated. DefaultDelegatingTaxService does not recognize this state.
GATEWAY_ERROR	This value means the tax provider threw any Exception when attempting to execute the tax calculation.
NOT_PROCESSED	This value means the tax has not been calculated yet.
SUCCESS	This value means the tax has been successfully calculated for all taxable items.

Method Summary

Modifier and Type	Method	Description
static TaxProcessingResultEnum	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TaxProcessingResultEnum[]	values()	Returns an array containing the constants of this enum class, 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

NOT_PROCESSED

public static final TaxProcessingResultEnum NOT_PROCESSED

This value means the tax has not been calculated yet. A request with this value is not created by the OOB framework.

SUCCESS

public static final TaxProcessingResultEnum SUCCESS

This value means the tax has been successfully calculated for all taxable items.

FAILURE

public static final TaxProcessingResultEnum FAILURE

Deprecated.

DefaultDelegatingTaxService does not recognize this state. It either succeeds in its tax calculations, or an Exception is thrown and GATEWAY_ERROR becomes the result

GATEWAY_ERROR

public static final TaxProcessingResultEnum GATEWAY_ERROR

This value means the tax provider threw any Exception when attempting to execute the tax calculation. Details about this exception will be added to the TaxProcessingResult object.

Method Details

values

public static TaxProcessingResultEnum[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static TaxProcessingResultEnum valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null