com.squareup.square.models

Class RetrieveCatalogObjectRequest

java.lang.Object

com.squareup.square.models.RetrieveCatalogObjectRequest

public class RetrieveCatalogObjectRequest
extends Object

This is a model class for RetrieveCatalogObjectRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
RetrieveCatalogObjectRequest(Boolean includeRelatedObjects, Long catalogVersion) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Long	getCatalogVersion() Getter for CatalogVersion.
Boolean	getIncludeRelatedObjects() Getter for IncludeRelatedObjects.
int	hashCode()
RetrieveCatalogObjectRequest.Builder	toBuilder() Builds a new RetrieveCatalogObjectRequest.Builder object.
String	toString() Converts this RetrieveCatalogObjectRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

RetrieveCatalogObjectRequest

public RetrieveCatalogObjectRequest(Boolean includeRelatedObjects,
                                    Long catalogVersion)

Initialization constructor.

Parameters:

includeRelatedObjects - Boolean value for includeRelatedObjects.

catalogVersion - Long value for catalogVersion.

Method Detail

getIncludeRelatedObjects

public Boolean getIncludeRelatedObjects()

Getter for IncludeRelatedObjects. If `true`, the response will include additional objects that are related to the requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field of the response. These objects are put in the `related_objects` field. Setting this to `true` is helpful when the objects are needed for immediate display to a user. This process only goes one level deep. Objects referenced by the related objects will not be included. For example, if the `objects` field of the response contains a CatalogItem, its associated CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false`

Returns:

Returns the Boolean

getCatalogVersion

public Long getCatalogVersion()

Getter for CatalogVersion. Requests objects as of a specific version of the catalog. This allows you to retrieve historical versions of objects. The value to retrieve a specific version of an object can be found in the version field of [CatalogObject]($m/CatalogObject)s. If not included, results will be from the current version of the catalog.

Returns:

Returns the Long

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public RetrieveCatalogObjectRequest.Builder toBuilder()

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

Returns:

a new RetrieveCatalogObjectRequest.Builder object