com.squareup.square.models

Class CatalogModifier

java.lang.Object

com.squareup.square.models.CatalogModifier

public class CatalogModifier
extends Object

This is a model class for CatalogModifier type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CatalogModifier(String name, Money priceMoney, Integer ordinal, String modifierListId, List<String> imageIds) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getImageIds() Getter for ImageIds.
String	getModifierListId() Getter for ModifierListId.
String	getName() Getter for Name.
Integer	getOrdinal() Getter for Ordinal.
Money	getPriceMoney() Getter for PriceMoney.
int	hashCode()
CatalogModifier.Builder	toBuilder() Builds a new CatalogModifier.Builder object.
String	toString() Converts this CatalogModifier into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogModifier

public CatalogModifier(String name,
                       Money priceMoney,
                       Integer ordinal,
                       String modifierListId,
                       List<String> imageIds)

Initialization constructor.

Parameters:

name - String value for name.

priceMoney - Money value for priceMoney.

ordinal - Integer value for ordinal.

modifierListId - String value for modifierListId.

imageIds - List of String value for imageIds.

Method Detail

getName

public String getName()

Getter for Name. The modifier 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

getPriceMoney

public Money getPriceMoney()

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

getOrdinal

public Integer getOrdinal()

Getter for Ordinal. Determines where this `CatalogModifier` appears in the `CatalogModifierList`.

Returns:

Returns the Integer

getModifierListId

public String getModifierListId()

Getter for ModifierListId. The ID of the `CatalogModifierList` associated with this modifier.

Returns:

Returns the String

getImageIds

public List<String> getImageIds()

Getter for ImageIds. The IDs of images associated with this `CatalogModifier` instance. Currently these images are not displayed by Square, but are free to be displayed in 3rd party applications.

Returns:

Returns the List of 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 CatalogModifier into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CatalogModifier.Builder toBuilder()

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

Returns:

a new CatalogModifier.Builder object