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

Modifier	Constructor and Description
protected	OrderReturnLineItemModifier(io.apimatic.core.types.OptionalNullable<String> uid, io.apimatic.core.types.OptionalNullable<String> sourceModifierUid, io.apimatic.core.types.OptionalNullable<String> catalogObjectId, io.apimatic.core.types.OptionalNullable<Long> catalogVersion, io.apimatic.core.types.OptionalNullable<String> name, Money basePriceMoney, Money totalPriceMoney, io.apimatic.core.types.OptionalNullable<String> quantity) Internal initialization constructor.
	OrderReturnLineItemModifier(String uid, String sourceModifierUid, String catalogObjectId, Long catalogVersion, String name, Money basePriceMoney, Money totalPriceMoney, String quantity) 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	getQuantity() Getter for Quantity.
String	getSourceModifierUid() Getter for SourceModifierUid.
Money	getTotalPriceMoney() Getter for TotalPriceMoney.
String	getUid() Getter for Uid.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<String>	internalGetCatalogObjectId() Internal Getter for CatalogObjectId.
protected io.apimatic.core.types.OptionalNullable<Long>	internalGetCatalogVersion() Internal Getter for CatalogVersion.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetName() Internal Getter for Name.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetQuantity() Internal Getter for Quantity.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetSourceModifierUid() Internal Getter for SourceModifierUid.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetUid() Internal Getter for Uid.
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,
                                   String quantity)

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.

quantity - String value for quantity.

OrderReturnLineItemModifier

protected OrderReturnLineItemModifier(io.apimatic.core.types.OptionalNullable<String> uid,
                                      io.apimatic.core.types.OptionalNullable<String> sourceModifierUid,
                                      io.apimatic.core.types.OptionalNullable<String> catalogObjectId,
                                      io.apimatic.core.types.OptionalNullable<Long> catalogVersion,
                                      io.apimatic.core.types.OptionalNullable<String> name,
                                      Money basePriceMoney,
                                      Money totalPriceMoney,
                                      io.apimatic.core.types.OptionalNullable<String> quantity)

Internal initialization constructor.

Method Detail

internalGetUid

protected io.apimatic.core.types.OptionalNullable<String> internalGetUid()

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

Returns:

Returns the Internal String

getUid

public String getUid()

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

Returns:

Returns the String

internalGetSourceModifierUid

protected io.apimatic.core.types.OptionalNullable<String> internalGetSourceModifierUid()

Internal 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 Internal 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

internalGetCatalogObjectId

protected io.apimatic.core.types.OptionalNullable<String> internalGetCatalogObjectId()

Internal Getter for CatalogObjectId. The catalog object ID referencing [CatalogModifier](entity:CatalogModifier).

Returns:

Returns the Internal String

getCatalogObjectId

public String getCatalogObjectId()

Getter for CatalogObjectId. The catalog object ID referencing [CatalogModifier](entity:CatalogModifier).

Returns:

Returns the String

internalGetCatalogVersion

protected io.apimatic.core.types.OptionalNullable<Long> internalGetCatalogVersion()

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

Returns:

Returns the Internal Long

getCatalogVersion

public Long getCatalogVersion()

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

Returns:

Returns the Long

internalGetName

protected io.apimatic.core.types.OptionalNullable<String> internalGetName()

Internal Getter for Name. The name of the item modifier.

Returns:

Returns the Internal String

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

internalGetQuantity

protected io.apimatic.core.types.OptionalNullable<String> internalGetQuantity()

Internal Getter for Quantity. The quantity of the line item modifier. The modifier quantity can be 0 or more. For example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders this item, the restaurant records the purchase by creating an `Order` object with a line item for a burger. The line item includes a line item modifier: the name is cheese and the quantity is 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses the extra cheese option, the modifier quantity increases to 2. If the buyer does not want any cheese, the modifier quantity is set to 0.

Returns:

Returns the Internal String

getQuantity

public String getQuantity()

Getter for Quantity. The quantity of the line item modifier. The modifier quantity can be 0 or more. For example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders this item, the restaurant records the purchase by creating an `Order` object with a line item for a burger. The line item includes a line item modifier: the name is cheese and the quantity is 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses the extra cheese option, the modifier quantity increases to 2. If the buyer does not want any cheese, the modifier quantity is set to 0.

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 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