Package com.broadleafcommerce.cartoperation.service.status

Class CancelCartStatusHandler

java.lang.Object

com.broadleafcommerce.cartoperation.service.status.AbstractCartStatusChangeHandler

com.broadleafcommerce.cartoperation.service.status.CancelCartStatusHandler

All Implemented Interfaces:

CartStatusHandler

public class CancelCartStatusHandler
extends AbstractCartStatusChangeHandler
implements CartStatusHandler

Represents a request from a user to cancel or archive their cart.

Since:

Cart Operation Service 2.3.0, Release Train 2.3.0

Author:

Nathan Moore (nathandmoore)

Field Summary

Fields inherited from class com.broadleafcommerce.cartoperation.service.status.AbstractCartStatusChangeHandler

INACCESSIBLE_CART_STATUS, USER_AUTHENTICATION_FAILED

Constructor Summary

Constructors

Constructor	Description
CancelCartStatusHandler(com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils authenticationUtils, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected String	getCartActionType(ChangeCartStatusRequest cartStatusRequest)	Hook point to determine the cart action type.
protected String	getStatusToHandle()	Gets the status to handle by this handler
protected Set<String>	getValidOriginatingStatuses(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Gets a set of valid originating statuses that can transition to the AbstractCartStatusChangeHandler.getStatusToHandle().

Methods inherited from class com.broadleafcommerce.cartoperation.service.status.AbstractCartStatusChangeHandler

addCartActionAuditUserInfo, buildCartActionAuditToCreate, canBeReadByUser, canBeTransitionedToByUser, canBeUpdatedByUser, canHandle, getAuthenticationUtils, getPolicyUtils, getTypeFactory, isCartOwner, isCartOwner, postProcessStatusChange, process, processStatusChange, setPolicyUtils, validateOriginatingStatus, validateStatusIsReadableByUser, validateStatusIsUpdatableByUser, validateStatusTransition, validateTransitionRules

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.broadleafcommerce.cartoperation.service.status.CartStatusHandler

canHandle, process, validateStatusIsReadableByUser, validateStatusIsUpdatableByUser, validateStatusTransition

Constructor Details

CancelCartStatusHandler

public CancelCartStatusHandler(com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils authenticationUtils,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

getStatusToHandle

protected String getStatusToHandle()

Description copied from class: AbstractCartStatusChangeHandler

Gets the status to handle by this handler

Specified by:

getStatusToHandle in class AbstractCartStatusChangeHandler

Returns:

the status to handle by this handler

getValidOriginatingStatuses

protected Set<String> getValidOriginatingStatuses(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from class: AbstractCartStatusChangeHandler

Gets a set of valid originating statuses that can transition to the AbstractCartStatusChangeHandler.getStatusToHandle().

The valid originating statuses may vary depending on the context and certain quote configurations.

Specified by:

getValidOriginatingStatuses in class AbstractCartStatusChangeHandler

Parameters:

contextInfo - the contextInfo for the request

Returns:

a set of valid originating statuses that can transition to the AbstractCartStatusChangeHandler.getStatusToHandle()

getCartActionType

protected String getCartActionType(ChangeCartStatusRequest cartStatusRequest)

Description copied from class: AbstractCartStatusChangeHandler

Hook point to determine the cart action type.

Returns DefaultQuoteActionTypes.UNKNOWN by default unless overridden.

Overrides:

getCartActionType in class AbstractCartStatusChangeHandler

Parameters:

cartStatusRequest - the change cart status request

Returns:

DefaultQuoteActionTypes.UNKNOWN by default unless overridden.