com.squareup.square.models

Class CatalogModifierList

java.lang.Object

com.squareup.square.models.CatalogModifierList

public class CatalogModifierList
extends Object

This is a model class for CatalogModifierList type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CatalogModifierList(String name, Integer ordinal, String selectionType, List<CatalogObject> modifiers, List<String> imageIds) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getImageIds() Getter for ImageIds.
List<CatalogObject>	getModifiers() Getter for Modifiers.
String	getName() Getter for Name.
Integer	getOrdinal() Getter for Ordinal.
String	getSelectionType() Getter for SelectionType.
int	hashCode()
CatalogModifierList.Builder	toBuilder() Builds a new CatalogModifierList.Builder object.
String	toString() Converts this CatalogModifierList into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogModifierList

public CatalogModifierList(String name,
                           Integer ordinal,
                           String selectionType,
                           List<CatalogObject> modifiers,
                           List<String> imageIds)

Initialization constructor.

Parameters:

name - String value for name.

ordinal - Integer value for ordinal.

selectionType - String value for selectionType.

modifiers - List of CatalogObject value for modifiers.

imageIds - List of String value for imageIds.

Method Detail

getName

public String getName()

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

Returns:

Returns the String

getOrdinal

public Integer getOrdinal()

Getter for Ordinal. Determines where this modifier list appears in a list of `CatalogModifierList` values.

Returns:

Returns the Integer

getSelectionType

public String getSelectionType()

Getter for SelectionType. Indicates whether a CatalogModifierList supports multiple selections.

Returns:

Returns the String

getModifiers

public List<CatalogObject> getModifiers()

Getter for Modifiers. The options included in the `CatalogModifierList`. You must include at least one `CatalogModifier`. Each CatalogObject must have type `MODIFIER` and contain `CatalogModifier` data.

Returns:

Returns the List of CatalogObject

getImageIds

public List<String> getImageIds()

Getter for ImageIds. The IDs of images associated with this `CatalogModifierList` 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 CatalogModifierList into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CatalogModifierList.Builder toBuilder()

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

Returns:

a new CatalogModifierList.Builder object