com.squareup.square.models

Class InventoryChange

java.lang.Object

com.squareup.square.models.InventoryChange

public class InventoryChange
extends Object

This is a model class for InventoryChange type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
InventoryChange(String type, InventoryPhysicalCount physicalCount, InventoryAdjustment adjustment, InventoryTransfer transfer, CatalogMeasurementUnit measurementUnit, String measurementUnitId) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
InventoryAdjustment	getAdjustment() Getter for Adjustment.
CatalogMeasurementUnit	getMeasurementUnit() Getter for MeasurementUnit.
String	getMeasurementUnitId() Getter for MeasurementUnitId.
InventoryPhysicalCount	getPhysicalCount() Getter for PhysicalCount.
InventoryTransfer	getTransfer() Getter for Transfer.
String	getType() Getter for Type.
int	hashCode()
InventoryChange.Builder	toBuilder() Builds a new InventoryChange.Builder object.
String	toString() Converts this InventoryChange into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

InventoryChange

public InventoryChange(String type,
                       InventoryPhysicalCount physicalCount,
                       InventoryAdjustment adjustment,
                       InventoryTransfer transfer,
                       CatalogMeasurementUnit measurementUnit,
                       String measurementUnitId)

Initialization constructor.

Parameters:

type - String value for type.

physicalCount - InventoryPhysicalCount value for physicalCount.

adjustment - InventoryAdjustment value for adjustment.

transfer - InventoryTransfer value for transfer.

measurementUnit - CatalogMeasurementUnit value for measurementUnit.

measurementUnitId - String value for measurementUnitId.

Method Detail

getType

public String getType()

Getter for Type. Indicates how the inventory change was applied to a tracked product quantity.

Returns:

Returns the String

getPhysicalCount

public InventoryPhysicalCount getPhysicalCount()

Getter for PhysicalCount. Represents the quantity of an item variation that is physically present at a specific location, verified by a seller or a seller's employee. For example, a physical count might come from an employee counting the item variations on hand or from syncing with an external system.

Returns:

Returns the InventoryPhysicalCount

getAdjustment

public InventoryAdjustment getAdjustment()

Getter for Adjustment. Represents a change in state or quantity of product inventory at a particular time and location.

Returns:

Returns the InventoryAdjustment

getTransfer

public InventoryTransfer getTransfer()

Getter for Transfer. Represents the transfer of a quantity of product inventory at a particular time from one location to another.

Returns:

Returns the InventoryTransfer

getMeasurementUnit

public CatalogMeasurementUnit getMeasurementUnit()

Getter for MeasurementUnit. Represents the unit used to measure a `CatalogItemVariation` and specifies the precision for decimal quantities.

Returns:

Returns the CatalogMeasurementUnit

getMeasurementUnitId

public String getMeasurementUnitId()

Getter for MeasurementUnitId. The ID of the [CatalogMeasurementUnit]($m/CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public InventoryChange.Builder toBuilder()

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

Returns:

a new InventoryChange.Builder object