Package com.broadleafcommerce.promotion.offer.client.web.context

Class OrderDto<F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

java.lang.Object

com.broadleafcommerce.promotion.offer.client.web.context.OrderDto<F>

All Implemented Interfaces:

Order<OrderLineItemDto,F>, Serializable

public class OrderDto<F extends FulfillmentGroupDto<FulfillmentLineItemDto>>
extends Object
implements Order<OrderLineItemDto,F>, Serializable

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
OrderDto()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<SubscriptionItemDto>	getActiveSubscriptionItems()	Holds details about the active subscriptions for a user
Map<String,Object>	getAttributes()	Additional, unspecified attributes.
javax.money.MonetaryAmount	getCartSubtotal()
Codes	getCodes()	Deprecated.
Map<String,Object>	getContextMap()	Generic structure to provide additional context to the offer engine.
javax.money.CurrencyUnit	getCurrency()	The Currency.getCurrencyCode().
CustomerContext	getCustomerContext()	The CustomerContext associated with the API request.
List<ExistingOfferRef>	getExistingOffers()	Existing offers that are already applied to this order.
String	getFlow()	The current flow that this order is in.
List<SubscriptionItemDto>	getFormerSubscriptionItems()	Holds details about the former subscriptions for a user
List<F>	getFulfillmentGroups()	Groups of items sharing the same fulfillment info (method, destination, payment info).
Locale	getLocale()	The Locale for the order
List<OfferCodeDto>	getOfferCodes()
List<OrderLineItemDto>	getOrderLineItems()	Items being sold in this order.
String	getOrderNumber()	Number used to identify this order.
Instant	getOrderSubmitDate()	The Instant of when this order was submitted.
Integer	getSubscriptionNextPeriod()	If this is a subscription, this represents the next period this subscription will cover.
Instant	getTimeOfRequest()	The time that the request to apply offers to this order was made.
List<Voucher>	getVouchers()	The Vouchers that this OrderDto has.
int	hashCode()
boolean	isRunOrderAndItemOffers()	If this is set to false, the offer engine will skip offers that target orders and order items and only attempt to apply fulfillment group and fulfillment item offers.
void	setActiveSubscriptionItems(List<SubscriptionItemDto> activeSubscriptionItems)	Holds details about the active subscriptions for a user
void	setAttributes(Map<String,Object> attributes)	Additional, unspecified attributes.
void	setCartSubtotal(javax.money.MonetaryAmount cartSubtotal)
void	setCodes(Codes codes)	Deprecated.
void	setContextMap(Map<String,Object> contextMap)	Generic structure to provide additional context to the offer engine.
void	setCurrency(javax.money.CurrencyUnit currency)	The Currency.getCurrencyCode().
void	setCustomerContext(CustomerContext customerContext)	The CustomerContext associated with the API request.
void	setExistingOffers(List<ExistingOfferRef> existingOffers)	Existing offers that are already applied to this order.
void	setFlow(String flow)	The current flow that this order is in.
void	setFormerSubscriptionItems(List<SubscriptionItemDto> formerSubscriptionItems)	Holds details about the former subscriptions for a user
void	setFulfillmentGroups(List<F> fulfillmentGroups)	Groups of items sharing the same fulfillment info (method, destination, payment info).
void	setLocale(Locale locale)	The Locale for the order
void	setOfferCodes(List<OfferCodeDto> offerCodes)
void	setOrderLineItems(List<OrderLineItemDto> orderLineItems)	Items being sold in this order.
void	setOrderNumber(String orderNumber)	Number used to identify this order.
void	setOrderSubmitDate(Instant orderSubmitDate)	The Instant of when this order was submitted.
void	setRunOrderAndItemOffers(boolean runOrderAndItemOffers)	If this is set to false, the offer engine will skip offers that target orders and order items and only attempt to apply fulfillment group and fulfillment item offers.
void	setSubscriptionNextPeriod(Integer subscriptionNextPeriod)	If this is a subscription, this represents the next period this subscription will cover.
void	setTimeOfRequest(Instant timeOfRequest)	The time that the request to apply offers to this order was made.
void	setVouchers(List<Voucher> vouchers)	The Vouchers that this OrderDto has.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

OrderDto

public OrderDto()

Method Details

getTimeOfRequest

public Instant getTimeOfRequest()

Description copied from interface: Order

The time that the request to apply offers to this order was made.

Specified by:

getTimeOfRequest in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Returns:

The time that the request to apply offers to this order was made.

getOrderNumber

public String getOrderNumber()

Description copied from interface: Order

Number used to identify this order.

Specified by:

getOrderNumber in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Returns:

Number used to identify this order.

getOrderLineItems

public List<OrderLineItemDto> getOrderLineItems()

