com.squareup.square.models

Class SearchOrdersFilter

java.lang.Object

com.squareup.square.models.SearchOrdersFilter

public class SearchOrdersFilter
extends Object

This is a model class for SearchOrdersFilter type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
SearchOrdersFilter(SearchOrdersStateFilter stateFilter, SearchOrdersDateTimeFilter dateTimeFilter, SearchOrdersFulfillmentFilter fulfillmentFilter, SearchOrdersSourceFilter sourceFilter, SearchOrdersCustomerFilter customerFilter) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
SearchOrdersCustomerFilter	getCustomerFilter() Getter for CustomerFilter.
SearchOrdersDateTimeFilter	getDateTimeFilter() Getter for DateTimeFilter.
SearchOrdersFulfillmentFilter	getFulfillmentFilter() Getter for FulfillmentFilter.
SearchOrdersSourceFilter	getSourceFilter() Getter for SourceFilter.
SearchOrdersStateFilter	getStateFilter() Getter for StateFilter.
int	hashCode()
SearchOrdersFilter.Builder	toBuilder() Builds a new SearchOrdersFilter.Builder object.
String	toString() Converts this SearchOrdersFilter into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchOrdersFilter

public SearchOrdersFilter(SearchOrdersStateFilter stateFilter,
                          SearchOrdersDateTimeFilter dateTimeFilter,
                          SearchOrdersFulfillmentFilter fulfillmentFilter,
                          SearchOrdersSourceFilter sourceFilter,
                          SearchOrdersCustomerFilter customerFilter)

Initialization constructor.

Parameters:

stateFilter - SearchOrdersStateFilter value for stateFilter.

dateTimeFilter - SearchOrdersDateTimeFilter value for dateTimeFilter.

fulfillmentFilter - SearchOrdersFulfillmentFilter value for fulfillmentFilter.

sourceFilter - SearchOrdersSourceFilter value for sourceFilter.

customerFilter - SearchOrdersCustomerFilter value for customerFilter.

Method Detail

getStateFilter

public SearchOrdersStateFilter getStateFilter()

Getter for StateFilter. Filter by the current order `state`.

Returns:

Returns the SearchOrdersStateFilter

getDateTimeFilter

public SearchOrdersDateTimeFilter getDateTimeFilter()

Getter for DateTimeFilter. Filter for `Order` objects based on whether their `CREATED_AT`, `CLOSED_AT`, or `UPDATED_AT` timestamps fall within a specified time range. You can specify the time range and which timestamp to filter for. You can filter for only one time range at a time. For each time range, the start time and end time are inclusive. If the end time is absent, it defaults to the time of the first request for the cursor. __Important:__ If you use the `DateTimeFilter` in a `SearchOrders` query, you must set the `sort_field` in [OrdersSort]($m/SearchOrdersSort) to the same field you filter for. For example, if you set the `CLOSED_AT` field in `DateTimeFilter`, you must set the `sort_field` in `SearchOrdersSort` to `CLOSED_AT`. Otherwise, `SearchOrders` throws an error. [Learn more about filtering orders by time range.](https://developer.squareup.com/docs/orders-api/manage-orders#important-note-on-filtering-orders-by-time-range)

Returns:

Returns the SearchOrdersDateTimeFilter

getFulfillmentFilter

public SearchOrdersFulfillmentFilter getFulfillmentFilter()

Getter for FulfillmentFilter. Filter based on [order fulfillment]($m/OrderFulfillment) information.

Returns:

Returns the SearchOrdersFulfillmentFilter

getSourceFilter

public SearchOrdersSourceFilter getSourceFilter()

Getter for SourceFilter. A filter based on order `source` information.

Returns:

Returns the SearchOrdersSourceFilter

getCustomerFilter

public SearchOrdersCustomerFilter getCustomerFilter()

Getter for CustomerFilter. A filter based on the order `customer_id` and any tender `customer_id` associated with the order. It does not filter based on the [FulfillmentRecipient]($m/OrderFulfillmentRecipient) `customer_id`.

Returns:

Returns the SearchOrdersCustomerFilter

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public SearchOrdersFilter.Builder toBuilder()

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

Returns:

a new SearchOrdersFilter.Builder object