com.squareup.square.models

Class CatalogStockConversion

java.lang.Object

com.squareup.square.models.CatalogStockConversion

public class CatalogStockConversion
extends Object

This is a model class for CatalogStockConversion type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CatalogStockConversion(String stockableItemVariationId, String stockableQuantity, String nonstockableQuantity) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getNonstockableQuantity() Getter for NonstockableQuantity.
String	getStockableItemVariationId() Getter for StockableItemVariationId.
String	getStockableQuantity() Getter for StockableQuantity.
int	hashCode()
CatalogStockConversion.Builder	toBuilder() Builds a new CatalogStockConversion.Builder object.
String	toString() Converts this CatalogStockConversion into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogStockConversion

public CatalogStockConversion(String stockableItemVariationId,
                              String stockableQuantity,
                              String nonstockableQuantity)

Initialization constructor.

Parameters:

stockableItemVariationId - String value for stockableItemVariationId.

stockableQuantity - String value for stockableQuantity.

nonstockableQuantity - String value for nonstockableQuantity.

Method Detail

getStockableItemVariationId

public String getStockableItemVariationId()

Getter for StockableItemVariationId. References to the stockable [CatalogItemVariation]($m/CatalogItemVariation) for this stock conversion. Selling, receiving or recounting the non-stockable `CatalogItemVariation` defined with a stock conversion results in adjustments of this stockable `CatalogItemVariation`. This immutable field must reference a stockable `CatalogItemVariation` that shares the parent [CatalogItem]($m/CatalogItem) of the converted `CatalogItemVariation.`

Returns:

Returns the String

getStockableQuantity

public String getStockableQuantity()

Getter for StockableQuantity. The quantity of the stockable item variation (as identified by `stockable_item_variation_id`) equivalent to the non-stockable item variation quantity (as specified in `nonstockable_quantity`) as defined by this stock conversion. It accepts a decimal number in a string format that can take up to 10 digits before the decimal point and up to 5 digits after the decimal point.

Returns:

Returns the String

getNonstockableQuantity

public String getNonstockableQuantity()

Getter for NonstockableQuantity. The converted equivalent quantity of the non-stockable [CatalogItemVariation]($m/CatalogItemVariation) in its measurement unit. The `stockable_quantity` value and this `nonstockable_quantity` value together define the conversion ratio between stockable item variation and the non-stockable item variation. It accepts a decimal number in a string format that can take up to 10 digits before the decimal point and up to 5 digits after the decimal point.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CatalogStockConversion.Builder toBuilder()

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

Returns:

a new CatalogStockConversion.Builder object