com.squareup.square.models

Class InventoryCount

java.lang.Object

com.squareup.square.models.InventoryCount

public class InventoryCount
extends Object

This is a model class for InventoryCount type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
InventoryCount(String catalogObjectId, String catalogObjectType, String state, String locationId, String quantity, String calculatedAt, Boolean isEstimated) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCalculatedAt() Getter for CalculatedAt.
String	getCatalogObjectId() Getter for CatalogObjectId.
String	getCatalogObjectType() Getter for CatalogObjectType.
Boolean	getIsEstimated() Getter for IsEstimated.
String	getLocationId() Getter for LocationId.
String	getQuantity() Getter for Quantity.
String	getState() Getter for State.
int	hashCode()
InventoryCount.Builder	toBuilder() Builds a new InventoryCount.Builder object.
String	toString() Converts this InventoryCount into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

InventoryCount

public InventoryCount(String catalogObjectId,
                      String catalogObjectType,
                      String state,
                      String locationId,
                      String quantity,
                      String calculatedAt,
                      Boolean isEstimated)

Initialization constructor.

Parameters:

catalogObjectId - String value for catalogObjectId.

catalogObjectType - String value for catalogObjectType.

state - String value for state.

locationId - String value for locationId.

quantity - String value for quantity.

calculatedAt - String value for calculatedAt.

isEstimated - Boolean value for isEstimated.

Method Detail

getCatalogObjectId

public String getCatalogObjectId()

Getter for CatalogObjectId. The Square-generated ID of the [CatalogObject]($m/CatalogObject) being tracked.

Returns:

Returns the String

getCatalogObjectType

public String getCatalogObjectType()

Getter for CatalogObjectType. The [type]($m/CatalogObjectType) of the [CatalogObject]($m/CatalogObject) being tracked. The Inventory API supports setting and reading the `"catalog_object_type": "ITEM_VARIATION"` field value. In addition, it can also read the `"catalog_object_type": "ITEM"` field value that is set by the Square Restaurants app.

Returns:

Returns the String

getState

public String getState()

Getter for State. Indicates the state of a tracked item quantity in the lifecycle of goods.

Returns:

Returns the String

getLocationId

public String getLocationId()

Getter for LocationId. The Square-generated ID of the [Location]($m/Location) where the related quantity of items is being tracked.

Returns:

Returns the String

getQuantity

public String getQuantity()

Getter for Quantity. The number of items affected by the estimated count as a decimal string. Can support up to 5 digits after the decimal point.

Returns:

Returns the String

getCalculatedAt

public String getCalculatedAt()

Getter for CalculatedAt. An RFC 3339-formatted timestamp that indicates when the most recent physical count or adjustment affecting the estimated count is received.

Returns:

Returns the String

getIsEstimated

public Boolean getIsEstimated()

Getter for IsEstimated. Whether the inventory count is for composed variation (TRUE) or not (FALSE). If true, the inventory count will not be present in the response of any of these endpoints: [BatchChangeInventory]($e/Inventory/BatchChangeInventory), [BatchRetrieveInventoryChanges]($e/Inventory/BatchRetrieveInventoryChanges), [BatchRetrieveInventoryCounts]($e/Inventory/BatchRetrieveInventoryCounts), and [RetrieveInventoryChanges]($e/Inventory/RetrieveInventoryChanges).

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public InventoryCount.Builder toBuilder()

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

Returns:

a new InventoryCount.Builder object