com.broadleafcommerce.order.common.domain

Class OfferRef

java.lang.Object

com.broadleafcommerce.order.common.domain.OfferRef

All Implemented Interfaces:

Serializable

public class OfferRef
extends Object
implements Serializable

A reference to some external offer. Offers can be associated to carts, orders, fulfillment, or their items. This reference could come from Broadleaf's Offer Microservice or some other source entirely.

Author:

Chad Harchar (charchar)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OfferRef()

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Map<String,Object>	getAttributes() Dynamic attributes that are a part of the offer.
String	getCartLabel() A label for this offer typically used by the storefront.
String	getDescription() A description of what benefits the offer provides to a customer.
String	getId() The ID of the offer.
String	getName() The name of the offer.
int	hashCode()
void	setAttributes(Map<String,Object> attributes) Dynamic attributes that are a part of the offer.
void	setCartLabel(String cartLabel) A label for this offer typically used by the storefront.
void	setDescription(String description) A description of what benefits the offer provides to a customer.
void	setId(String id) The ID of the offer.
void	setName(String name) The name of the offer.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OfferRef

public OfferRef()

Method Detail

getId

public String getId()

The ID of the offer.

Returns:

The ID of the offer.

getName

public String getName()

The name of the offer. Often used to indicate to a customer what offers are applied to their cart.

Returns:

The name of the offer.

getDescription

public String getDescription()

A description of what benefits the offer provides to a customer.

Returns:

A description of benefits what the offer provides to a customer.

getCartLabel

public String getCartLabel()

A label for this offer typically used by the storefront.

Returns:

A label for this offer typically used by the storefront.

getAttributes

public Map<String,Object> getAttributes()

Dynamic attributes that are a part of the offer.

Returns:

dynamic attributes that are a part of the offer

setId

public void setId(String id)

The ID of the offer.

Parameters:

id - The ID of the offer.

setName

public void setName(String name)

The name of the offer. Often used to indicate to a customer what offers are applied to their cart.

Parameters:

name - The name of the offer.

setDescription

public void setDescription(String description)

A description of what benefits the offer provides to a customer.

Parameters:

description - A description of what benefits the offer provides to a customer.

setCartLabel

public void setCartLabel(String cartLabel)

A label for this offer typically used by the storefront.

Parameters:

cartLabel - A label for this offer typically used by the storefront.

setAttributes

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

Dynamic attributes that are a part of the offer.

Parameters:

attributes - dynamic attributes that are a part of the offer

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

toString

public String toString()

Overrides:

toString in class Object