CurrentCart

java.lang.Object
- sphere.CurrentCart

```
@ThreadSafe
public class CurrentCart
extends java.lang.Object
```
Shopping cart service that automatically accesses the cart associated to the current HTTP session.
A shopping cart stores most of the information that an Order does, e.g. a shipping address, and it is essentially an Order in progress. This means the CurrentCart is typically also used to implement checkout process.

Constructor Summary

Constructors
Constructor and Description
`CurrentCart(CartService cartService, OrderService orderService, java.util.Currency cartCurrency, Cart.InventoryMode inventoryMode)`

Method Summary

Methods
Modifier and Type	Method and Description
`Cart`	`addCustomLineItem(LocalizedString name, Money money, java.lang.String slug, ReferenceId<TaxCategory> taxCategory)` Adds a custom line item to the cart.
`Cart`	`addCustomLineItem(LocalizedString name, Money money, java.lang.String slug, ReferenceId<TaxCategory> taxCategory, int quantity)` Adds a custom line item with a specific quantity to the cart.
`play.libs.F.Promise<SphereResult<Cart>>`	`addCustomLineItemAsync(LocalizedString name, Money money, java.lang.String slug, ReferenceId<TaxCategory> taxCategory)` Adds a custom line item to the cart asynchronously.
`play.libs.F.Promise<SphereResult<Cart>>`	`addCustomLineItemAsync(LocalizedString name, Money money, java.lang.String slug, ReferenceId<TaxCategory> taxCategory, int quantity)` Adds a custom line item with a specific quantity to the cart asynchronously.
`Cart`	`addLineItem(java.lang.String productId, int quantity)` Adds product's master variant in given quantity to the cart.
`Cart`	`addLineItem(java.lang.String productId, int variantId, int quantity)` Adds a product variant in given quantity to the cart.
`play.libs.F.Promise<SphereResult<Cart>>`	`addLineItemAsync(java.lang.String productId, int quantity)` Adds product's master variant in the given quantity to the cart asynchronously.
`play.libs.F.Promise<SphereResult<Cart>>`	`addLineItemAsync(java.lang.String productId, int variantId, int quantity)` Adds a product variant in given quantity to the cart asynchronously.
`Cart`	`clearShippingAddress()` Clears the shipping address.
`play.libs.F.Promise<SphereResult<Cart>>`	`clearShippingAddressAsync()` Clears the shipping address asynchronously.
`java.lang.String`	`createCartSnapshotId()` Creates an cart snapshot identifier for the final page of a checkout process.
`Order`	`createOrder(CreateOrderBuilder createOrderBuilder)`
`Order`	`createOrder(PaymentState paymentState)` Transforms the cart into an order.
`Order`	`createOrder(java.lang.String cartSnapshotId, PaymentState paymentState)` Transforms the cart into an order.
`play.libs.F.Promise<SphereResult<Order>>`	`createOrderAsync(CreateOrderBuilder createOrderBuilder)`
`play.libs.F.Promise<SphereResult<Order>>`	`createOrderAsync(PaymentState paymentState)` Transforms the cart into an order asynchronously.
`play.libs.F.Promise<SphereResult<Order>>`	`createOrderAsync(java.lang.String cartSnapshotId, PaymentState paymentState)` Transforms the cart into an order asynchronously.
`Cart`	`decreaseLineItemQuantity(java.lang.String lineItemId, int quantity)` Decreases the quantity of given line item.
`play.libs.F.Promise<SphereResult<Cart>>`	`decreaseLineItemQuantityAsync(java.lang.String lineItemId, int quantity)` Decreases the quantity of the given line item asynchronously.
`Cart`	`fetch()` Fetches the cart object for the current session asynchronously.
`play.libs.F.Promise<Cart>`	`fetchAsync()` Fetches the cart object for the current session asynchronously.
`int`	`getQuantity()` Returns the number of items in the cart.
`boolean`	`isSafeToCreateOrder(java.lang.String cartSnapshotId)` Returns true if the `cartSnapshotId` matches the current cart id and version, and therefore it is certain that the cart was not modified in a different browser tab during checkout.
`Cart`	`recalculate()` Updates line item prices and tax rates.
`play.libs.F.Promise<SphereResult<Cart>>`	`recalculateAsync()` Updates line item prices and tax rates asynchronously.
`Cart`	`removeLineItem(java.lang.String lineItemId)` Removes a line item from the cart.
`play.libs.F.Promise<SphereResult<Cart>>`	`removeLineItemAsync(java.lang.String lineItemId)` Removes a line item from the cart asynchronously.
`Cart`	`setBillingAddress(Address address)` Sets the billing address.
`play.libs.F.Promise<SphereResult<Cart>>`	`setBillingAddressAsync(Address address)` Sets the billing address asynchronously.
`Cart`	`setCountry(com.neovisionaries.i18n.CountryCode country)` Sets the country of the cart and updates line item prices.
`play.libs.F.Promise<SphereResult<Cart>>`	`setCountryAsync(com.neovisionaries.i18n.CountryCode country)` Sets the country of the cart asynchronously and updates line item prices.
`Cart`	`setCustomerEmail(java.lang.String email)` Sets the customer email for the cart.
`play.libs.F.Promise<SphereResult<Cart>>`	`setCustomerEmailAsync(java.lang.String email)` Sets the customer email for the cart asynchronously.
`Cart`	`setCustomShippingMethod(java.lang.String shippingMethodName, ShippingRate shippingRate, ReferenceId<TaxCategory> taxCategory)` Sets a custom shipping method.
`play.libs.F.Promise<SphereResult<Cart>>`	`setCustomShippingMethodAsync(java.lang.String shippingMethodName, ShippingRate shippingRate, ReferenceId<TaxCategory> taxCategory)` Sets a custom shipping method of the cart asynchronously.
`Cart`	`setLineItemQuantity(java.lang.String lineItemId, int quantity)` Sets the quantity of given line item.
`play.libs.F.Promise<SphereResult<Cart>>`	`setLineItemQuantityAsync(java.lang.String lineItemId, int quantity)` Sets the quantity of the given line item asynchronously.
`Cart`	`setShippingAddress(Address address)` Sets the shipping address.
`play.libs.F.Promise<SphereResult<Cart>>`	`setShippingAddressAsync(Address address)` Sets the shipping address asynchronously.
`Cart`	`setShippingMethod(ReferenceId<ShippingMethod> shippingMethod)` Sets the shipping method of the cart.
`play.libs.F.Promise<SphereResult<Cart>>`	`setShippingMethodAsync(ReferenceId<ShippingMethod> shippingMethod)` Sets the shipping method of the cart asynchronously.
`Cart`	`update(CartUpdate update)` Updates the cart, doing several modifications using one request, described by the `update` object.
`play.libs.F.Promise<SphereResult<Cart>>`	`updateAsync(CartUpdate update)` Updates the cart asynchronously.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CurrentCart
```
public CurrentCart(CartService cartService,
           OrderService orderService,
           java.util.Currency cartCurrency,
           Cart.InventoryMode inventoryMode)
```
- Method Detail
  - fetch
