com.squareup.square.models

Class SearchOrdersRequest

java.lang.Object

com.squareup.square.models.SearchOrdersRequest

public class SearchOrdersRequest
extends Object

This is a model class for SearchOrdersRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
SearchOrdersRequest(List<String> locationIds, String cursor, SearchOrdersQuery query, Integer limit, Boolean returnEntries) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCursor() Getter for Cursor.
Integer	getLimit() Getter for Limit.
List<String>	getLocationIds() Getter for LocationIds.
SearchOrdersQuery	getQuery() Getter for Query.
Boolean	getReturnEntries() Getter for ReturnEntries.
int	hashCode()
SearchOrdersRequest.Builder	toBuilder() Builds a new SearchOrdersRequest.Builder object.
String	toString() Converts this SearchOrdersRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchOrdersRequest

public SearchOrdersRequest(List<String> locationIds,
                           String cursor,
                           SearchOrdersQuery query,
                           Integer limit,
                           Boolean returnEntries)

Initialization constructor.

Parameters:

locationIds - List of String value for locationIds.

cursor - String value for cursor.

query - SearchOrdersQuery value for query.

limit - Integer value for limit.

returnEntries - Boolean value for returnEntries.

Method Detail

getLocationIds

public List<String> getLocationIds()

Getter for LocationIds. The location IDs for the orders to query. All locations must belong to the same merchant. Min: 1 location ID. Max: 10 location IDs.

Returns:

Returns the List of String

getCursor

public String getCursor()

Getter for Cursor. A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query. For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination).

Returns:

Returns the String

getQuery

public SearchOrdersQuery getQuery()

Getter for Query. Contains query criteria for the search.

Returns:

Returns the SearchOrdersQuery

getLimit

public Integer getLimit()

Getter for Limit. The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. Default: `500`

Returns:

Returns the Integer

getReturnEntries

public Boolean getReturnEntries()

Getter for ReturnEntries. A Boolean that controls the format of the search results. If `true`, `SearchOrders` returns [OrderEntry]($m/OrderEntry) objects. If `false`, `SearchOrders` returns complete order objects. Default: `false`.

Returns:

Returns the Boolean

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public SearchOrdersRequest.Builder toBuilder()

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

Returns:

a new SearchOrdersRequest.Builder object