com.squareup.square.models

Class CatalogDiscount

java.lang.Object

com.squareup.square.models.CatalogDiscount

public class CatalogDiscount
extends Object

This is a model class for CatalogDiscount type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CatalogDiscount(String name, String discountType, String percentage, Money amountMoney, Boolean pinRequired, String labelColor, String modifyTaxBasis, Money maximumAmountMoney) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Money	getAmountMoney() Getter for AmountMoney.
String	getDiscountType() Getter for DiscountType.
String	getLabelColor() Getter for LabelColor.
Money	getMaximumAmountMoney() Getter for MaximumAmountMoney.
String	getModifyTaxBasis() Getter for ModifyTaxBasis.
String	getName() Getter for Name.
String	getPercentage() Getter for Percentage.
Boolean	getPinRequired() Getter for PinRequired.
int	hashCode()
CatalogDiscount.Builder	toBuilder() Builds a new CatalogDiscount.Builder object.
String	toString() Converts this CatalogDiscount into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogDiscount

public CatalogDiscount(String name,
                       String discountType,
                       String percentage,
                       Money amountMoney,
                       Boolean pinRequired,
                       String labelColor,
                       String modifyTaxBasis,
                       Money maximumAmountMoney)

Initialization constructor.

Parameters:

name - String value for name.

discountType - String value for discountType.

percentage - String value for percentage.

amountMoney - Money value for amountMoney.

pinRequired - Boolean value for pinRequired.

labelColor - String value for labelColor.

modifyTaxBasis - String value for modifyTaxBasis.

maximumAmountMoney - Money value for maximumAmountMoney.

Method Detail

getName

public String getName()

Getter for Name. The discount name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.

Returns:

Returns the String

getDiscountType

public String getDiscountType()

Getter for DiscountType. How to apply a CatalogDiscount to a CatalogItem.

Returns:

Returns the String

getPercentage

public String getPercentage()

Getter for Percentage. The percentage of the discount as a string representation of a decimal number, using a `.` as the decimal separator and without a `%` sign. A value of `7.5` corresponds to `7.5%`. Specify a percentage of `0` if `discount_type` is `VARIABLE_PERCENTAGE`. Do not use this field for amount-based or variable discounts.

Returns:

Returns the String

getAmountMoney

public Money getAmountMoney()

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

getPinRequired

public Boolean getPinRequired()

Getter for PinRequired. Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment in the Square Point of Sale app.

Returns:

Returns the Boolean

getLabelColor

public String getLabelColor()

Getter for LabelColor. The color of the discount display label in the Square Point of Sale app. This must be a valid hex color code.

Returns:

Returns the String

getModifyTaxBasis

public String getModifyTaxBasis()

Getter for ModifyTaxBasis.

Returns:

Returns the String

getMaximumAmountMoney

public Money getMaximumAmountMoney()

Getter for MaximumAmountMoney. 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 CatalogDiscount into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CatalogDiscount.Builder toBuilder()

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

Returns:

a new CatalogDiscount.Builder object