```
public Cart fetch()
```
    Fetches the cart object for the current session asynchronously.
    Note: As an optimization, the cart is only created in the backend when user adds a first product in the cart. For users who haven't put anything in their cart yet, this method returns an empty dummy cart object without going to the backend.
    
    Returns:
    a cart
  - fetchAsync
```
public play.libs.F.Promise<Cart> fetchAsync()
```
    Fetches the cart object for the current session asynchronously.
    
    See Also:
    fetch.
  - getQuantity
```
public int getQuantity()
```
    Returns the number of items in the cart.
    This method exists purely as an optimization that lets you avoid calling fetch and then cart.getTotalQuantity, if you only need to display the number of items in the cart. The quantity stored in Play's session and updated automatically on all cart modifications.
  - addLineItem
```
public Cart addLineItem(java.lang.String productId,
               int variantId,
               int quantity)
```
    Adds a product variant in given quantity to the cart.
  - addLineItemAsync
```
public play.libs.F.Promise<SphereResult<Cart>> addLineItemAsync(java.lang.String productId,
                                                       int variantId,
                                                       int quantity)
```
    Adds a product variant in given quantity to the cart asynchronously.
  - addLineItem
```
public Cart addLineItem(java.lang.String productId,
               int quantity)
```
    Adds product's master variant in given quantity to the cart.
  - addLineItemAsync
