Package com.broadleafcommerce.cartoperation.web.endpoint.domain.checkout

Class CheckoutResponse

  • All Implemented Interfaces:
    Serializable
    public class CheckoutResponse
extends Object
implements Serializable
    DTO for communicating the results of a checkout submission
    Author:
    Chris Kittrell (ckittrell)
    See Also:
    Serialized Form

    • Constructor Detail

      • CheckoutResponse

        public CheckoutResponse()

    • Method Detail

      • getCart

        public com.broadleafcommerce.cart.client.domain.Cart getCart()
        The Cart related to the checkout submission.
        Returns:
        The Cart related to the checkout submission.

      • isSuccess

        public boolean isSuccess()
        Whether or not the checkout submission was successful.
        Returns:
        Whether or not the checkout submission was successful.

      • getFailureType

        public String getFailureType()
        The type of checkout failure which can be used programmatically by the client application to react to the failure. Note: This should only be populated if isSuccess() is false.
        Returns:
        The type of checkout failure
        See Also:
        CheckoutFailureType

      • getFailureMessage

        public String getFailureMessage()
        Message intended to inform why the checkout submission failed if isSuccess() is false.
        Returns:
        Message intended to inform why the checkout submission failed if isSuccess() is false.

      • getItemFailureMessages

        public Map<String,​String> getItemFailureMessages()
        Line item error messages used to describe issues with individual fields, cart items, etc. For example, this may consist of map entries where the key is a cart item id (or name) & the value is an explanation of why the item is misconfigured.
        Returns:
        Line item error messages used to describe issues with individual fields, cart items, etc.

      • getRequestId

        public String getRequestId()
        The id representing the customer's request to checkout
        Returns:
        The id representing the customer's request to checkout

      • setCart

        public void setCart​(com.broadleafcommerce.cart.client.domain.Cart cart)
        The Cart related to the checkout submission.
        Parameters:
        cart - The Cart related to the checkout submission.

      • setSuccess

        public void setSuccess​(boolean success)
        Whether or not the checkout submission was successful.
        Parameters:
        success - Whether or not the checkout submission was successful.

      • setFailureType

        public void setFailureType​(String failureType)
        The type of checkout failure which can be used programmatically by the client application to react to the failure. Note: This should only be populated if isSuccess() is false.
        Parameters:
        failureType - The type of checkout failure
        See Also:
        CheckoutFailureType

      • setFailureMessage

        public void setFailureMessage​(String failureMessage)
        Message intended to inform why the checkout submission failed if isSuccess() is false.
        Parameters:
        failureMessage - Message intended to inform why the checkout submission failed if isSuccess() is false.

      • setItemFailureMessages

        public void setItemFailureMessages​(Map<String,​String> itemFailureMessages)
        Line item error messages used to describe issues with individual fields, cart items, etc. For example, this may consist of map entries where the key is a cart item id (or name) & the value is an explanation of why the item is misconfigured.
        Parameters:
        itemFailureMessages - Line item error messages used to describe issues with individual fields, cart items, etc.

      • setRequestId

        public void setRequestId​(String requestId)
        The id representing the customer's request to checkout
        Parameters:
        requestId - The id representing the customer's request to checkout