Package com.broadleafcommerce.pricing.client.domain

Class PriceableTarget

java.lang.Object

com.broadleafcommerce.pricing.client.domain.PriceableTarget

All Implemented Interfaces:

BasePriceableTarget, Serializable

public class PriceableTarget
extends Object
implements Serializable, BasePriceableTarget

An abstraction of an entity that can have a price.

Author:

Chad Harchar (charchar)

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PriceableTarget()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Map<String,Object>	getAttributes()	Additional attributes.
Map<String,String>	getCharacteristics()	Gets the characteristics of the target, e.g., capacity:128GB.
String	getPaymentStrategy()	Gets the payment strategy of the price of the target, e.g., ONE_TIME, PREPAID, POSTPAID.
Map<String,javax.money.MonetaryAmount>	getPriceableFields()	List of priceable fields for the target.
String	getPricingCategory()	Optional.
Integer	getRecurringPeriodFrequency()	Gets the frequency of the recurring price of the target, e.g., 1, 6, 12.
String	getRecurringPeriodType()	Gets the recurring price period type of the target, e.g., MONTHLY, QUARTERLY, ANNUALLY.
String	getTargetId()	Gets the identifier of the target.
Integer	getTargetQuantity()	The quantity of the entity to be priced.
String	getTargetType()	Gets the type of the target, e.g., SKU or PRICING_KEY.
Integer	getTermDurationLength()	Gets the term duration length of the target, e.g., 12, 24, 36.
String	getTermDurationType()	Gets the term duration type of the target, e.g., DAYS, MONTHS, YEARS.
Map<String,Boolean>	getTypeFromDirectVariantMap()
String	getVendorRef()	Key to external system indicating that this PriceableTarget is specific to a vendor.
int	hashCode()
boolean	isTypeFromDirectVariant(String type)	Returns true if the direct field value for the passed in type is from a direct variant price.
void	setAttributes(Map<String,Object> attributes)	Additional attributes.
void	setCharacteristics(Map<String,String> characteristics)	Sets the characteristics of the target, e.g., size: red, capacity: 128GB.
void	setPaymentStrategy(String paymentStrategy)	Sets the payment strategy of the price of the target, e.g., ONE_TIME, PREPAID, POSTPAID.
void	setPriceableFields(Map<String,javax.money.MonetaryAmount> priceableFields)	List of priceable fields for the target.
void	setPricingCategory(String pricingCategory)	Optional.
void	setRecurringPeriodFrequency(Integer recurringPeriodFrequency)	Sets the frequency of the recurring price of the target, e.g., 1, 6, 12.
void	setRecurringPeriodType(String recurringPeriodType)	Sets the recurring period type of the target, e.g., MONTHLY, QUARTERLY, ANNUALLY.
void	setTargetId(String targetId)	Sets the identifier of the target.
void	setTargetQuantity(Integer targetQuantity)	The quantity of the entity to be priced.
void	setTargetType(String targetType)	Sets the type of the target, e.g., SKU or PRICING_KEY.
void	setTermDurationLength(Integer termDurationLength)	Sets the term duration length of the target, e.g., 12, 24, 36.
void	setTermDurationType(String termDurationType)	Sets the term duration type of the target, e.g., DAYS, MONTHS, YEARS.
void	setTypeFromDirectVariantMap(Map<String,Boolean> typeFromDirectVariantMap)
void	setVendorRef(String vendorRef)	Key to external system indicating that this PriceableTarget is specific to a vendor.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

PriceableTarget

public PriceableTarget()

Method Details

isTypeFromDirectVariant

public boolean isTypeFromDirectVariant(String type)

Returns true if the direct field value for the passed in type is from a direct variant price.

Parameters:

type -

Returns:

getTargetId

public String getTargetId()

Description copied from interface: BasePriceableTarget

Gets the identifier of the target.

Specified by:

getTargetId in interface BasePriceableTarget

Returns:

the identifier of the target.

See Also:

• BasePriceableTarget.getTargetId()

getTargetType

public String getTargetType()

Description copied from interface: BasePriceableTarget

Gets the type of the target, e.g., SKU or PRICING_KEY.

Specified by:

getTargetType in interface BasePriceableTarget

Returns:

the identifier of the target.

See Also:

• BasePriceableTarget.getTargetType()

getTargetQuantity

public Integer getTargetQuantity()

The quantity of the entity to be priced. This is used to determine when a price data tier should apply as the best overall price.

Since:

Pricing Client 2.0.3

getPriceableFields

