com.squareup.square.models

Class CatalogItemOption

java.lang.Object

com.squareup.square.models.CatalogItemOption

public class CatalogItemOption
extends Object

This is a model class for CatalogItemOption type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CatalogItemOption(String name, String displayName, String description, Boolean showColors, List<CatalogObject> values) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDescription() Getter for Description.
String	getDisplayName() Getter for DisplayName.
String	getName() Getter for Name.
Boolean	getShowColors() Getter for ShowColors.
List<CatalogObject>	getValues() Getter for Values.
int	hashCode()
CatalogItemOption.Builder	toBuilder() Builds a new CatalogItemOption.Builder object.
String	toString() Converts this CatalogItemOption into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogItemOption

public CatalogItemOption(String name,
                         String displayName,
                         String description,
                         Boolean showColors,
                         List<CatalogObject> values)

Initialization constructor.

Parameters:

name - String value for name.

displayName - String value for displayName.

description - String value for description.

showColors - Boolean value for showColors.

values - List of CatalogObject value for values.

Method Detail

getName

public String getName()

Getter for Name. The item option's display name for the seller. Must be unique across all item options. This is a searchable attribute for use in applicable query filters.

Returns:

Returns the String

getDisplayName

public String getDisplayName()

Getter for DisplayName. The item option's display name for the customer. This is a searchable attribute for use in applicable query filters.

Returns:

Returns the String

getDescription

public String getDescription()

Getter for Description. The item option's human-readable description. Displayed in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer. This is a searchable attribute for use in applicable query filters.

Returns:

Returns the String

getShowColors

public Boolean getShowColors()

Getter for ShowColors. If true, display colors for entries in `values` when present.

Returns:

Returns the Boolean

getValues

public List<CatalogObject> getValues()

Getter for Values. A list of CatalogObjects containing the `CatalogItemOptionValue`s for this item.

Returns:

Returns the List of CatalogObject

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CatalogItemOption.Builder toBuilder()

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

Returns:

a new CatalogItemOption.Builder object