com.squareup.square.models

Class SearchOrdersResponse

java.lang.Object

com.squareup.square.models.SearchOrdersResponse

public class SearchOrdersResponse
extends Object

This is a model class for SearchOrdersResponse type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
SearchOrdersResponse(List<OrderEntry> orderEntries, List<Order> orders, String cursor, List<Error> errors) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
HttpContext	getContext()
String	getCursor() Getter for Cursor.
List<Error>	getErrors() Getter for Errors.
List<OrderEntry>	getOrderEntries() Getter for OrderEntries.
List<Order>	getOrders() Getter for Orders.
int	hashCode()
SearchOrdersResponse.Builder	toBuilder() Builds a new SearchOrdersResponse.Builder object.
String	toString() Converts this SearchOrdersResponse into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchOrdersResponse

public SearchOrdersResponse(List<OrderEntry> orderEntries,
                            List<Order> orders,
                            String cursor,
                            List<Error> errors)

Initialization constructor.

Parameters:

orderEntries - List of OrderEntry value for orderEntries.

orders - List of Order value for orders.

cursor - String value for cursor.

errors - List of Error value for errors.

Method Detail

getContext

public HttpContext getContext()

getOrderEntries

public List<OrderEntry> getOrderEntries()

Getter for OrderEntries. A list of [OrderEntries]($m/OrderEntry) that fit the query conditions. The list is populated only if `return_entries` is set to `true` in the request.

Returns:

Returns the List of OrderEntry

getOrders

public List<Order> getOrders()

Getter for Orders. A list of [Order]($m/Order) objects that match the query conditions. The list is populated only if `return_entries` is set to `false` in the request.

Returns:

Returns the List of Order

getCursor

public String getCursor()

Getter for Cursor. The pagination cursor to be used in a subsequent request. If unset, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination).

Returns:

Returns the String

getErrors

public List<Error> getErrors()

Getter for Errors. [Errors]($m/Error) encountered during the search.

Returns:

Returns the List of Error

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public SearchOrdersResponse.Builder toBuilder()

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

Returns:

a new SearchOrdersResponse.Builder object