Package com.broadleafcommerce.sandbox.domain

Enum Class ChangeState

java.lang.Object

java.lang.Enum<ChangeState>

com.broadleafcommerce.sandbox.domain.ChangeState

All Implemented Interfaces:

Serializable, Comparable<ChangeState>, Constable

public enum ChangeState
extends Enum<ChangeState>

Used to keep track of the current state of ChangeSummaries and ChangeSummaryGroups.

Author:

Chad Harchar (charchar)

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
APPROVED	Indicates that a summary, group or deployment has been approved by a reviewer.
DEPLOYED	Indicates that a summary or group has been deployed to production and is now live.
PROMOTED	Indicates that a summary or group has been promoted by the user and is ready for review by a reviewer.
SCHEDULED	Indicates that a summary, group or deployment has been scheduled for deployment at a future date and time.
USER	The beginning state for a ChangeSummary.

Method Summary

Modifier and Type	Method	Description
static List<ChangeState>	validForDeployment()	Valid states that can successfully undergo a deployment.
static ChangeState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ChangeState[]	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

USER

public static final ChangeState USER

The beginning state for a ChangeSummary. Indicates that the change is in the User's sandbox only and can be further promoted or reverted along with other changes. This is not applicable to ChangeSummaryGroups.

PROMOTED

public static final ChangeState PROMOTED

Indicates that a summary or group has been promoted by the user and is ready for review by a reviewer. The reviewer can perform the actions of approving or rejecting on these changes.

APPROVED

public static final ChangeState APPROVED

Indicates that a summary, group or deployment has been approved by a reviewer.

SCHEDULED

public static final ChangeState SCHEDULED

Indicates that a summary, group or deployment has been scheduled for deployment at a future date and time.

DEPLOYED

public static final ChangeState DEPLOYED

Indicates that a summary or group has been deployed to production and is now live.

Method Details

values

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

validForDeployment

public static List<ChangeState> validForDeployment()

Valid states that can successfully undergo a deployment. By default, APPROVED and SCHEDULED, which means they are qualified to be apart of the deployment and go forward.

Returns:

the valid states that can be deployed