com.logicommerce.sdk.models.Cart Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk Show documentation
SDK for developing Logicommerce plugins.
There is a newer version: 2.1.1
package com.logicommerce.sdk.models;

import java.time.LocalDateTime;
import java.util.List;

/**
 * Cart interface. Get the cart values. This model will be accessible as a Resource. 
 * @{@link com.logicommerce.sdk.Resource Resource} {@link com.logicommerce.sdk.models.Cart Cart}
 *
 * @see		com.logicommerce.sdk.models.CartItem CartItem
 * @author 	Logicommerce
 * @since 	1.0.16
 */
public interface Cart {

	/**
	 * Get the headquarter of the cart.
	 * 
	 * @since 	1.3.3
	 * @return a {@link Headquarter} object
	 */
	Headquarter getHeadquarter();

	/**
	 * Get a cart token value. This value identifies the cart
	 *
	 * @since 	1.0.16
	 * @return a {@link java.lang.String String} object
	 */
	String getToken();

	/**
	 * Get the date when the cart was created
	 *
	 * @since 	1.0.16
	 * @return a {@link java.time.LocalDateTime} object
	 */
	LocalDateTime getCreatedAt();

	/**
	 * Get all Items from the cart.
	 *
	 * @see		com.logicommerce.sdk.models.CartItem CartItem
	 * @since 	1.0.16
	 * @return a {@link java.util.List List}<{@link com.logicommerce.sdk.models.CartItem CartItem}> object
	 */
	List getItems();

	/**
	 * Get Totals values of the cart.
	 *
	 * @see		com.logicommerce.sdk.models.CartTotals CartTotals
	 * @since 	1.0.16
	 * @return a {@link com.logicommerce.sdk.models.CartTotals CartTotals} object
	 */
	CartTotals getTotals();

	/**
	 * Get Delivery object of the cart.
	 *
	 * @see		com.logicommerce.sdk.models.CartDelivery CartDelivery
	 * @since 	1.0.16
	 * @return a {@link com.logicommerce.sdk.models.CartDelivery} object
	 */
	CartDelivery getDelivery();

	/**
	 * Get abandonedBasketLink, this link is for a recovery abandoned carts.
	 *
	 * @since 	1.0.16
	 * @return a {@link java.lang.String String} object
	 * @deprecated 1.3.7 Use {@link #getBasketLink()} instead
	 */
	@Deprecated(forRemoval = true)
	String getAbandonedBasketLink();

	/**
	 * Get basketLink, this link is for add items to the cart.
	 *
	 * @since 	1.3.7
	 * @return a {@link java.lang.String String} object
	 */
	String getBasketLink();

	/**
	 * Get User of the cart.
	 *
	 * @see		com.logicommerce.sdk.models.User User
	 * @since 	1.0.16
	 * @return a {@link com.logicommerce.sdk.models.User User} object
	 */
	User getUser();

	/**
	 * Get currencyCode from user info for the cart.
	 *
	 * @since 	1.1.10
	 * @return a {@link java.lang.String String} object
	 */
	String getCurrencyCode();

	/**
	 * Get payment method for the cart.
	 *
	 * @since 	1.3.0
	 * @return a {@link CartPaymentSystem} object
	 */
	CartPaymentSystem getPaymentSystem();


	/**
	 * Get discounts for the cart.
	 * 
	 * @since 	1.3.0
	 * @return a {@link List} of {@link CartDiscount} objects
	 */
	List getDiscounts();

}