```
public play.libs.F.Promise<SphereResult<Cart>> addLineItemAsync(java.lang.String productId,
                                                       int quantity)
```
    Adds product's master variant in the given quantity to the cart asynchronously.
  - addCustomLineItem
```
public Cart addCustomLineItem(LocalizedString name,
                     Money money,
                     java.lang.String slug,
                     ReferenceId<TaxCategory> taxCategory)
```
    Adds a custom line item to the cart.
  - addCustomLineItem
```
public Cart addCustomLineItem(LocalizedString name,
                     Money money,
                     java.lang.String slug,
                     ReferenceId<TaxCategory> taxCategory,
                     int quantity)
```
    Adds a custom line item with a specific quantity to the cart.
  - addCustomLineItemAsync
```
public play.libs.F.Promise<SphereResult<Cart>> addCustomLineItemAsync(LocalizedString name,
                                                             Money money,
                                                             java.lang.String slug,
                                                             ReferenceId<TaxCategory> taxCategory)
```
    Adds a custom line item to the cart asynchronously.
  - addCustomLineItemAsync
```
public play.libs.F.Promise<SphereResult<Cart>> addCustomLineItemAsync(LocalizedString name,
                                                             Money money,
                                                             java.lang.String slug,
                                                             ReferenceId<TaxCategory> taxCategory,
                                                             int quantity)
```
    Adds a custom line item with a specific quantity to the cart asynchronously.
  - removeLineItem
```
public Cart removeLineItem(java.lang.String lineItemId)
```
    Removes a line item from the cart.
  - removeLineItemAsync
```
public play.libs.F.Promise<SphereResult<Cart>> removeLineItemAsync(java.lang.String lineItemId)
```
    Removes a line item from the cart asynchronously.
  - decreaseLineItemQuantity
```
public Cart decreaseLineItemQuantity(java.lang.String lineItemId,
                            int quantity)
```
    Decreases the quantity of given line item. If after the update the quantity of the line item is not greater than 0 the line item is removed from the cart.
  - decreaseLineItemQuantityAsync
```
public play.libs.F.Promise<SphereResult<Cart>> decreaseLineItemQuantityAsync(java.lang.String lineItemId,
                                                                    int quantity)
```
    Decreases the quantity of the given line item asynchronously. If after the update the quantity of the line item is not greater than 0 the line item is removed from the cart.
  - setLineItemQuantity
```
public Cart setLineItemQuantity(java.lang.String lineItemId,
                       int quantity)
```
    Sets the quantity of given line item. If the quantity is 0 the line item is removed from the cart.
  - setLineItemQuantityAsync
```
public play.libs.F.Promise<SphereResult<Cart>> setLineItemQuantityAsync(java.lang.String lineItemId,
                                                               int quantity)
```
    Sets the quantity of the given line item asynchronously. If the quantity is 0, line item is removed from the cart.
  - setCustomerEmail
```
public Cart setCustomerEmail(java.lang.String email)
```
    Sets the customer email for the cart. Use this method if you want to create an order for an unregistered customer.
  - setCustomerEmailAsync
```
public play.libs.F.Promise<SphereResult<Cart>> setCustomerEmailAsync(java.lang.String email)
```
    Sets the customer email for the cart asynchronously. Use this method if you want to create an order for an unregistered customer.
  - setShippingAddress
```
public Cart setShippingAddress(Address address)
```
    Sets the shipping address. Setting the shipping address also sets the tax rates of the line items and calculates the taxed price. If null is passed, the shipping address is cleared (see clearShippingAddress).
  - setShippingAddressAsync
```
public play.libs.F.Promise<SphereResult<Cart>> setShippingAddressAsync(Address address)
```
    Sets the shipping address asynchronously. Setting the shipping address also sets the tax rates of the line items and calculates the taxed price. If null is passed, the shipping address is cleared (see clearShippingAddressAsync).
  - clearShippingAddress
