Package com.broadleafcommerce.pricing.domain.type

Enum ModifiableFieldsMap

java.lang.Object

java.lang.Enum<ModifiableFieldsMap>

com.broadleafcommerce.pricing.domain.type.ModifiableFieldsMap

All Implemented Interfaces:

Serializable, Comparable<ModifiableFieldsMap>

public enum ModifiableFieldsMap
extends Enum<ModifiableFieldsMap>

Specifies what priceable fields can be modified by PriceList PriceModifiers for specific PriceList types.

Author:

Nathan Moore (nathanmoore).

See Also:

PriceableFieldType

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTRACT	Contract price lists can additionally modify standard (price list) prices and sale (price list) prices.
SALE	Sale price lists can additionally modify standard (price list) prices.
STANDARD	Standard price lists only modify PriceableFieldType.BASE_PRICE or PriceableFieldType.BASE_COST by default.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STANDARD

public static final ModifiableFieldsMap STANDARD

Standard price lists only modify PriceableFieldType.BASE_PRICE or PriceableFieldType.BASE_COST by default.

SALE

public static final ModifiableFieldsMap SALE

Sale price lists can additionally modify standard (price list) prices.

CONTRACT

public static final ModifiableFieldsMap CONTRACT

Contract price lists can additionally modify standard (price list) prices and sale (price list) prices.

Method Detail

values

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

Returns:

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

valueOf

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

fields

@NonNull
public Set<String> fields()

fieldsForType

@NonNull
public static Set<String> fieldsForType(String type)

toString

public String toString()

Overrides:

toString in class Enum<ModifiableFieldsMap>