Description copied from interface: Order

Items being sold in this order.

Specified by:

getOrderLineItems in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Returns:

Items being sold in this order.

See Also:

• LineItem

getFulfillmentGroups

public List<F> getFulfillmentGroups()

Description copied from interface: Order

Groups of items sharing the same fulfillment info (method, destination, payment info). Fulfillment groups also contain the cost of fulfillment, which may be discounted by offers. If this list is empty, then no offers will be applied to fulfillment groups or fulfillment items.

Specified by:

getFulfillmentGroups in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Returns:

Groups of items sharing the same fulfillment info.

See Also:

• FulfillmentGroup
• FulfillmentLineItem

getVouchers

public List<Voucher> getVouchers()

The Vouchers that this OrderDto has.

This is mainly used for post-checkout voucher offer validation purposes.

getCodes

@Deprecated
public Codes getCodes()

Deprecated.

Description copied from interface: Order

DTO containing codes used to apply offers to orders. These can be shared offer codes or tracking IDs for entities like Campaigns.

Specified by:

getCodes in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Returns:

DTO containing codes used to apply offers to orders.

getOfferCodes

public List<OfferCodeDto> getOfferCodes()

isRunOrderAndItemOffers

public boolean isRunOrderAndItemOffers()

Description copied from interface: Order

If this is set to false, the offer engine will skip offers that target orders and order items and only attempt to apply fulfillment group and fulfillment item offers. Default is true.

Specified by:

isRunOrderAndItemOffers in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Returns:

whether to run order and order item offers against this order.

getAttributes

public Map<String,Object> getAttributes()

Description copied from interface: Order

Additional, unspecified attributes.

Specified by:

getAttributes in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Returns:

Additional, unspecified attributes

getLocale

public Locale getLocale()

Description copied from interface: Order

The Locale for the order

Specified by:

getLocale in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Returns:

The Locale

getCurrency

public javax.money.CurrencyUnit getCurrency()

Description copied from interface: Order

The Currency.getCurrencyCode().

Specified by:

getCurrency in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Returns:

The Currency.getCurrencyCode().

getCustomerContext

public CustomerContext getCustomerContext()

Description copied from interface: Order

The CustomerContext associated with the API request. The customer context contains information necessary for determining whether an offer applies to the customer sending the request.

Specified by:

getCustomerContext in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Returns:

The CustomerContext associated with the API request.

getOrderSubmitDate

public Instant getOrderSubmitDate()

The Instant of when this order was submitted.

This is mainly used for post-checkout voucher offer validation purposes.

getCartSubtotal

public javax.money.MonetaryAmount getCartSubtotal()

getContextMap

public Map<String,Object> getContextMap()

Generic structure to provide additional context to the offer engine. It is used for out of box offers such as dynamic amount offers and payment offers. It is intended to be used as a convenient extension point for customization needs between cart operations and the promotion engine.

getFlow

public String getFlow()

The current flow that this order is in. This is used for offers targeting a specific flow.

Specified by:

getFlow in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Returns:

The current flow that this order is in.

Since:

2.0.4

See Also:

• DefaultOrderFlow

getSubscriptionNextPeriod

public Integer getSubscriptionNextPeriod()

If this is a subscription, this represents the next period this subscription will cover.

For example, if this is a monthly subscription and the subscription is in its 5th month, the next period would be 6.

This is useful to determine an applied offer's begin and end periods, and to calculate the remaining periods that an offer can be applied to.

Since:

2.0.4

getExistingOffers

public List<ExistingOfferRef> getExistingOffers()

Existing offers that are already applied to this order.

Used for post-purchase flows for subscription such as DefaultOrderFlow.SUBSCRIPTION_EDIT, DefaultOrderFlow.SUBSCRIPTION_UPGRADE, etc.

Since:

2.0.4

getActiveSubscriptionItems

public List<SubscriptionItemDto> getActiveSubscriptionItems()

Holds details about the active subscriptions for a user

Since:

2.0.4

getFormerSubscriptionItems

public List<SubscriptionItemDto> getFormerSubscriptionItems()

Holds details about the former subscriptions for a user

Since:

2.0.4

setOrderNumber

public void setOrderNumber(String orderNumber)

Description copied from interface: Order

Number used to identify this order.

Specified by:

setOrderNumber in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Parameters:

orderNumber - Number used to identify this order.

setOrderLineItems

public void setOrderLineItems(List<OrderLineItemDto> orderLineItems)

Description copied from interface: Order

Items being sold in this order.

Specified by:

setOrderLineItems in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Parameters:

orderLineItems - Items being sold in this order.

See Also:

• LineItem

setFulfillmentGroups

public void setFulfillmentGroups(List<F> fulfillmentGroups)

