Package com.broadleafcommerce.data.tracking.core.type

Enum Class MutabilityType

java.lang.Object

java.lang.Enum<MutabilityType>

com.broadleafcommerce.data.tracking.core.type.MutabilityType

All Implemented Interfaces:

Serializable, Comparable<MutabilityType>, Constable

public enum MutabilityType
extends Enum<MutabilityType>

Enumerates the rules around which entities inherited from a Catalog may be modified when inherited. This comes into play when assigning catalogs to Applications or as parents of other catalogs. The basic types are REFERENCE and CUSTOMIZABLE.

When a new application is created, it may be assigned individual Catalogs. The mutability type determines whether users of that new application are able to modify the existing entities of those assigned catalogs. Likewise, Catalogs may be assigned parents from which they inherit, and, likewise, the mutability type controls whether those inherited entities may be modified in the child catalog.

It is important to note that when entities are modified on an application or in child catalog, those changes are local to that context and contexts that inherit from it. In a word, if 2 applications have the same customizable catalog assigned to each, changes made to the catalog on one application will not appear in the other. Likewise for catalogs assigned as parents of other catalogs. If the mutability type is CUSTOMIZABLE, then a child's edits are not visible in its siblings or its parent's contexts.

Author:

Jeff Fischer, Nathan Moore

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
CUSTOMIZABLE	Indicates that inherited entities are freely modifiable.
REFERENCE	Indicates that inherited entities are read only, or immutable.

Method Summary

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

REFERENCE

public static final MutabilityType REFERENCE

Indicates that inherited entities are read only, or immutable.

CUSTOMIZABLE

public static final MutabilityType CUSTOMIZABLE

Indicates that inherited entities are freely modifiable.

Method Details

values

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