public Map<String,javax.money.MonetaryAmount> getPriceableFields()

List of priceable fields for the target. This can include such fields as basePrice and baseCost.

getVendorRef

public String getVendorRef()

Description copied from interface: BasePriceableTarget

Key to external system indicating that this PriceableTarget is specific to a vendor. This can be populated to support security controls based on a vendor based claim.

Specified by:

getVendorRef in interface BasePriceableTarget

Returns:

a reference to a vendor (e.g. vendorId or vendorCode)

See Also:

• BasePriceableTarget.getVendorRef()

getPaymentStrategy

public String getPaymentStrategy()

Description copied from interface: BasePriceableTarget

Gets the payment strategy of the price of the target, e.g., ONE_TIME, PREPAID, POSTPAID. This indicates that the caller wants a specific price for the given payment strategy and prices should be filtered accordingly.

Specified by:

getPaymentStrategy in interface BasePriceableTarget

Returns:

the payment strategy of the price desired for the target.

Since:

2.0.4

See Also:

• BasePriceableTarget.getPaymentStrategy()

getRecurringPeriodFrequency

public Integer getRecurringPeriodFrequency()

Description copied from interface: BasePriceableTarget

Gets the frequency of the recurring price of the target, e.g., 1, 6, 12. This indicates that the caller wants a specific price for the given recurring price frequency and prices should be filtered accordingly.

Specified by:

getRecurringPeriodFrequency in interface BasePriceableTarget

Returns:

the frequency of the recurring price desired for the target.

Since:

2.0.4

See Also:

• BasePriceableTarget.getTermDurationLength()

getRecurringPeriodType

public String getRecurringPeriodType()

Description copied from interface: BasePriceableTarget

Gets the recurring price period type of the target, e.g., MONTHLY, QUARTERLY, ANNUALLY. This indicates that the caller wants a specific price for the given recurring period type and prices should be filtered accordingly.

Specified by:

getRecurringPeriodType in interface BasePriceableTarget

Returns:

the recurring period type of the price desired for the target

Since:

2.0.4

See Also:

• BasePriceableTarget.getTermDurationLength()

getTermDurationLength

public Integer getTermDurationLength()

Description copied from interface: BasePriceableTarget

Gets the term duration length of the target, e.g., 12, 24, 36. This indicates that the caller wants a specific price for the given term length and prices should be filtered accordingly.

Specified by:

getTermDurationLength in interface BasePriceableTarget

Returns:

the term duration length of the price desired for the target.

Since:

Pricing Client 2.0.3

See Also:

• BasePriceableTarget.getTermDurationLength()

getTermDurationType

public String getTermDurationType()

Description copied from interface: BasePriceableTarget

Gets the term duration type of the target, e.g., DAYS, MONTHS, YEARS. This indicates that the caller wants a specific price for the given term type and prices should be filtered accordingly.

Specified by:

getTermDurationType in interface BasePriceableTarget

Returns:

the term duration type of the price desired for the target

Since:

Pricing Client 2.0.3

See Also:

• BasePriceableTarget.getTermDurationType()

getCharacteristics

public Map<String,String> getCharacteristics()

Description copied from interface: BasePriceableTarget

Gets the characteristics of the target, e.g., capacity:128GB. This indicates that the caller wants a specific price targeting these characteristics not just a base or default price for the target item. This is useful when the target is a flattened Product with no variations but still has configurable options that could drive pricing.

Specified by:

getCharacteristics in interface BasePriceableTarget

Returns:

the characteristics of the target

Since:

Pricing Client 2.0.3

See Also:

• BasePriceableTarget.getCharacteristics()

getPricingCategory

public String getPricingCategory()

Description copied from interface: BasePriceableTarget

Optional. A category id that can be targeted in a pricing modifier formula to transform pricing for products assigned to it.

Specified by:

getPricingCategory in interface BasePriceableTarget

Since:

Pricing Client 2.0.4

See Also:

• BasePriceableTarget.getPricingCategory()

getTypeFromDirectVariantMap

public Map<String,Boolean> getTypeFromDirectVariantMap()

getAttributes

public Map<String,Object> getAttributes()

Additional attributes. These are primarily useful for targeting by price list rules and will be excluded from the response from the PriceInfosEndpoint to reduce payload size.

setTargetId

public void setTargetId(String targetId)

Description copied from interface: BasePriceableTarget

Sets the identifier of the target.

Specified by:

setTargetId in interface BasePriceableTarget

Parameters:

targetId - the identifier of the target.

See Also:

• BasePriceableTarget.getTargetId()