Description copied from interface: Order

Groups of items sharing the same fulfillment info (method, destination, payment info). Fulfillment groups also contain the cost of fulfillment, which may be discounted by offers. If this list is empty, then no offers will be applied to fulfillment groups or fulfillment items.

Specified by:

setFulfillmentGroups in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Parameters:

fulfillmentGroups - Groups of items sharing the same fulfillment info.

See Also:

• FulfillmentGroup
• FulfillmentLineItem

setVouchers

public void setVouchers(List<Voucher> vouchers)

The Vouchers that this OrderDto has.

This is mainly used for post-checkout voucher offer validation purposes.

setCodes

@Deprecated
public void setCodes(Codes codes)

Deprecated.

Description copied from interface: Order

DTO containing codes used to apply offers to orders. These can be shared offer codes or tracking IDs for entities like Campaigns.

Specified by:

setCodes in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Parameters:

codes - DTO containing codes used to apply offers to orders.

setOfferCodes

public void setOfferCodes(List<OfferCodeDto> offerCodes)

setRunOrderAndItemOffers

public void setRunOrderAndItemOffers(boolean runOrderAndItemOffers)

Description copied from interface: Order

If this is set to false, the offer engine will skip offers that target orders and order items and only attempt to apply fulfillment group and fulfillment item offers. Default is true.

Specified by:

setRunOrderAndItemOffers in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Parameters:

runOrderAndItemOffers - whether to order and order item offers against this order.

setAttributes

public void setAttributes(Map<String,Object> attributes)

Description copied from interface: Order

Additional, unspecified attributes.

Specified by:

setAttributes in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Parameters:

attributes - Additional, unspecified attributes.

setLocale

public void setLocale(Locale locale)

Description copied from interface: Order

The Locale for the order

Specified by:

setLocale in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Parameters:

locale - The Locale

setCurrency

public void setCurrency(javax.money.CurrencyUnit currency)

Description copied from interface: Order

The Currency.getCurrencyCode().

Specified by:

setCurrency in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Parameters:

currency - The Currency.getCurrencyCode().

setCustomerContext

public void setCustomerContext(CustomerContext customerContext)

Description copied from interface: Order

The CustomerContext associated with the API request. The customer context contains information necessary for determining whether an offer applies to the customer sending the request.

Specified by:

setCustomerContext in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Parameters:

customerContext - The CustomerContext associated with the API request.

setTimeOfRequest

public void setTimeOfRequest(Instant timeOfRequest)

Description copied from interface: Order

The time that the request to apply offers to this order was made.

Specified by:

setTimeOfRequest in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Parameters:

timeOfRequest - The time that the request to apply offers to this order was made.

setOrderSubmitDate

public void setOrderSubmitDate(Instant orderSubmitDate)

The Instant of when this order was submitted.

This is mainly used for post-checkout voucher offer validation purposes.

setCartSubtotal

public void setCartSubtotal(javax.money.MonetaryAmount cartSubtotal)

setContextMap

public void setContextMap(Map<String,Object> contextMap)

Generic structure to provide additional context to the offer engine. It is used for out of box offers such as dynamic amount offers and payment offers. It is intended to be used as a convenient extension point for customization needs between cart operations and the promotion engine.

setFlow

public void setFlow(String flow)

The current flow that this order is in. This is used for offers targeting a specific flow.

Specified by:

setFlow in interface Order<OrderLineItemDto,F extends FulfillmentGroupDto<FulfillmentLineItemDto>>

Parameters:

flow - The current flow that this order is in.

Since:

2.0.4

See Also:

• DefaultOrderFlow

setSubscriptionNextPeriod

public void setSubscriptionNextPeriod(Integer subscriptionNextPeriod)

If this is a subscription, this represents the next period this subscription will cover.

For example, if this is a monthly subscription and the subscription is in its 5th month, the next period would be 6.

This is useful to determine an applied offer's begin and end periods, and to calculate the remaining periods that an offer can be applied to.

Since:

2.0.4

setExistingOffers

public void setExistingOffers(List<ExistingOfferRef> existingOffers)

Existing offers that are already applied to this order.

Used for post-purchase flows for subscription such as DefaultOrderFlow.SUBSCRIPTION_EDIT, DefaultOrderFlow.SUBSCRIPTION_UPGRADE, etc.

Since:

2.0.4

setActiveSubscriptionItems

public void setActiveSubscriptionItems(List<SubscriptionItemDto> activeSubscriptionItems)

Holds details about the active subscriptions for a user

Since:

2.0.4

setFormerSubscriptionItems

public void setFormerSubscriptionItems(List<SubscriptionItemDto> formerSubscriptionItems)

Holds details about the former subscriptions for a user

Since:

2.0.4

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object