com.squareup.square.models

Class ItemVariationLocationOverrides

java.lang.Object

com.squareup.square.models.ItemVariationLocationOverrides

public class ItemVariationLocationOverrides
extends Object

This is a model class for ItemVariationLocationOverrides type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ItemVariationLocationOverrides(String locationId, Money priceMoney, String pricingType, Boolean trackInventory, String inventoryAlertType, Long inventoryAlertThreshold, Boolean soldOut, String soldOutValidUntil) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Long	getInventoryAlertThreshold() Getter for InventoryAlertThreshold.
String	getInventoryAlertType() Getter for InventoryAlertType.
String	getLocationId() Getter for LocationId.
Money	getPriceMoney() Getter for PriceMoney.
String	getPricingType() Getter for PricingType.
Boolean	getSoldOut() Getter for SoldOut.
String	getSoldOutValidUntil() Getter for SoldOutValidUntil.
Boolean	getTrackInventory() Getter for TrackInventory.
int	hashCode()
ItemVariationLocationOverrides.Builder	toBuilder() Builds a new ItemVariationLocationOverrides.Builder object.
String	toString() Converts this ItemVariationLocationOverrides into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemVariationLocationOverrides

public ItemVariationLocationOverrides(String locationId,
                                      Money priceMoney,
                                      String pricingType,
                                      Boolean trackInventory,
                                      String inventoryAlertType,
                                      Long inventoryAlertThreshold,
                                      Boolean soldOut,
                                      String soldOutValidUntil)

Initialization constructor.

Parameters:

locationId - String value for locationId.

priceMoney - Money value for priceMoney.

pricingType - String value for pricingType.

trackInventory - Boolean value for trackInventory.

inventoryAlertType - String value for inventoryAlertType.

inventoryAlertThreshold - Long value for inventoryAlertThreshold.

soldOut - Boolean value for soldOut.

soldOutValidUntil - String value for soldOutValidUntil.

Method Detail

getLocationId

public String getLocationId()

Getter for LocationId. The ID of the `Location`. This can include locations that are deactivated.

Returns:

Returns the String

getPriceMoney

public Money getPriceMoney()

Getter for PriceMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.

Returns:

Returns the Money

getPricingType

public String getPricingType()

Getter for PricingType. Indicates whether the price of a CatalogItemVariation should be entered manually at the time of sale.

Returns:

Returns the String

getTrackInventory

public Boolean getTrackInventory()

Getter for TrackInventory. If `true`, inventory tracking is active for the `CatalogItemVariation` at this `Location`.

Returns:

Returns the Boolean

getInventoryAlertType

public String getInventoryAlertType()

Getter for InventoryAlertType. Indicates whether Square should alert the merchant when the inventory quantity of a CatalogItemVariation is low.

Returns:

Returns the String

getInventoryAlertThreshold

public Long getInventoryAlertThreshold()

Getter for InventoryAlertThreshold. If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard. This value is always an integer.

Returns:

Returns the Long

getSoldOut

public Boolean getSoldOut()

Getter for SoldOut. Indicates whether the overridden item variation is sold out at the specified location. When inventory tracking is enabled on the item variation either globally or at the specified location, the item variation is automatically marked as sold out when its inventory count reaches zero. The seller can manually set the item variation as sold out even when the inventory count is greater than zero. Attempts by an application to set this attribute are ignored. Regardless how the sold-out status is set, applications should treat its inventory count as zero when this attribute value is `true`.

Returns:

Returns the Boolean

getSoldOutValidUntil

public String getSoldOutValidUntil()

Getter for SoldOutValidUntil. The seller-assigned timestamp, of the RFC 3339 format, to indicate when this sold-out variation becomes available again at the specified location. Attempts by an application to set this attribute are ignored. When the current time is later than this attribute value, the affected item variation is no longer sold out.

Returns:

Returns the String

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 ItemVariationLocationOverrides into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ItemVariationLocationOverrides.Builder toBuilder()

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

Returns:

a new ItemVariationLocationOverrides.Builder object