setTargetType

public void setTargetType(String targetType)

Description copied from interface: BasePriceableTarget

Sets the type of the target, e.g., SKU or PRICING_KEY.

Specified by:

setTargetType in interface BasePriceableTarget

Parameters:

targetType - the type of the target.

See Also:

• BasePriceableTarget.getTargetType()

setTargetQuantity

public void setTargetQuantity(Integer targetQuantity)

The quantity of the entity to be priced. This is used to determine when a price data tier should apply as the best overall price.

Since:

Pricing Client 2.0.3

setPriceableFields

public void setPriceableFields(Map<String,javax.money.MonetaryAmount> priceableFields)

List of priceable fields for the target. This can include such fields as basePrice and baseCost.

setVendorRef

public void setVendorRef(String vendorRef)

Description copied from interface: BasePriceableTarget

Key to external system indicating that this PriceableTarget is specific to a vendor.

Specified by:

setVendorRef in interface BasePriceableTarget

Parameters:

vendorRef - a reference to a vendor (e.g. vendorId or vendorCode)

See Also:

• BasePriceableTarget.getVendorRef()

setPaymentStrategy

public void setPaymentStrategy(String paymentStrategy)

Description copied from interface: BasePriceableTarget

Sets the payment strategy of the price of the target, e.g., ONE_TIME, PREPAID, POSTPAID.

Specified by:

setPaymentStrategy in interface BasePriceableTarget

Parameters:

paymentStrategy - the payment strategy of the price desired for the target.

Since:

2.0.4

See Also:

• BasePriceableTarget.getPaymentStrategy()

setRecurringPeriodFrequency

public void setRecurringPeriodFrequency(Integer recurringPeriodFrequency)

Description copied from interface: BasePriceableTarget

Sets the frequency of the recurring price of the target, e.g., 1, 6, 12.

Specified by:

setRecurringPeriodFrequency in interface BasePriceableTarget

Parameters:

recurringPeriodFrequency - the frequency of the recurring price desired for the target.

Since:

2.0.4

See Also:

• BasePriceableTarget.getTermDurationLength()

setRecurringPeriodType

public void setRecurringPeriodType(String recurringPeriodType)

Description copied from interface: BasePriceableTarget

Sets the recurring period type of the target, e.g., MONTHLY, QUARTERLY, ANNUALLY.

Specified by:

setRecurringPeriodType in interface BasePriceableTarget

Parameters:

recurringPeriodType - the recurring period type of the price desired for the target

Since:

2.0.4

See Also:

• BasePriceableTarget.getTermDurationLength()

setTermDurationLength

public void setTermDurationLength(Integer termDurationLength)

Description copied from interface: BasePriceableTarget

Sets the term duration length of the target, e.g., 12, 24, 36.

Specified by:

setTermDurationLength in interface BasePriceableTarget

Parameters:

termDurationLength - the term duration length of the price desired for the target.

Since:

Pricing Client 2.0.3

See Also:

• BasePriceableTarget.getTermDurationLength()

setTermDurationType

public void setTermDurationType(String termDurationType)

Description copied from interface: BasePriceableTarget

Sets the term duration type of the target, e.g., DAYS, MONTHS, YEARS.

Specified by:

setTermDurationType in interface BasePriceableTarget

Parameters:

termDurationType - the term duration type of the price desired for the target

Since:

Pricing Client 2.0.3

See Also:

• BasePriceableTarget.getTermDurationType()

setCharacteristics

public void setCharacteristics(Map<String,String> characteristics)

Description copied from interface: BasePriceableTarget

Sets the characteristics of the target, e.g., size: red, capacity: 128GB.

Specified by:

setCharacteristics in interface BasePriceableTarget

Parameters:

characteristics - the characteristics of the target

Since:

Pricing Client 2.0.3

See Also:

• BasePriceableTarget.getCharacteristics()

setPricingCategory

public void setPricingCategory(String pricingCategory)

Description copied from interface: BasePriceableTarget

Optional. A category id that can be targeted in a pricing modifier formula to transform pricing for products assigned to it.

Specified by:

setPricingCategory in interface BasePriceableTarget

Since:

Pricing Client 2.0.4

See Also:

• BasePriceableTarget.getPricingCategory()

setTypeFromDirectVariantMap

public void setTypeFromDirectVariantMap(Map<String,Boolean> typeFromDirectVariantMap)

setAttributes

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

Additional attributes. These are primarily useful for targeting by price list rules and will be excluded from the response from the PriceInfosEndpoint to reduce payload size.

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