```
public Cart clearShippingAddress()
```
    Clears the shipping address. Removes the shipping address, the taxed price and the tax rates of all line items.
  - clearShippingAddressAsync
```
public play.libs.F.Promise<SphereResult<Cart>> clearShippingAddressAsync()
```
    Clears the shipping address asynchronously. Removes the shipping address, taxed price and tax rates of all line items.
  - setBillingAddress
```
public Cart setBillingAddress(Address address)
```
    Sets the billing address.
  - setBillingAddressAsync
```
public play.libs.F.Promise<SphereResult<Cart>> setBillingAddressAsync(Address address)
```
    Sets the billing address asynchronously.
  - setCountry
```
public Cart setCountry(com.neovisionaries.i18n.CountryCode country)
```
    Sets the country of the cart and updates line item prices.
  - setCountryAsync
```
public play.libs.F.Promise<SphereResult<Cart>> setCountryAsync(com.neovisionaries.i18n.CountryCode country)
```
    Sets the country of the cart asynchronously and updates line item prices.
  - setShippingMethod
```
public Cart setShippingMethod(ReferenceId<ShippingMethod> shippingMethod)
```
    Sets the shipping method of the cart. The cart shipping info is set and the cart total is updated.
  - setShippingMethodAsync
```
public play.libs.F.Promise<SphereResult<Cart>> setShippingMethodAsync(ReferenceId<ShippingMethod> shippingMethod)
```
    Sets the shipping method of the cart asynchronously. The cart shipping info is set and the cart total is updated.
  - setCustomShippingMethod
```
public Cart setCustomShippingMethod(java.lang.String shippingMethodName,
                           ShippingRate shippingRate,
                           ReferenceId<TaxCategory> taxCategory)
```
    Sets a custom shipping method. The cart shipping info is set and the cart total is updated.
  - setCustomShippingMethodAsync
```
public play.libs.F.Promise<SphereResult<Cart>> setCustomShippingMethodAsync(java.lang.String shippingMethodName,
                                                                   ShippingRate shippingRate,
                                                                   ReferenceId<TaxCategory> taxCategory)
```
    Sets a custom shipping method of the cart asynchronously. The cart shipping info is set and the cart total is updated.
  - recalculate
```
public Cart recalculate()
```
    Updates line item prices and tax rates. This is in case that product prices, project tax settings, or project shipping settings changed since the items were added to the cart.
  - recalculateAsync
```
public play.libs.F.Promise<SphereResult<Cart>> recalculateAsync()
```
    Updates line item prices and tax rates asynchronously. This is in case that product prices, project tax settings, and project shipping settings changed since the items were added to the cart.
  - createCartSnapshotId
```
public java.lang.String createCartSnapshotId()
```
    Creates an cart snapshot identifier for the final page of a checkout process. A final page of a checkout process is the page where the customer has the option to create an order.
    See the documentation of createOrder for the rationale behind this method.
  - isSafeToCreateOrder
```
public boolean isSafeToCreateOrder(java.lang.String cartSnapshotId)
```
    Returns true if the cartSnapshotId matches the current cart id and version, and therefore it is certain that the cart was not modified in a different browser tab during checkout.
    You should always call this method before calling createOrder.
    If this method returns false, the cart was most likely modified in a different browser tab. You should notify the customer and refresh the checkout page.
    
    Parameters:
    cartSnapshotId - The identifier of the current checkout summary page.
  - createOrder
```
public Order createOrder(java.lang.String cartSnapshotId,
                PaymentState paymentState)
```
    Transforms the cart into an order.
    This method should be called when the customer decides to finalize the checkout.
    Before this method is called, a checkout summary page will typically display contents of the current cart. There needs to be a mechanism to make sure the customer didn't add an item to the cart from a different browser tab right before ordering. In other words, we have to make sure that what the cart contains is exactly what is displayed.
    The solution is to create a hidden HTML form input field storing an id of a cart snapshot, and providing the id to this method when creating the order. If the cart doesn't match the provided snapshot id, this method throws a CartModifiedException.
    Note on implementing payments: This method can also be used in a server-to-server callback invoked by a payment gateway. You should pass the a cartSnapshotId to the payment gateway, receive it back in the callback and pass it to this method.
    
    Parameters:
    cartSnapshotId - A snapshot identifier of the cart from the time it was displayed to the customer
    paymentState - The payment state of the new order
    
    Throws:
    
    CartModifiedException - if the cartSnapshotId doesn't match the state of the current cart anymore.
    
    OutOfStockException - if some of the products in the cart are not available anymore. This can only happen if the cart is in the ReserveOnOrder mode.
    
    PriceChangedException - if the price, tax or shipping of some line items changed since the items were added to the cart.
  - createOrderAsync
