Package com.broadleafcommerce.cartoperation.service.status.quote

Class QuotePublishedStatusHandler

java.lang.Object

com.broadleafcommerce.cartoperation.service.status.AbstractCartStatusChangeHandler

com.broadleafcommerce.cartoperation.service.status.quote.AbstractQuoteCartStatusHandler

com.broadleafcommerce.cartoperation.service.status.quote.QuotePublishedStatusHandler

All Implemented Interfaces:

CartStatusHandler

public class QuotePublishedStatusHandler
extends AbstractQuoteCartStatusHandler

Handles a Cart in or changing to the DefaultQuoteStatuses.PUBLISHED status.

Field Summary

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

INACCESSIBLE_CART_STATUS, USER_AUTHENTICATION_FAILED

Constructor Summary

Constructors

Constructor	Description
QuotePublishedStatusHandler(com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils authenticationUtils, com.broadleafcommerce.common.extension.TypeFactory typeFactory, QuoteAuthUtils quoteAuthUtils, com.broadleafcommerce.cart.client.properties.QuoteProperties properties)

Method Summary

Modifier and Type	Method	Description
protected boolean	canBeReadByUser(@NonNull CartStatusValidationRequest statusValidationRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Determines if the cart can be read by the currently authenticated user when the cart's current status is AbstractCartStatusChangeHandler.getStatusToHandle().
protected boolean	canBeTransitionedToByUser(@NonNull ChangeCartStatusRequest changeStatusRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Determines if the cart can be transitioned to AbstractCartStatusChangeHandler.getStatusToHandle() by the currently authenticated user.
protected boolean	canBeUpdatedByUser(@NonNull CartStatusValidationRequest statusValidationRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Published quote's items should not be edited, must shift into DefaultQuoteStatuses.EDITING first by the buyer.
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.quote.AbstractQuoteCartStatusHandler

addCartActionAuditUserInfo, canHandle, getProperties, getQuoteAuthUtils, isAssignedToThisQuote, isAssignedToThisQuote, isConvertingToQuote

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

buildCartActionAuditToCreate, 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

Constructor Details

QuotePublishedStatusHandler

public QuotePublishedStatusHandler(com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils authenticationUtils,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 QuoteAuthUtils quoteAuthUtils,
 com.broadleafcommerce.cart.client.properties.QuoteProperties properties)

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(@Nullable
 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()

canBeReadByUser

protected boolean canBeReadByUser(@NonNull
 @NonNull CartStatusValidationRequest statusValidationRequest,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from class: AbstractCartStatusChangeHandler

Determines if the cart can be read by the currently authenticated user when the cart's current status is AbstractCartStatusChangeHandler.getStatusToHandle().

This is helpful to restrict certain user types to read a cart in certain statuses.

For example, in a B2B quote context, a sales rep should not be able to read quotes in the DefaultQuoteStatuses.DRAFTING status, only the cart owner can.

Overrides:

canBeReadByUser in class AbstractCartStatusChangeHandler

Parameters:

statusValidationRequest - the ChangeCartStatusRequest to facilitate the cart status change

contextInfo - context information surrounding sandboxing and multitenant state

Returns:

true if it is readable by the user, otherwise false

canBeUpdatedByUser

protected boolean canBeUpdatedByUser(@NonNull
 @NonNull CartStatusValidationRequest statusValidationRequest,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Published quote's items should not be edited, must shift into DefaultQuoteStatuses.EDITING first by the buyer.

Flows that do not update items are allowed, such as process checkout, update address, etc.

Overrides:

canBeUpdatedByUser in class AbstractCartStatusChangeHandler

Parameters:

statusValidationRequest - the CartStatusValidationRequest to facilitate the cart status validation

contextInfo - context information surrounding sandboxing and multitenant state

Returns:

true if it is updatable by the user, otherwise false

canBeTransitionedToByUser

protected boolean canBeTransitionedToByUser(@NonNull
 @NonNull ChangeCartStatusRequest changeStatusRequest,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from class: AbstractCartStatusChangeHandler

Determines if the cart can be transitioned to AbstractCartStatusChangeHandler.getStatusToHandle() by the currently authenticated user.

This is helpful to restrict certain user types to update a cart in certain statuses.

For example, in a B2B quote context, only the sales rep can transition a quote from DefaultQuoteStatuses.ASSIGNED to DefaultQuoteStatuses.PUBLISHED.

Overrides:

canBeTransitionedToByUser in class AbstractCartStatusChangeHandler

Parameters:

changeStatusRequest - the ChangeCartStatusRequest to facilitate the cart status change

contextInfo - context information surrounding sandboxing and multitenant state

Returns:

true if it can be transitioned to the status by the user, otherwise false

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.