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

Class UpdateItemRequest

  • All Implemented Interfaces:
    CartVersionedRequest, Serializable
    public class UpdateItemRequest
extends CartItemModifyingRequest
implements Serializable
    A request DTO for updating a cart item. This is passed through CartOperationService#updateCartItem(Cart, String, UpdateItemRequest, boolean) and is used to inform the update of a CartItem.
    Author:
    Chris Kittrell (ckittrell), Chad Harchar (charchar)
    See Also:
    Serialized Form

    • Constructor Detail

      • UpdateItemRequest

        public UpdateItemRequest()

    • Method Detail

      • getCartItemId

        public String getCartItemId()
        ID of the CartItem to update.
        Returns:
        ID of the CartItem to update.

      • getVariantId

        public String getVariantId()
        The id of the variant for this add item request. Used to retrieve variant information for the cart item.
        Returns:
        The id of the variant for this add item request. Used to retrieve variant information for the cart item.

      • getQuantity

        public int getQuantity()
        The amount of this item to be added to the Cart.
        Returns:
        The amount of this item to be added to the Cart.

      • getItemAttributes

        public Map<String,​Object> getItemAttributes()
        Attributes that should be copied to the CartItem.getAttributes() for this request.
        Returns:
        Attributes that should be copied to the CartItem.getAttributes() for this request.

      • getItemAttributeChoices

        public Map<String,​String> getItemAttributeChoices()
        Attribute choices that should be copied to CartItem.getAttributeChoices() for this request.
        Returns:
        Attribute choices that should be copied to CartItem.getAttributeChoices() for this request.

      • getCartAttributes

        public Map<String,​Object> getCartAttributes()
        Attributes that should be copied to the Cart.getAttributes() for this request.
        Returns:
        Attributes that should be copied to the Cart.getAttributes() for this request.

      • getParentCartItemId

        public String getParentCartItemId()
        The id of the parent CartItem for this add item request. This would create a child CartItem of the parent.
        Returns:
        The id of the parent CartItem for this add item request. This would create a child CartItem of the parent.

      • setCartItemId

        public void setCartItemId​(String cartItemId)
        ID of the CartItem to update.
        Parameters:
        cartItemId - ID of the CartItem to update.

      • setVariantId

        public void setVariantId​(String variantId)
        The id of the variant for this add item request. Used to retrieve variant information for the cart item.
        Parameters:
        variantId - The id of the variant for this add item request. Used to retrieve variant information for the cart item.

      • setQuantity

        public void setQuantity​(int quantity)
        The amount of this item to be added to the Cart.
        Parameters:
        quantity - The amount of this item to be added to the Cart.

      • setItemAttributes

        public void setItemAttributes​(Map<String,​Object> itemAttributes)
        Attributes that should be copied to the CartItem.getAttributes() for this request.
        Parameters:
        itemAttributes - Attributes that should be copied to the CartItem.getAttributes() for this request.

      • setItemAttributeChoices

        public void setItemAttributeChoices​(Map<String,​String> itemAttributeChoices)
        Attribute choices that should be copied to CartItem.getAttributeChoices() for this request.
        Parameters:
        itemAttributeChoices - Attribute choices that should be copied to CartItem.getAttributeChoices() for this request.

      • setCartAttributes

        public void setCartAttributes​(Map<String,​Object> cartAttributes)
        Attributes that should be copied to the Cart.getAttributes() for this request.
        Parameters:
        cartAttributes - Attributes that should be copied to the Cart.getAttributes() for this request.

      • setDependentItemUpdates

        public void setDependentItemUpdates​(List<UpdateItemRequest> dependentItemUpdates)
        A list of additional AddItemRequests that should be processed as children items of the resulting parent item of this current UpdateItemRequest.
        Parameters:
        childCartItems - A list of additional AddItemRequests that should be processed as children items of the resulting parent item of this current UpdateItemRequest.

      • setParentCartItemId

        public void setParentCartItemId​(String parentCartItemId)
        The id of the parent CartItem for this add item request. This would create a child CartItem of the parent.
        Parameters:
        parentCartItemId - The id of the parent CartItem for this add item request. This would create a child CartItem of the parent.