com.squareup.square.models

Class RetrieveCatalogObjectResponse

java.lang.Object

com.squareup.square.models.RetrieveCatalogObjectResponse

public class RetrieveCatalogObjectResponse
extends Object

This is a model class for RetrieveCatalogObjectResponse type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
RetrieveCatalogObjectResponse(List<Error> errors, CatalogObject object, List<CatalogObject> relatedObjects) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
HttpContext	getContext()
List<Error>	getErrors() Getter for Errors.
CatalogObject	getObject() Getter for Object.
List<CatalogObject>	getRelatedObjects() Getter for RelatedObjects.
int	hashCode()
RetrieveCatalogObjectResponse.Builder	toBuilder() Builds a new RetrieveCatalogObjectResponse.Builder object.
String	toString() Converts this RetrieveCatalogObjectResponse into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

RetrieveCatalogObjectResponse

public RetrieveCatalogObjectResponse(List<Error> errors,
                                     CatalogObject object,
                                     List<CatalogObject> relatedObjects)

Initialization constructor.

Parameters:

errors - List of Error value for errors.

object - CatalogObject value for object.

relatedObjects - List of CatalogObject value for relatedObjects.

Method Detail

getContext

public HttpContext getContext()

getErrors

public List<Error> getErrors()

Getter for Errors. Any errors that occurred during the request.

Returns:

Returns the List of Error

getObject

public CatalogObject getObject()

Getter for Object. The wrapper object for the catalog entries of a given object type. Depending on the `type` attribute value, a `CatalogObject` instance assumes a type-specific data to yield the corresponding type of catalog object. For example, if `type=ITEM`, the `CatalogObject` instance must have the ITEM-specific data set on the `item_data` attribute. The resulting `CatalogObject` instance is also a `CatalogItem` instance. In general, if `type=<OBJECT_TYPE>`, the `CatalogObject` instance must have the `<OBJECT_TYPE>`-specific data set on the `<object_type>_data` attribute. The resulting `CatalogObject` instance is also a `Catalog<ObjectType>` instance. For a more detailed discussion of the Catalog data model, please see the [Design a Catalog](https://developer.squareup.com/docs/catalog-api/design-a-catalog) guide.

Returns:

Returns the CatalogObject

getRelatedObjects

public List<CatalogObject> getRelatedObjects()

Getter for RelatedObjects. A list of `CatalogObject`s referenced by the object in the `object` field.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public RetrieveCatalogObjectResponse.Builder toBuilder()

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

Returns:

a new RetrieveCatalogObjectResponse.Builder object