com.squareup.square.models

Class CatalogItemOptionValue

java.lang.Object

com.squareup.square.models.CatalogItemOptionValue

public class CatalogItemOptionValue
extends Object

This is a model class for CatalogItemOptionValue type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CatalogItemOptionValue(String itemOptionId, String name, String description, String color, Integer ordinal) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getColor() Getter for Color.
String	getDescription() Getter for Description.
String	getItemOptionId() Getter for ItemOptionId.
String	getName() Getter for Name.
Integer	getOrdinal() Getter for Ordinal.
int	hashCode()
CatalogItemOptionValue.Builder	toBuilder() Builds a new CatalogItemOptionValue.Builder object.
String	toString() Converts this CatalogItemOptionValue into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogItemOptionValue

public CatalogItemOptionValue(String itemOptionId,
                              String name,
                              String description,
                              String color,
                              Integer ordinal)

Initialization constructor.

Parameters:

itemOptionId - String value for itemOptionId.

name - String value for name.

description - String value for description.

color - String value for color.

ordinal - Integer value for ordinal.

Method Detail

getItemOptionId

public String getItemOptionId()

Getter for ItemOptionId. Unique ID of the associated item option.

Returns:

Returns the String

getName

public String getName()

Getter for Name. Name of this item option value. This is a searchable attribute for use in applicable query filters.

Returns:

Returns the String

getDescription

public String getDescription()

Getter for Description. A human-readable description for the option value. This is a searchable attribute for use in applicable query filters.

Returns:

Returns the String

getColor

public String getColor()

Getter for Color. The HTML-supported hex color for the item option (e.g., "#ff8d4e85"). Only displayed if `show_colors` is enabled on the parent `ItemOption`. When left unset, `color` defaults to white ("#ffffff") when `show_colors` is enabled on the parent `ItemOption`.

Returns:

Returns the String

getOrdinal

public Integer getOrdinal()

Getter for Ordinal. Determines where this option value appears in a list of option values.

Returns:

Returns the Integer

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CatalogItemOptionValue.Builder toBuilder()

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

Returns:

a new CatalogItemOptionValue.Builder object