com.squareup.square.models

Class CalculateOrderRequest

java.lang.Object

com.squareup.square.models.CalculateOrderRequest

public class CalculateOrderRequest
extends Object

This is a model class for CalculateOrderRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CalculateOrderRequest(Order order, List<OrderReward> proposedRewards) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Order	getOrder() Getter for Order.
List<OrderReward>	getProposedRewards() Getter for ProposedRewards.
int	hashCode()
CalculateOrderRequest.Builder	toBuilder() Builds a new CalculateOrderRequest.Builder object.
String	toString() Converts this CalculateOrderRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CalculateOrderRequest

public CalculateOrderRequest(Order order,
                             List<OrderReward> proposedRewards)

Initialization constructor.

Parameters:

order - Order value for order.

proposedRewards - List of OrderReward value for proposedRewards.

Method Detail

getOrder

public Order getOrder()

Getter for Order. Contains all information related to a single order to process with Square, including line items that specify the products to purchase. `Order` objects also include information about any associated tenders, refunds, and returns. All Connect V2 Transactions have all been converted to Orders including all associated itemization data.

Returns:

Returns the Order

getProposedRewards

public List<OrderReward> getProposedRewards()

Getter for ProposedRewards. Identifies one or more loyalty reward tiers to apply during the order calculation. The discounts defined by the reward tiers are added to the order only to preview the effect of applying the specified rewards. The rewards do not correspond to actual redemptions; that is, no `reward`s are created. Therefore, the reward `id`s are random strings used only to reference the reward tier.

Returns:

Returns the List of OrderReward

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CalculateOrderRequest.Builder toBuilder()

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

Returns:

a new CalculateOrderRequest.Builder object