com.squareup.square.models

Class CatalogProductSet

java.lang.Object

com.squareup.square.models.CatalogProductSet

public class CatalogProductSet
extends Object

This is a model class for CatalogProductSet type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CatalogProductSet.Builder Class to build instances of CatalogProductSet.

Constructor Summary

Constructors

Constructor and Description
CatalogProductSet(String name, List<String> productIdsAny, List<String> productIdsAll, Long quantityExact, Long quantityMin, Long quantityMax, Boolean allProducts) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getAllProducts() Getter for AllProducts.
String	getName() Getter for Name.
List<String>	getProductIdsAll() Getter for ProductIdsAll.
List<String>	getProductIdsAny() Getter for ProductIdsAny.
Long	getQuantityExact() Getter for QuantityExact.
Long	getQuantityMax() Getter for QuantityMax.
Long	getQuantityMin() Getter for QuantityMin.
int	hashCode()
CatalogProductSet.Builder	toBuilder() Builds a new CatalogProductSet.Builder object.
String	toString() Converts this CatalogProductSet into string format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CatalogProductSet

public CatalogProductSet(String name,
                         List<String> productIdsAny,
                         List<String> productIdsAll,
                         Long quantityExact,
                         Long quantityMin,
                         Long quantityMax,
                         Boolean allProducts)

Initialization constructor.

Parameters:

name - String value for name.

productIdsAny - List of String value for productIdsAny.

productIdsAll - List of String value for productIdsAll.

quantityExact - Long value for quantityExact.

quantityMin - Long value for quantityMin.

quantityMax - Long value for quantityMax.

allProducts - Boolean value for allProducts.

Method Detail

getName

public String getName()

Getter for Name. User-defined name for the product set. For example, "Clearance Items" or "Winter Sale Items".

Returns:

Returns the String

getProductIdsAny

public List<String> getProductIdsAny()

Getter for ProductIdsAny. Unique IDs for any `CatalogObject` included in this product set. Any number of these catalog objects can be in an order for a pricing rule to apply. This can be used with `product_ids_all` in a parent `CatalogProductSet` to match groups of products for a bulk discount, such as a discount for an entree and side combo. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs.

Returns:

Returns the List of String

getProductIdsAll

public List<String> getProductIdsAll()

Getter for ProductIdsAll. Unique IDs for any `CatalogObject` included in this product set. All objects in this set must be included in an order for a pricing rule to apply. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs.

Returns:

Returns the List of String

getQuantityExact

public Long getQuantityExact()

Getter for QuantityExact. If set, there must be exactly this many items from `products_any` or `products_all` in the cart for the discount to apply. Cannot be combined with either `quantity_min` or `quantity_max`.

Returns:

Returns the Long

getQuantityMin

public Long getQuantityMin()

Getter for QuantityMin. If set, there must be at least this many items from `products_any` or `products_all` in a cart for the discount to apply. See `quantity_exact`. Defaults to 0 if `quantity_exact`, `quantity_min` and `quantity_max` are all unspecified.

Returns:

Returns the Long

getQuantityMax

public Long getQuantityMax()

Getter for QuantityMax. If set, the pricing rule will apply to a maximum of this many items from `products_any` or `products_all`.

Returns:

Returns the Long

getAllProducts

public Boolean getAllProducts()

Getter for AllProducts. If set to `true`, the product set will include every item in the catalog. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set.

Returns:

Returns the Boolean

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this CatalogProductSet into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CatalogProductSet.Builder toBuilder()

Builds a new CatalogProductSet.Builder object. Creates the instance with the state of the current model.

Returns:

a new CatalogProductSet.Builder object