com.squareup.square.models

Class OrderReturnLineItemModifier

java.lang.Object

com.squareup.square.models.OrderReturnLineItemModifier

public class OrderReturnLineItemModifier
extends Object

This is a model class for OrderReturnLineItemModifier type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
OrderReturnLineItemModifier(String uid, String sourceModifierUid, String catalogObjectId, Long catalogVersion, String name, Money basePriceMoney, Money totalPriceMoney) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Money	getBasePriceMoney() Getter for BasePriceMoney.
String	getCatalogObjectId() Getter for CatalogObjectId.
Long	getCatalogVersion() Getter for CatalogVersion.
String	getName() Getter for Name.
String	getSourceModifierUid() Getter for SourceModifierUid.
Money	getTotalPriceMoney() Getter for TotalPriceMoney.
String	getUid() Getter for Uid.
int	hashCode()
OrderReturnLineItemModifier.Builder	toBuilder() Builds a new OrderReturnLineItemModifier.Builder object.
String	toString() Converts this OrderReturnLineItemModifier into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderReturnLineItemModifier

public OrderReturnLineItemModifier(String uid,
                                   String sourceModifierUid,
                                   String catalogObjectId,
                                   Long catalogVersion,
                                   String name,
                                   Money basePriceMoney,
                                   Money totalPriceMoney)

Initialization constructor.

Parameters:

uid - String value for uid.

sourceModifierUid - String value for sourceModifierUid.

catalogObjectId - String value for catalogObjectId.

catalogVersion - Long value for catalogVersion.

name - String value for name.

basePriceMoney - Money value for basePriceMoney.

totalPriceMoney - Money value for totalPriceMoney.

Method Detail

getUid

public String getUid()

Getter for Uid. A unique ID that identifies the return modifier only within this order.

Returns:

Returns the String

getSourceModifierUid

public String getSourceModifierUid()

Getter for SourceModifierUid. The modifier `uid` from the order's line item that contains the original sale of this line item modifier.

Returns:

Returns the String

getCatalogObjectId

public String getCatalogObjectId()

Getter for CatalogObjectId. The catalog object ID referencing [CatalogModifier]($m/CatalogModifier).

Returns:

Returns the String

getCatalogVersion

public Long getCatalogVersion()

Getter for CatalogVersion. The version of the catalog object that this line item modifier references.

Returns:

Returns the Long

getName

public String getName()

Getter for Name. The name of the item modifier.

Returns:

Returns the String

getBasePriceMoney

public Money getBasePriceMoney()

Getter for BasePriceMoney. 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

getTotalPriceMoney

public Money getTotalPriceMoney()

Getter for TotalPriceMoney. 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

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public OrderReturnLineItemModifier.Builder toBuilder()

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

Returns:

a new OrderReturnLineItemModifier.Builder object