com.logicommerce.sdk.models.User 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.LocalDate;
import java.util.List;
import java.util.Map;

/**
 * User interface. Get user data associated to the cart.
 *
 * @see		com.logicommerce.sdk.models.Cart Cart
 * @see 	com.logicommerce.sdk.models.UserAddress UserAddress
 * @author 	Logicommerce
 * @since 	1.0.16
 */
public interface User {

	/**
	 * Get user ID value.
	 *
	 * @since 1.0.16
	 * @return a {@link java.lang.Integer Integer} object
	 */
	Integer getId();

	/**
	 * Get user email value.
	 *
	 * @since 1.0.16
	 * @return a {@link java.lang.String String} object
	 */
	String getEmail();

	/**
	 * Get user nick value.
	 *
	 * @since 1.0.16
	 * @return a {@link java.lang.String String} object
	 */
	String getNick();

	/**
	 * Get user gender value.
	 *
	 * @since 1.0.16
	 * @return a {@link java.lang.String String} object
	 */
	String getGender();

	/**
	 * Get user birthday date value.
	 *
	 * @since 1.0.16
	 * @return a {@link java.time.LocalDate LocalDate} object
	 */
	LocalDate getBirthday();

	/**
	 * Get user company value.
	 *
	 * @since 1.0.16
	 * @return a {@link java.lang.String String} object
	 */
	String getCompany();

	/**
	 * Get sales Agent ID associated to the user. This value is filled in if the purchase has been assisted by a sales agent.
	 *
	 * @since 1.0.16
	 * @return a {@link java.lang.Integer Integer} object
	 */
	Integer getSalesAgentId();

	/**
	 * Get sales agent. return true if the purchase has been realized by a sales agent.
	 *
	 * @since 1.0.16
	 * @return a {@link java.lang.Boolean Boolean} object
	 */
	Boolean isSalesAgent();

	/**
	 * Get list of user Billing Addresses.
	 *
	 * @see com.logicommerce.sdk.models.UserAddress UserAddress
	 * @since 1.0.16
	 * @return a {@link java.util.List List}<{@link com.logicommerce.sdk.models.UserAddress UserAddress}> object
	 */
	List getBillingAddresses();

	/**
	 * Get list of user Shipping Addresses.
	 *
	 * @see	com.logicommerce.sdk.models.UserAddress UserAddress
	 * @since 1.0.16
	 * @return a {@link java.util.List List}<{@link com.logicommerce.sdk.models.UserAddress UserAddress}> object
	 */
	List getShippingAddresses();

	/**
	 *  Get the user custom tags. This is a map with key, value, and de key is the name of the custom tag.
	 *
	 * @since 1.0.16
	 * @return a {@link java.util.Map Map}<{@link java.lang.String String}, {@link java.lang.String String}> object
	 */
	Map getCustomTags();

}