```
public play.libs.F.Promise<SphereResult<Order>> createOrderAsync(java.lang.String cartSnapshotId,
                                                        PaymentState paymentState)
```
    Transforms the cart into an order asynchronously.
    Parameters:
    cartSnapshotId - A snapshot identifier of the cart from the time it was displayed to the customer
    paymentState - The payment state of the new order A result which can fail with the following exceptions:
    
    CartModifiedException if the cartSnapshotId doesn't match the state of the current cart anymore.
    OutOfStockException if some of the products in the cart are not available anymore. This can only happen if the cart is in the ReserveOnOrder mode.
    PriceChangedException if the price, tax or shipping of some line items changed since the items were added to the cart.
    See Also:
    createOrder
  - createOrder
```
public Order createOrder(PaymentState paymentState)
```
    Transforms the cart into an order. WARNING! In a web application that can have several windows or tabs with the same session, use createOrder(String cartSnapshotId, PaymentState paymentState) with the snapshot id.
    Parameters:
    paymentState - The payment state of the new order * A result which can fail with the following exceptions:
    
    CartModifiedException if the cartSnapshotId doesn't match the state of the current cart anymore.
    OutOfStockException if some of the products in the cart are not available anymore. This can only happen if the cart is in the ReserveOnOrder mode.
    PriceChangedException if the price, tax or shipping of some line items changed since the items were added to the cart.
  - createOrder
```
public Order createOrder(CreateOrderBuilder createOrderBuilder)
```
  - createOrderAsync
```
public play.libs.F.Promise<SphereResult<Order>> createOrderAsync(PaymentState paymentState)
```
    Transforms the cart into an order asynchronously. WARNING! In a web application that can have several windows or tabs with the same session, use createOrder(String cartSnapshotId, PaymentState paymentState) with the snapshot id.
    Parameters:
    paymentState - The payment state of the new order * A result which can fail with the following exceptions:
    
    CartModifiedException if the cartSnapshotId doesn't match the state of the current cart anymore.
    OutOfStockException if some of the products in the cart are not available anymore. This can only happen if the cart is in the ReserveOnOrder mode.
    PriceChangedException if the price, tax or shipping of some line items changed since the items were added to the cart.
  - createOrderAsync
```
public play.libs.F.Promise<SphereResult<Order>> createOrderAsync(CreateOrderBuilder createOrderBuilder)
```
  - update
```
public Cart update(CartUpdate update)
```
    Updates the cart, doing several modifications using one request, described by the update object.
  - updateAsync
```
public play.libs.F.Promise<SphereResult<Cart>> updateAsync(CartUpdate update)
```
    Updates the cart asynchronously.

Class CurrentCart

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CurrentCart

Method Detail

fetch

fetchAsync

getQuantity

addLineItem

addLineItemAsync

addLineItem

addLineItemAsync

addCustomLineItem

addCustomLineItem

addCustomLineItemAsync

addCustomLineItemAsync

removeLineItem

removeLineItemAsync

decreaseLineItemQuantity

decreaseLineItemQuantityAsync

setLineItemQuantity

setLineItemQuantityAsync

setCustomerEmail

setCustomerEmailAsync

setShippingAddress

setShippingAddressAsync

clearShippingAddress

clearShippingAddressAsync

setBillingAddress

setBillingAddressAsync

setCountry

setCountryAsync

setShippingMethod

setShippingMethodAsync

setCustomShippingMethod

setCustomShippingMethodAsync

recalculate

recalculateAsync

createCartSnapshotId

isSafeToCreateOrder

createOrder

createOrderAsync

createOrder

createOrder

createOrderAsync

createOrderAsync

update

updateAsync