com.broadleafcommerce.data.tracking.core.mapping

Class ForwardMapResponse

java.lang.Object

com.broadleafcommerce.data.tracking.core.mapping.ForwardMapResponse

public class ForwardMapResponse
extends Object

The result of a request to move the sandbox state of an entity forward in the approval flow

Author:

Jeff Fischer

Constructor Summary

Constructors

Constructor and Description
ForwardMapResponse(Trackable forwardState)

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Trackable	getForwardState() The resulting sandbox state
int	hashCode()
boolean	isOverride() Whether or not the state is an override of an item from another catalog.
boolean	isShouldArchiveOriginal() Whether or not the originating item for the promotion should be archived.
boolean	isShouldArchiveTarget() Whether or not the target of the promotion should be archived.
void	setOverride(boolean isOverride) Whether or not the state is an override of an item from another catalog.
void	setShouldArchiveOriginal(boolean shouldArchiveOriginal) Whether or not the originating item for the promotion should be archived.
void	setShouldArchiveTarget(boolean shouldArchiveTarget) Whether or not the target of the promotion should be archived.
String	toString()
ForwardMapResponse	withIsOverride(boolean isOverride)
ForwardMapResponse	withShouldArchiveOriginal(boolean shouldArchiveOriginal)
ForwardMapResponse	withShouldArchiveTarget(boolean shouldArchiveTarget)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ForwardMapResponse

public ForwardMapResponse(@NonNull
                          Trackable forwardState)

Method Detail

withShouldArchiveOriginal

public ForwardMapResponse withShouldArchiveOriginal(boolean shouldArchiveOriginal)

withShouldArchiveTarget

public ForwardMapResponse withShouldArchiveTarget(boolean shouldArchiveTarget)

withIsOverride

public ForwardMapResponse withIsOverride(boolean isOverride)

getForwardState

@NonNull
public Trackable getForwardState()

The resulting sandbox state

Returns:

The resulting sandbox state

isShouldArchiveOriginal

public boolean isShouldArchiveOriginal()

Whether or not the originating item for the promotion should be archived. This generally occurs when all promotable changes on an entity have been moved forward (i.e. all are ChangeDetail.getObsolete()).

Returns:

Whether or not the originating item for the promotion should be archived

isShouldArchiveTarget

public boolean isShouldArchiveTarget()

Whether or not the target of the promotion should be archived. This generally occurs when the during a deployment as the result of a delete promotion.

Returns:

Whether or not the target of the promotion should be archived

isOverride

public boolean isOverride()

Whether or not the state is an override of an item from another catalog. Only applies to deployments.

Returns:

Whether or not the state is an override of an item from another catalog

setShouldArchiveOriginal

public void setShouldArchiveOriginal(boolean shouldArchiveOriginal)

Whether or not the originating item for the promotion should be archived. This generally occurs when all promotable changes on an entity have been moved forward (i.e. all are ChangeDetail.getObsolete()).

Parameters:

shouldArchiveOriginal - Whether or not the originating item for the promotion should be archived

setShouldArchiveTarget

public void setShouldArchiveTarget(boolean shouldArchiveTarget)

Whether or not the target of the promotion should be archived. This generally occurs when the during a deployment as the result of a delete promotion.

Parameters:

shouldArchiveTarget - Whether or not the target of the promotion should be archived

setOverride

public void setOverride(boolean isOverride)

Whether or not the state is an override of an item from another catalog. Only applies to deployments.

Parameters:

isOverride - Whether or not the state is an override of an item from another catalog

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object