Index (Offer Services Client 2.0.2-GA API)

A B C D E F G H I L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

Adjustment - Class in com.broadleafcommerce.promotion.offer.client.web.context.info: An adjustment made to any part of the order.
Adjustment() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment
ANNUALLY - Enum constant in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultRecurringPeriodType

B

BestOfferCombination - Class in com.broadleafcommerce.promotion.offer.client.web.context.discounts
BestOfferCombination() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.discounts.BestOfferCombination
BroadleafOfferClientAutoConfiguration - Class in com.broadleafcommerce.promotion.offer.client.autoconfiguration
BroadleafOfferClientAutoConfiguration() - Constructor for class com.broadleafcommerce.promotion.offer.client.autoconfiguration.BroadleafOfferClientAutoConfiguration
BroadleafOfferClientModule - Class in com.broadleafcommerce.promotion.offer.client.jackson
BroadleafOfferClientModule() - Constructor for class com.broadleafcommerce.promotion.offer.client.jackson.BroadleafOfferClientModule

C

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Codes
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsage
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.BestOfferCombination
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.CodeResponse
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.EvaluateOfferResponse
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemAdjustment
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentLineItemDto
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.FreeGiftItem
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ItemProrationDetail
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.LineItemRef
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferItemDetail
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustmentDto
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustmentDto
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Voucher
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferCodeDto
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferUsabilityInfo
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItemDto
canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.RecurringPriceDetail
CodeResponse - Class in com.broadleafcommerce.promotion.offer.client.web.context.discounts
CodeResponse() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.discounts.CodeResponse
Codes - Class in com.broadleafcommerce.promotion.offer.client.web.context: DTO containing codes used to apply offers to orders.
Codes() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.Codes
CodeUsabilityInfo - Class in com.broadleafcommerce.promotion.offer.client.web.context: Contains information on a code's usability.
CodeUsabilityInfo() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo
CodeUsabilityType - Enum Class in com.broadleafcommerce.promotion.offer.client.web.context.type: Enumerates the different values possible for CodeUsabilityInfo.getCodeUsabilityType().
CodeUsage - Class in com.broadleafcommerce.promotion.offer.client.web.context: Information on a CodeUsabilityInfo.getCodeToUse() usage for a related offer.
CodeUsage() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsage
com.broadleafcommerce.promotion.offer.client.autoconfiguration - package com.broadleafcommerce.promotion.offer.client.autoconfiguration
com.broadleafcommerce.promotion.offer.client.jackson - package com.broadleafcommerce.promotion.offer.client.jackson
com.broadleafcommerce.promotion.offer.client.jackson.context.info - package com.broadleafcommerce.promotion.offer.client.jackson.context.info
com.broadleafcommerce.promotion.offer.client.web.context - package com.broadleafcommerce.promotion.offer.client.web.context
com.broadleafcommerce.promotion.offer.client.web.context.discounts - package com.broadleafcommerce.promotion.offer.client.web.context.discounts
com.broadleafcommerce.promotion.offer.client.web.context.info - package com.broadleafcommerce.promotion.offer.client.web.context.info
com.broadleafcommerce.promotion.offer.client.web.context.type - package com.broadleafcommerce.promotion.offer.client.web.context.type
combineValidationResults(OfferAndOfferCodeUsageValidationResult) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult
CUSTOMER_CONTEXT_HEADER - Static variable in class com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext
CustomerContext - Class in com.broadleafcommerce.promotion.offer.client.web.context: DTO for holding customer information for determining which offers apply to a customer.
CustomerContext() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext

D

DAYS - Enum constant in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultFreeTrialLengthUnits
DAYS - Enum constant in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultTermDurationType
DefaultAdjustmentType - Enum Class in com.broadleafcommerce.promotion.offer.client.web.context.type: Defines the default types for an Adjustment, primarily determining when it should be applied to an order or items in an order.
DefaultFreeTrialLengthUnits - Enum Class in com.broadleafcommerce.promotion.offer.client.web.context.type: Defines the default values possible for Free Trial Adjustment length units.
DefaultRecurringPeriodType - Enum Class in com.broadleafcommerce.promotion.offer.client.web.context.type: Defines the default period types possible for recurring prices.
DefaultTermDurationType - Enum Class in com.broadleafcommerce.promotion.offer.client.web.context.type: Defines the default term duration types possible for recurring prices.
deserialize(JsonParser, DeserializationContext) - Method in class com.broadleafcommerce.promotion.offer.client.jackson.context.info.ProratedItemOfferAdjustmentDeserializer
deserialize(JsonParser, DeserializationContext) - Method in class com.broadleafcommerce.promotion.offer.client.jackson.context.info.ProratedOfferAdjustmentDeserializer
Destination - Class in com.broadleafcommerce.promotion.offer.client.web.context: DTO containing relevant information about a FulfillmentGroup's destination address.
Destination() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.Destination

E

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Codes
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsage
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.BestOfferCombination
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.CodeResponse
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.EvaluateOfferResponse
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemAdjustment
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentLineItemDto
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.FreeGiftItem
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ItemProrationDetail
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.LineItemRef
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferItemDetail
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustmentDto
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustmentDto
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Voucher
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferCodeDto
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferUsabilityInfo
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItemDto
equals(Object) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.RecurringPriceDetail
EvaluateOfferResponse - Class in com.broadleafcommerce.promotion.offer.client.web.context.discounts
EvaluateOfferResponse() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.discounts.EvaluateOfferResponse

F

FREE_TRIAL - Enum constant in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultAdjustmentType: The adjustment will be applied as a deferment of payment until a trial period is completed.
FreeGiftItem - Class in com.broadleafcommerce.promotion.offer.client.web.context.info: Represents a free gift item to be automatically added to cart from free gift offers.
FreeGiftItem() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.info.FreeGiftItem
FulfillmentGroup<T extends FulfillmentLineItem> - Interface in com.broadleafcommerce.promotion.offer.client.web.context: DTO containing information about a group of items that share the same fulfillment information (means, destination, and payment info).
FulfillmentGroupDto<T extends FulfillmentLineItem> - Class in com.broadleafcommerce.promotion.offer.client.web.context
FulfillmentGroupDto() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
FulfillmentGroupResponse - Class in com.broadleafcommerce.promotion.offer.client.web.context.discounts: A DTO structure that provides pricing information for a given fulfillment group via offer adjustments.
FulfillmentGroupResponse() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse
FulfillmentLineItem - Interface in com.broadleafcommerce.promotion.offer.client.web.context: DTO containing information about fulfilling an OrderLineItem as part of a FulfillmentGroup.
FulfillmentLineItemDto - Class in com.broadleafcommerce.promotion.offer.client.web.context
FulfillmentLineItemDto() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentLineItemDto
FUTURE_CREDIT - Enum constant in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultAdjustmentType: The adjustment should be applied at a future time as a credit to the user.

G

getAccountId() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext: The id for the account that is in the current context.
getAddressLine1() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
getAddressLine2() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
getAddressLine3() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
getAdjustedFulfillmentTotal() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The total of all OrderResponse.fulfillmentGroupResponses with adjustments applied via the sum of all FulfillmentGroupResponse.getAdjustedTotal().
getAdjustedSubtotal() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The subtotal of all OrderResponse.orderItemResponses with adjustments applied via the sum of all ItemResponse.getAdjustedTotal().
getAdjustedTotal() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse: The total final price of this item with adjustments applied.
getAdjustedTotal() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: The total final price of this item with adjustments applied.
getAdjustedTotal() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: The final price of this item with adjustments applied.
getAdjustedTotal() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The total of all OrderResponse.fulfillmentGroupResponses with adjustments applied.
getAdjustment() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.FreeGiftItem: The Adjustment for this free gift item.
getAdjustmentAmount() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: The amount of this adjustment.
getAdjustments() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse: Adjustment information for this fulfillment group.
getAdjustments() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: Adjustment information for this order.
getAllCodes() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Codes: Returns the combined set of Codes.sharedCodes and Codes.trackingIds.
getAmount() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustment: The amount of the adjustment applied to the item.
getAmount() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustmentDto
getAmount() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustment: The amount of the prorated adjustment for the item.
getAmount() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustmentDto: The amount of the prorated adjustment for the item.
getAttributes() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination: Additional, unspecified attributes.
getAttributes() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroup: Additional, unspecified attributes.
getAttributes() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
getAttributes() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: Dynamic attributes that are a part of the offer.
getAttributes() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem: Additional, unspecified attributes.
getAttributes() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto: Additional assortment of attributes that can be used for targeting by Offers.
getAttributes() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferCodeDto
getAttributes() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.Order: Additional, unspecified attributes.
getAttributes() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
getBasePricePerItem() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: The original unadjusted price for each item.
getBaseRecurringPricePerItem() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: The original unadjusted recurring price for each item used for discount calculations.
getBeginPeriod() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: Deprecated.
No longer valid as more than one subscription discount may be applied. Users should look at ItemAdjustment instead.
getBeginPeriod() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: If Adjustment.type is DefaultAdjustmentType.RECURRING_DISCOUNT, this is the beginning period for the discount.
getBestOfferCombination() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.EvaluateOfferResponse
getBusinessName() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
getCampaignTrackingId() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsage: The tracking id of the campaign for which this code usability info belongs.
getCampaignTrackingId() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: The campaign tracking id (if any) for this adjustment.
getCampaignTrackingIds() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: The tracking identifiers of the campaigns of which this offer is a part.
getCartLabel() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: A label for this offer typically used by the storefront.
getCartSubtotal() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
getCity() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
getClazz() - Method in class com.broadleafcommerce.promotion.offer.client.jackson.context.info.ProratedItemOfferAdjustmentDeserializer
getClazz() - Method in class com.broadleafcommerce.promotion.offer.client.jackson.context.info.ProratedOfferAdjustmentDeserializer
getCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.CodeResponse
getCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferCodeDto
getCodeResponseMap() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.EvaluateOfferResponse
getCodeResponseMap() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: A map of codes to responses detailing why a potential offer did not apply.
getCodes() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.Order: DTO containing codes used to apply offers to orders.
getCodes() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto: Deprecated.
getCodeToUse() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo: A shared code for which this code usability tracks usage info.
getCodeUsabilityType() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo: Describes the usability of the code.
getCodeUsed() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: The code used (if any) that triggered the application of the offer for this adjustment.
getCodeUsed() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustment: The code used (if any) that triggered the application of the offer for this adjustment.
getCodeUsed() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustmentDto
getCodeUsed() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustment: The code used (if any) that triggered the application of the offer for this adjustment.
getCodeUsed() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustmentDto: The code used (if any) that triggered the application of the offer for this adjustment.
getCodeUsed() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Voucher: The code used (if any) that triggered the application of the offer for this voucher.
getCodeUsedByTrackingId() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Codes: Deprecated.
since this is not used after 2.0.0
getCodeUses() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo: Infos on the uses of the related code used to determine if an offer's shared code can still be used.
getCurrency() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.Order: The Currency.getCurrencyCode().
getCurrency() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
getCustomerContext() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.Order: The CustomerContext associated with the API request.
getCustomerContext() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
getCustomerId() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext: The id for the customer that is in the current context.
getCustomerSegmentIds() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext: The list of id's that correspond to customer segments that this customer is a part of.
getDescription() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: Description of this offer.
getDestination() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroup: The Destination containing information about this fulfillment group's destination address.
getDestination() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
getDestinationName() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
getEndPeriod() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: Deprecated.
No longer valid as more than one subscription discount may be applied. Users should look at ItemAdjustment instead.
getEndPeriod() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: If Adjustment.type is DefaultAdjustmentType.RECURRING_DISCOUNT, this is the ending period for the discount.
getFaxNumber() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroup: The fax number for this fulfillment group.
getFaxNumber() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
getFreeGiftItems() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The FreeGiftItems to add from the free gift offers.
getFreeTrialLength() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: If Adjustment.type is DefaultAdjustmentType.FREE_TRIAL, then this defines the free trial's length.
getFreeTrialLengthUnits() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: If Adjustment.type is DefaultAdjustmentType.FREE_TRIAL, then this defines the units for Adjustment.freeTrialLength.
getFulfillmentGroupId() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse: The id for the FulfillmentGroup that this FulfillmentGroupResponse represents.
getFulfillmentGroupRef() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItem: The reference to the corresponding fulfillment group for this item.
getFulfillmentGroupRef() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItemDto
getFulfillmentGroupResponses() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: Adjustment information for each Order.getFulfillmentGroups() fulfillment group of the order}.
getFulfillmentGroups() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.Order: Groups of items sharing the same fulfillment info (method, destination, payment info).
getFulfillmentGroups() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
getFulfillmentGroupSavings() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse: The total savings across all FulfillmentGroupResponse.adjustments.
getFulfillmentItemOfferDetails() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse: Adjustment information for each FulfillmentGroup.getFulfillmentItems() fulfillment line item}.
getFulfillmentItems() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroup: Items being fulfilled together in this group.
getFulfillmentItems() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
getFulfillmentItemSavings() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse: The total savings across all FulfillmentGroupResponse.fulfillmentItemOfferDetails.
getFulfillmentOptionName() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroup: Deprecated.
instead see the keys in FulfillmentGroup.getPriceBeforeAdjustmentsByServiceLevel()
getFulfillmentOptionName() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
getFulfillmentOptionType() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroup: The type of fulfillment that will be used for this fulfillment group.
getFulfillmentOptionType() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
getFulfillmentPrice() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItem: The fulfillment price of this order item.
getFulfillmentPrice() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItemDto
getFulfillmentSavings() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse: The total savings across all FulfillmentGroupResponse.adjustments and FulfillmentGroupResponse.fulfillmentItemOfferDetails.
getFulfillmentSavings() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The total savings from adjustments applied to fulfillment via the sum of all FulfillmentGroupResponse.getFulfillmentSavings().
getFutureCreditSavings() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse: The future credit savings across FulfillmentGroupResponse.adjustments and FulfillmentGroupResponse.fulfillmentItemOfferDetails, indicated by Adjustment.isFutureCredit().
getFutureCreditSavings() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: The future credit savings across ItemResponse.itemResponseDetails, indicated by Adjustment.isFutureCredit().
getFutureCreditSavings() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: The future credit savings across ItemResponseDetail.itemAdjustments, indicated by Adjustment.isFutureCredit().
getGiftFee() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.FreeGiftItem: Indicates the cost of the free gift item.
getId() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroup: The id of this group.
getId() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
getId() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: The context ID of the offer.
getInvalidOfferCodes() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult: The list of offer codes which are no longer valid.
getInvalidOfferRefIds() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult: The list of offer id's which are no longer valid.
getIsoCountryAlpha2() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination: ISO 3166 country code in Alpha-2 format (e.g., CN, FR, US).
getIsoCountrySubdivision() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination: ISO 3166 country subdivision code in Alpha-2 format (e.g., CA, HI, TX).
getItemAdjustmentQuantity() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: The quantity of the current line item that this offer was applied to.
getItemAdjustmentQuantity() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferItemDetail: The quantity of the qualifier or target item that this offer was applied to.
getItemAdjustments() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: Adjustment information for this line item.
getItemId() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: The id for the LineItem that this ItemResponse represents.
getItemId() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferItemDetail: The id of the item that is a qualifier or target.
getItemProrationDetails() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustment: The details about how this prorated adjustment on a per-quantity basis.
getItemProrationDetails() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustmentDto: The details about how this prorated adjustment on a per-quantity basis.
getItemResponseDetails() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: Detailed pricing information for this item.
getLineItem() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustment: The LineItemRef of the LineItem that gets this adjustment.
getLineItem() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustmentDto
getLineItem() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustment: The LineItemRef of the LineItem that gets this adjustment.
getLineItem() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustmentDto: The LineItemRef of the LineItem that gets this adjustment.
getLineNumber() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.LineItemRef
getLineNumber() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem: The line number of this order item.
getLineNumber() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto: Identifier for this line item.
getListOfCodes() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.BestOfferCombination
getLocale() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.Order: The Locale for the order
getLocale() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
getMaxPeriodsInAYear() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.RecurringPriceDetail: Returns the maximum number of periods possible in a year based on the RecurringPriceDetail.periodType.
getModuleName() - Method in class com.broadleafcommerce.promotion.offer.client.jackson.BroadleafOfferClientModule
getName() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: Display name for this offer.
getNotAppliedReasonMessage() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.CodeResponse
getNotAppliedReasonResponseCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.CodeResponse
getNumberOfPeriodsInAYear() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.RecurringPriceDetail: Determines the maximum number of periods to recur during, normalized to a period type of "YEARLY".
getOffer() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustment: The OfferRef for the offer that caused this adjustment to be applied.
getOffer() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustmentDto
getOffer() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustment: The OfferRef for the offer where this prorated adjustment is from.
getOffer() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustmentDto: The OfferRef for the offer where this prorated adjustment is from.
getOfferCodeRef() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: A reference to the OfferCode (if any).
getOfferCodeRef() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Voucher: A reference to the OfferCode (if any).
getOfferCodes() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
getOfferDetails() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.BestOfferCombination
getOfferId() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsage: The OfferRef.getId() of the offer to whose shared code this code usability info belongs.
getOfferId() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferItemDetail: The offer id where this item is a qualifier or target of.
getOfferId() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Voucher
getOfferId() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferUsabilityInfo
getOfferRef() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: A reference to the OfferRef.
getOfferRef() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.FreeGiftItem: A reference to the OfferRef.
getOfferRef() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Voucher: A reference to the OfferRef
getOfferUses() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: The number of times that the offer this adjustment was created from is applied.
getOfferUses() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferItemDetail: The number of times the offer is applied.
getOrderItemResponses() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: Adjustment information for each Order.getOrderLineItems() order item of the order}.
getOrderItemSavings() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The total savings from adjustments applied to order items via the sum of all ItemResponse.getSavings().
getOrderLineItems() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.Order: Items being sold in this order.
getOrderLineItems() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
getOrderNumber() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The orderNumber corresponding to the Order that this OrderResponse represents.
getOrderNumber() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.Order: Number used to identify this order.
getOrderNumber() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
getOrderSavings() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The savings from adjustments applied to the order via OrderResponse.adjustments.
getOrderSubmitDate() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto: The Instant of when this order was submitted.
getParentLineNumber() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItem: The LineItem.getLineNumber() of this item's parent item.
getParentLineNumber() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItemDto
getPeriodFrequency() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.RecurringPriceDetail: The frequency with which the recurring RecurringPriceDetail.price should be charged., e.g., a value of 1 combined with RecurringPriceDetail.periodType of MONTH would indicate to a subscription service that the RecurringPriceDetail.price should be charged every 1 month.
getPeriodLimit() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.RecurringPriceDetail: Defines the number of periods the price should recur.
getPeriodType() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.RecurringPriceDetail: The period type for the price, e.g.
getPostalCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
getPotentialSavings() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.CodeResponse
getPrice() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItemDto: Gets the price: Sale if present and less than standard, otherwise standard.
getPrice() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.RecurringPriceDetail: The amount of the recurring price.
getPriceBeforeAdjustments() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroup: The shipping price of this fulfillment group before adjustments are applied.
getPriceBeforeAdjustments() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto: Return the sum of values by service level if populated; otherwise, return the value set directly
getPriceBeforeAdjustmentsByServiceLevel() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroup: Out of box implementations will return a Map.
getPriceBeforeAdjustmentsByServiceLevel() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
getPrimaryPhone() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroup: The primary phone number for this fulfillment group.
getPrimaryPhone() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
getProductId() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.FreeGiftItem: The sku of the item to be automatically added.
getProratedAdjustments() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: Prorated adjustment information for this line item.
getProratedFulfillmentAdjustments() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse: Prorated fulfillment adjustments for the fulfillment group itself.
getProratedItemAdjustments() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: Prorated adjustment information for this line item.
getProrationType() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: Determines how an offer's discount amount is distributed across the offer's related order item types.
getQualifierDetails() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: A list of OfferItemDetails representing the qualifier items where this adjustment was from.
getQuantity() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: The total quantity across all price variations of this item.
getQuantity() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: The quantity of items that match this detail.
getQuantity() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.FreeGiftItem: The quantity of the item to be automatically added.
getQuantity() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ItemProrationDetail: The total quantity.
getQuantity() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustment: The quantity of merchandising items from the LineItem to which this adjustment applies.
getQuantity() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustmentDto
getQuantity() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustment: The quantity of merchandising items from the LineItem to which this adjustment applies.
getQuantity() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustmentDto: The quantity of merchandising items from the EnhancedLineItem to which this adjustment applies.
getQuantity() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem: Number of like merchandising items being sold or fulfilled together in this order.
getQuantity() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto: The quantity of the item in the order.
getQuantityPerUsage() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: The quantity per offer usage of the target item that this adjustment is for.
getQuantityPerUsage() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferItemDetail: The quantity per offer usage of the item that is a qualifier or target.
getRecipientName() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
getRecurringAdjustedTotal() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: The final recurring (a.k.a., subscription) price of this item with adjustments applied.
getRecurringAdjustedTotal() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: The final recurring (a.k.a., subscription) price of this item with adjustments applied.
getRecurringPeriodNormalizationFactor() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.RecurringPriceDetail: Determines the factor when trying to determine the number of periods to use in discount calculations in order to normalize the term duration into the number of periods in terms of years.
getRecurringSavings() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: The savings to apply to recurring (a.k.a., subscription) prices.
getRecurringSavings() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: The savings to apply to recurring (a.k.a., subscription) prices.
getRelatedOrderLineItemNumber() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentLineItem: The line number of the related OrderLineItem.
getRelatedOrderLineItemNumber() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentLineItemDto
getSalePrice() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem: Special price at which to sell or fulfill a single merchandising item represented by this order line item.
getSalePrice() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto: Sale price.
getSaleRecurringPrice() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem: Represents the details related to a sale recurring (or subscription) price include the terms.
getSaleRecurringPrice() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto
getSavings() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: The total savings across all ItemResponse.itemResponseDetails.
getSavings() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: The total savings across all ItemResponseDetail.itemAdjustments.
getSecondaryPhone() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroup: The secondary phone number for this fulfillment group.
getSecondaryPhone() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
getSegment() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItem: The segment which this item is part of.
getSegment() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItemDto
getSenderName() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
getServiceLevel() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: The serviceLevel that this adjustment applies to (typically used only with fulfillment group offers to indicate that the discount applies to the portion of the fulfillment price related to a specific service level.
getServiceLevel() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem
getSharedCodes() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Codes: Code strings added to the order that may be tied to an offer's shared codes and used to apply it.
getStandardPrice() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem: The standard price at which a single merchandising item represented by this order line item is sold or fulfilled.
getStandardPrice() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto: The one-time price typically discounted.
getStandardRecurringPrice() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem: Represents the details related to a recurring (or subscription) price include the terms.
getStandardRecurringPrice() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto
getTermDurationLength() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.RecurringPriceDetail: The length of the terms, e.g., if this is 36 and RecurringPriceDetail.termDurationType is MONTHS, then the RecurringPriceDetail.price should be charged for 36 months.
getTermDurationType() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.RecurringPriceDetail: The term duration type, e.g.
getTimeOfRequest() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.Order: The time that the request to apply offers to this order was made.
getTimeOfRequest() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
getTotalFutureCredits() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The total future credits from adjustments applied across all areas of the order.
getTotalSavings() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The total savings from adjustments applied across all areas of the order.
getTrackingIds() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Codes: Tracking ids associated with external systems like the Campaigns Service that could be tied to an offer's campaign tracking ids.
getType() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment
getType() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.LineItemRef: The type of this line item.
getUnitAmount() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ItemProrationDetail: The unit proration amount.
getUsername() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext: The customer's username.
getUsesLeft() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsage: The number of uses left for this info's related shared code.
getUsesLeft() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferUsabilityInfo: The number of uses left for this info's related offer.
getUsesLeftPerCustomer() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsage: The number of uses left for the current customer for this info's related offer.
getUsesLeftPerCustomer() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferUsabilityInfo: The number of uses left for the current customer for this info's related offer.
getValidationFailureMessages() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult: A map which holds pairings of Strings in invalidOfferRefIds and invalidOfferCodes as key values to messages as values which hold a description of why an offer is no longer valid.
getVoucherCampaignId() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Voucher: The id of the voucher campaign, which will be used to generate voucher codes after a successful checkout.
getVouchers() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The Vouchers that this order is qualified for.
getVouchers() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto: The Vouchers that this OrderDto has.

H

hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Codes
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsage
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.BestOfferCombination
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.CodeResponse
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.EvaluateOfferResponse
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemAdjustment
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentLineItemDto
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.FreeGiftItem
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ItemProrationDetail
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.LineItemRef
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferItemDetail
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustmentDto
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustmentDto
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Voucher
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferCodeDto
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferUsabilityInfo
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItemDto
hashCode() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.RecurringPriceDetail
hasRecurringPrice() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto: Helper method to determine if there is any kind of recurring price.

I

isAnnually(String) - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultRecurringPeriodType
isAppliedToSalePrice() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemAdjustment: Whether this adjustment is applied to the sale price of the item.
isAppliedToSalePrice() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: Whether the sale price or the standard price was adjusted.
isAppliedToSalePrice() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: Whether the ItemResponseDetail.itemAdjustments are applied to the sale price of the item.
isAppliedToSaleRecurringPrice() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: Whether the sale recurring price or the standard recurring price was adjusted.
isAppliedToSaleRecurringPrice() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: Whether the ItemResponseDetail.itemAdjustments are applied to the sale recurring price of the item.
isAuthenticated() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext: Whether the customer is authenticated.
isBusiness() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
isCanUse() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsage: If this code can be used for this offer based on it's max uses.
isCanUse() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferUsabilityInfo: If this offer can be used based on its max uses.
isCodeUsable() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo: Whether the related shared code's parent OfferRef has uses left.
isCombinable() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: Whether the offer is marked as combinable, meaning that it can be combined with other offers.
isDays(String) - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultFreeTrialLengthUnits
isDays(String) - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultTermDurationType
isDiscountable() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem: Whether this line item may receive discounts.
isDiscountable() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto: Whether the item is discountable.
isFreeTrial(String) - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultAdjustmentType: Whether the type (usually from a call to Adjustment.getType()) matches DefaultAdjustmentType.FREE_TRIAL type.
isFreeTrialApplied() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: Whether a free trial offer was applied.
isFreeTrialApplied() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: Whether a DefaultAdjustmentType.FREE_TRIAL type adjustment was applied.
isFutureCredit() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: Deprecated, for removal: This API element is subject to removal in a future version.
Use Adjustment.getType()
isFutureCredit() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: Future credit means that the associated adjustment will be discounted at a later time to the user via a credit.
isFutureCredit(String) - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultAdjustmentType: Whether the type (usually from a call to Adjustment.getType()) matches DefaultAdjustmentType.FUTURE_CREDIT type.
isHasMaxUsage() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsage: Whether this code has a maximum limit to the number of times it can be used as defined by its max uses.
isHasMaxUsage() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferUsabilityInfo: Whether this offer has a maximum limit to the number of times it can be used as defined by its max uses.
isHasMaxUsagePerUser() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsage: Whether this offer has a maximum limit to the number of times it can be used by a single user.
isHasMaxUsagePerUser() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferUsabilityInfo: Whether this offer has a maximum limit to the number of times it can be used by a single user.
isMonthly(String) - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultRecurringPeriodType
isMonths(String) - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultFreeTrialLengthUnits
isMonths(String) - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultTermDurationType
isOrderDiscount(String) - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultAdjustmentType: Whether the type (usually from a call to Adjustment.getType()) matches DefaultAdjustmentType.ORDER_DISCOUNT type.
isQuarterly(String) - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultRecurringPeriodType
isRecurringDiscount(String) - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultAdjustmentType: Whether the type (usually from a call to Adjustment.getType()) matches DefaultAdjustmentType.RECURRING_DISCOUNT type.
isRecurringDiscountApplied() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail
isRunOrderAndItemOffers() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.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.
isRunOrderAndItemOffers() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
isSubscription() - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem: Whether this is a subscription item and thus qualifies it for future billing discounts.
isSubscription() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto
isTargetsCanBeTargets() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: Deprecated.
since 1.6, in favor of offer stacking and combinability
isTotalitarian() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: Whether the offer is marked as totalitarian, meaning that it can be the only offer applied..
isUsageValid() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult: If this is set to false, one or more offers or offer codes is no longer valid and need to be removed from the list of previously applied offers.
isWeeks(String) - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultFreeTrialLengthUnits
isWeeks(String) - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultTermDurationType
isYears(String) - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultTermDurationType
ItemAdjustment - Class in com.broadleafcommerce.promotion.offer.client.web.context.discounts: An adjustment for a line item of the order.
ItemAdjustment() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemAdjustment
ItemProrationDetail - Class in com.broadleafcommerce.promotion.offer.client.web.context.info: Represents the detail for an order-level adjustment for an item on a per-quantity basis.
ItemProrationDetail() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.info.ItemProrationDetail
ItemResponse - Class in com.broadleafcommerce.promotion.offer.client.web.context.discounts: A DTO structure that provides pricing information for a given LineItem via offer adjustments.
ItemResponse() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse
ItemResponseDetail - Class in com.broadleafcommerce.promotion.offer.client.web.context.discounts: Collection of pricing details for an ItemResponse.
ItemResponseDetail() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail

L

LineItem - Interface in com.broadleafcommerce.promotion.offer.client.web.context: DTO containing information regarding a item in an Order or FulfillmentGroup.
LineItemDto - Class in com.broadleafcommerce.promotion.offer.client.web.context
LineItemDto() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto
LineItemRef - Class in com.broadleafcommerce.promotion.offer.client.web.context.info: Slimmed-down reference to a LineItem that allows specifying what type of line item it is.
LineItemRef() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.info.LineItemRef

M

MAX_USES - Enum constant in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.CodeUsabilityType: Means that the code cannot be used because it has been used the maximum number of times already.
MONTHLY - Enum constant in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultRecurringPeriodType
MONTHS - Enum constant in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultFreeTrialLengthUnits
MONTHS - Enum constant in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultTermDurationType

N

NO_CAMPAIGNS_MATCH - Enum constant in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.CodeUsabilityType: Means that the code cannot be used because it matches no campaigns.
NO_OFFER_CODES_MATCH - Enum constant in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.CodeUsabilityType: Means that the code cannot be used because it matches no offer codes.
NO_OFFERS_MATCH - Enum constant in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.CodeUsabilityType: Means that the code cannot be used because it matches no offers.

O

OfferAndOfferCodeUsageValidationResult - Class in com.broadleafcommerce.promotion.offer.client.web.context: DTO holding the resulting information about the validity of offers and offer code usages.
OfferAndOfferCodeUsageValidationResult() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult
OfferCodeDto - Class in com.broadleafcommerce.promotion.offer.client.web.context
OfferCodeDto() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.OfferCodeDto
OfferItemDetail - Class in com.broadleafcommerce.promotion.offer.client.web.context.info: A DTO structure that provides offer qualifier or target information for a given LineItem.
OfferItemDetail() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferItemDetail
OfferRef - Class in com.broadleafcommerce.promotion.offer.client.web.context.info: Slimmed-down reference to an offer.
OfferRef() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef
OfferUsabilityInfo - Class in com.broadleafcommerce.promotion.offer.client.web.context
OfferUsabilityInfo() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.OfferUsabilityInfo
Order<O extends OrderLineItem,F extends FulfillmentGroup<?>> - Interface in com.broadleafcommerce.promotion.offer.client.web.context: DTO for holding order data relevant for determining whether offers apply to a request.
ORDER_DISCOUNT - Enum constant in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultAdjustmentType: The adjustment will be applied on the order itself at checkout or whenever payment is captured after checkout.
OrderDto<F extends FulfillmentGroupDto<FulfillmentLineItemDto>> - Class in com.broadleafcommerce.promotion.offer.client.web.context
OrderDto() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
OrderLineItem - Interface in com.broadleafcommerce.promotion.offer.client.web.context: DTO containing information regarding an item in an Order.
OrderLineItemDto - Class in com.broadleafcommerce.promotion.offer.client.web.context
OrderLineItemDto() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItemDto
OrderResponse - Class in com.broadleafcommerce.promotion.offer.client.web.context.discounts: A DTO structure that provides pricing information across a given order for offer adjustments.
OrderResponse() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse

P

periodsPerYear() - Method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultRecurringPeriodType
ProratedItemOfferAdjustment - Interface in com.broadleafcommerce.promotion.offer.client.web.context.info: DTO containing prorated price adjustment information for a LineItem caused by an offer targeting it or using it as a qualifier.
ProratedItemOfferAdjustmentDeserializer<T extends ProratedItemOfferAdjustment> - Class in com.broadleafcommerce.promotion.offer.client.jackson.context.info: Allows deserialization of a ProratedItemOfferAdjustment.
ProratedItemOfferAdjustmentDeserializer(Class<T>) - Constructor for class com.broadleafcommerce.promotion.offer.client.jackson.context.info.ProratedItemOfferAdjustmentDeserializer
ProratedItemOfferAdjustmentDto - Class in com.broadleafcommerce.promotion.offer.client.web.context.info
ProratedItemOfferAdjustmentDto() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustmentDto
ProratedOfferAdjustment - Interface in com.broadleafcommerce.promotion.offer.client.web.context.info: DTO containing prorated price adjustment information for a EnhancedLineItem caused by an order-level or fulfillment group-level offer.
ProratedOfferAdjustmentDeserializer<T extends ProratedOfferAdjustment> - Class in com.broadleafcommerce.promotion.offer.client.jackson.context.info: Allows deserialization of a ProratedOfferAdjustment.
ProratedOfferAdjustmentDeserializer(Class<T>) - Constructor for class com.broadleafcommerce.promotion.offer.client.jackson.context.info.ProratedOfferAdjustmentDeserializer
ProratedOfferAdjustmentDto - Class in com.broadleafcommerce.promotion.offer.client.web.context.info: DTO containing prorated price adjustment information for a EnhancedLineItem caused by an order-level or fulfillment group-level offer.
ProratedOfferAdjustmentDto() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustmentDto

Q

QUARTERLY - Enum constant in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultRecurringPeriodType

R

RECURRING_DISCOUNT - Enum constant in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultAdjustmentType: The adjustment will be applied to future periods typically by a subscription service rather than at initial checkout.
RecurringPriceDetail - Class in com.broadleafcommerce.promotion.offer.client.web.context: Represents the details related to a recurring (or subscription) price include the terms.
RecurringPriceDetail() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.RecurringPriceDetail

S

setAccountId(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext: The id for the account that is in the current context.
setAddressLine1(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
setAddressLine2(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
setAddressLine3(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
setAdjustedFulfillmentTotal(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The total of all OrderResponse.fulfillmentGroupResponses with adjustments applied via the sum of all FulfillmentGroupResponse.getAdjustedTotal().
setAdjustedSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The subtotal of all OrderResponse.orderItemResponses with adjustments applied via the sum of all ItemResponse.getAdjustedTotal().
setAdjustedTotal(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse: The total final price of this item with adjustments applied.
setAdjustedTotal(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: The total final price of this item with adjustments applied.
setAdjustedTotal(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: The final price of this item with adjustments applied.
setAdjustedTotal(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The total of all OrderResponse.fulfillmentGroupResponses with adjustments applied.
setAdjustment(Adjustment) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.FreeGiftItem: The Adjustment for this free gift item.
setAdjustmentAmount(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: The amount of this adjustment.
setAdjustments(List<Adjustment>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse: Adjustment information for this fulfillment group.
setAdjustments(List<Adjustment>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: Adjustment information for this order.
setAmount(MonetaryAmount) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustment: The amount of the adjustment applied to the item.
setAmount(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustmentDto
setAmount(MonetaryAmount) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustment: The amount of the prorated adjustment for the item.
setAmount(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustmentDto: The amount of the prorated adjustment for the item.
setAppliedToSalePrice(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemAdjustment: Whether this adjustment is applied to the sale price of the item.
setAppliedToSalePrice(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: Whether the sale price or the standard price was adjusted.
setAppliedToSalePrice(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: Whether the ItemResponseDetail.itemAdjustments are applied to the sale price of the item.
setAppliedToSaleRecurringPrice(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: Whether the sale recurring price or the standard recurring price was adjusted.
setAppliedToSaleRecurringPrice(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: Whether the ItemResponseDetail.itemAdjustments are applied to the sale recurring price of the item.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination: Additional, unspecified attributes.
setAttributes(Map<String, Object>) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroup: Additional, unspecified attributes.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: Dynamic attributes that are a part of the offer.
setAttributes(Map<String, Object>) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem: Additional, unspecified attributes.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto: Additional assortment of attributes that can be used for targeting by Offers.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferCodeDto
setAttributes(Map<String, Object>) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.Order: Additional, unspecified attributes.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
setAuthenticated(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext: Whether the customer is authenticated.
setBasePricePerItem(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: The original unadjusted price for each item.
setBaseRecurringPricePerItem(RecurringPriceDetail) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: The original unadjusted recurring price for each item used for discount calculations.
setBeginPeriod(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: Deprecated.
No longer valid as more than one subscription discount may be applied. Users should look at ItemAdjustment instead.
setBeginPeriod(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: If Adjustment.type is DefaultAdjustmentType.RECURRING_DISCOUNT, this is the beginning period for the discount.
setBestOfferCombination(BestOfferCombination) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.EvaluateOfferResponse
setBusiness(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
setBusinessName(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
setCampaignTrackingId(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsage: The tracking id of the campaign for which this code usability info belongs.
setCampaignTrackingId(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: The campaign tracking id (if any) for this adjustment.
setCampaignTrackingIds(Set<String>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: The tracking identifiers of the campaigns of which this offer is a part.
setCanUse(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsage: If this code can be used for this offer based on it's max uses.
setCanUse(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferUsabilityInfo: If this offer can be used based on its max uses.
setCartLabel(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: A label for this offer typically used by the storefront.
setCartSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
setCity(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
setCode(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.CodeResponse
setCode(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferCodeDto
setCodeResponseMap(Map<String, CodeResponse>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.EvaluateOfferResponse
setCodeResponseMap(Map<String, CodeResponse>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: A map of codes to responses detailing why a potential offer did not apply.
setCodes(Codes) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.Order: DTO containing codes used to apply offers to orders.
setCodes(Codes) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto: Deprecated.
setCodeToUse(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo: A shared code for which this code usability tracks usage info.
setCodeUsabilityType(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo: Describes the usability of the code.
setCodeUsed(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: The code used (if any) that triggered the application of the offer for this adjustment.
setCodeUsed(String) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustment: The code used (if any) that triggered the application of the offer for this adjustment.
setCodeUsed(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustmentDto
setCodeUsed(String) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustment: The code used (if any) that triggered the application of the offer for this adjustment.
setCodeUsed(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustmentDto: The code used (if any) that triggered the application of the offer for this adjustment.
setCodeUsed(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Voucher: The code used (if any) that triggered the application of the offer for this voucher.
setCodeUsedByTrackingId(Map<String, String>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Codes: Deprecated.
since this is not used after 2.0.0
setCodeUses(List<CodeUsage>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo: Infos on the uses of the related code used to determine if an offer's shared code can still be used.
setCombinable(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: Whether the offer is marked as combinable, meaning that it can be combined with other offers.
setCurrency(CurrencyUnit) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.Order: The Currency.getCurrencyCode().
setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
setCustomerContext(CustomerContext) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.Order: The CustomerContext associated with the API request.
setCustomerContext(CustomerContext) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
setCustomerId(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext: The id for the customer that is in the current context.
setCustomerSegmentIds(Set<String>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext: The list of id's that correspond to customer segments that this customer is a part of.
setDescription(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: Description of this offer.
setDestination(Destination) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroup: The Destination containing information about this fulfillment group's destination address.
setDestination(Destination) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
setDestinationName(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
setDiscountable(boolean) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem: Whether this line item may receive discounts.
setDiscountable(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto: Whether the item is discountable.
setEndPeriod(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: Deprecated.
No longer valid as more than one subscription discount may be applied. Users should look at ItemAdjustment instead.
setEndPeriod(Integer) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: If Adjustment.type is DefaultAdjustmentType.RECURRING_DISCOUNT, this is the ending period for the discount.
setFaxNumber(String) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroup: The fax number for this fulfillment group.
setFaxNumber(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
setFreeGiftItems(List<FreeGiftItem>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The FreeGiftItems to add from the free gift offers.
setFreeTrialApplied(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: Whether a free trial offer was applied.
setFreeTrialLength(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: If Adjustment.type is DefaultAdjustmentType.FREE_TRIAL, then this defines the free trial's length.
setFreeTrialLengthUnits(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: If Adjustment.type is DefaultAdjustmentType.FREE_TRIAL, then this defines the units for Adjustment.freeTrialLength.
setFulfillmentGroupId(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse: The id for the FulfillmentGroup that this FulfillmentGroupResponse represents.
setFulfillmentGroupRef(String) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItem: The reference to the corresponding fulfillment group for this item.
setFulfillmentGroupRef(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItemDto
setFulfillmentGroupResponses(List<FulfillmentGroupResponse>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: Adjustment information for each Order.getFulfillmentGroups() fulfillment group of the order}.
setFulfillmentGroups(List<F>) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.Order: Groups of items sharing the same fulfillment info (method, destination, payment info).
setFulfillmentGroups(List<F>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
setFulfillmentGroupSavings(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse: The total savings across all FulfillmentGroupResponse.adjustments.
setFulfillmentItemOfferDetails(List<ItemResponse>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse: Adjustment information for each FulfillmentGroup.getFulfillmentItems() fulfillment line item}.
setFulfillmentItems(List<T>) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroup: Items being fulfilled together in this group.
setFulfillmentItems(List<T>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
setFulfillmentItemSavings(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse: The total savings across all FulfillmentGroupResponse.fulfillmentItemOfferDetails.
setFulfillmentOptionName(String) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroup: Deprecated.
instead set the key in the map FulfillmentGroup.getPriceBeforeAdjustmentsByServiceLevel() along with the associated price.
setFulfillmentOptionName(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
setFulfillmentOptionType(String) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroup: The type of fulfillment that will be used for this fulfillment group.
setFulfillmentOptionType(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
setFulfillmentPrice(MonetaryAmount) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItem: Sets the fulfillment price of this order item.
setFulfillmentPrice(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItemDto
setFulfillmentSavings(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse: The total savings across all FulfillmentGroupResponse.adjustments and FulfillmentGroupResponse.fulfillmentItemOfferDetails.
setFulfillmentSavings(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The total savings from adjustments applied to fulfillment via the sum of all FulfillmentGroupResponse.getFulfillmentSavings().
setFutureCredit(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: Deprecated, for removal: This API element is subject to removal in a future version.
Use Adjustment.setType(String)
setFutureCredit(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: Future credit means that the associated adjustment will be discounted at a later time to the user via a credit.
setFutureCreditSavings(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse: The future credit savings across FulfillmentGroupResponse.adjustments and FulfillmentGroupResponse.fulfillmentItemOfferDetails, indicated by Adjustment.isFutureCredit().
setFutureCreditSavings(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: The future credit savings across ItemResponse.itemResponseDetails, indicated by Adjustment.isFutureCredit().
setFutureCreditSavings(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: The future credit savings across ItemResponseDetail.itemAdjustments, indicated by Adjustment.isFutureCredit().
setGiftFee(ItemProrationDetail) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.FreeGiftItem: Indicates the cost of the free gift item.
setHasMaxUsage(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsage: Whether this code has a maximum limit to the number of times it can be used as defined by its max uses.
setHasMaxUsage(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferUsabilityInfo: Whether this offer has a maximum limit to the number of times it can be used as defined by its max uses.
setHasMaxUsagePerUser(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsage: Whether this offer has a maximum limit to the number of times it can be used by a single user.
setHasMaxUsagePerUser(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferUsabilityInfo: Whether this offer has a maximum limit to the number of times it can be used by a single user.
setId(String) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroup: The id of this group.
setId(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
setId(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: The context ID of the offer.
setInvalidOfferCodes(List<String>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult: The list of offer codes which are no longer valid.
setInvalidOfferRefIds(List<String>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult: The list of offer id's which are no longer valid.
setIsoCountryAlpha2(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination: ISO 3166 country code in Alpha-2 format (e.g., CN, FR, US).
setIsoCountrySubdivision(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination: ISO 3166 country subdivision code in Alpha-2 format (e.g., CA, HI, TX).
setItemAdjustmentQuantity(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: The quantity of the current line item that this offer was applied to.
setItemAdjustmentQuantity(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferItemDetail: The quantity of the qualifier or target item that this offer was applied to.
setItemAdjustments(List<ItemAdjustment>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: Adjustment information for this line item.
setItemId(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: The id for the LineItem that this ItemResponse represents.
setItemId(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferItemDetail: The id of the item that is a qualifier or target.
setItemProrationDetails(List<ItemProrationDetail>) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustment: The details about how this prorated adjustment on a per-quantity basis.
setItemProrationDetails(List<ItemProrationDetail>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustmentDto: The details about how this prorated adjustment on a per-quantity basis.
setItemResponseDetails(List<ItemResponseDetail>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: Detailed pricing information for this item.
setLineItem(LineItemRef) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustment: The LineItemRef of the LineItem that gets this adjustment.
setLineItem(LineItemRef) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustmentDto
setLineItem(LineItemRef) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustment: The LineItemRef of the LineItem that gets this adjustment.
setLineItem(LineItemRef) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustmentDto: The LineItemRef of the LineItem that gets this adjustment.
setLineNumber(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.LineItemRef
setLineNumber(String) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem: The line number of this order item.
setLineNumber(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto: Identifier for this line item.
setListOfCodes(List<String>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.BestOfferCombination
setLocale(Locale) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.Order: The Locale for the order
setLocale(Locale) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
setName(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: Display name for this offer.
setNotAppliedReasonMessage(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.CodeResponse
setNotAppliedReasonResponseCode(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.CodeResponse
setOffer(OfferRef) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustment: The OfferRef for the offer that caused this adjustment to be applied.
setOffer(OfferRef) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustmentDto
setOffer(OfferRef) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustment: The OfferRef for the offer where this prorated adjustment is from.
setOffer(OfferRef) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustmentDto: The OfferRef for the offer where this prorated adjustment is from.
setOfferCodeRef(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: A reference to the OfferCode (if any).
setOfferCodeRef(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Voucher: A reference to the OfferCode (if any).
setOfferCodes(List<OfferCodeDto>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
setOfferDetails(Map<String, OfferRef>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.BestOfferCombination
setOfferId(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsage: The OfferRef.getId() of the offer to whose shared code this code usability info belongs.
setOfferId(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferItemDetail: The offer id where this item is a qualifier or target of.
setOfferId(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Voucher
setOfferId(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferUsabilityInfo
setOfferRef(OfferRef) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: A reference to the OfferRef.
setOfferRef(OfferRef) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.FreeGiftItem: A reference to the OfferRef.
setOfferRef(OfferRef) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Voucher: A reference to the OfferRef
setOfferUses(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: The number of times that the offer this adjustment was created from is applied.
setOfferUses(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferItemDetail: The number of times the offer is applied.
setOrderItemResponses(List<ItemResponse>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: Adjustment information for each Order.getOrderLineItems() order item of the order}.
setOrderItemSavings(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The total savings from adjustments applied to order items via the sum of all ItemResponse.getSavings().
setOrderLineItems(List<OrderLineItemDto>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
setOrderLineItems(List<O>) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.Order: Items being sold in this order.
setOrderNumber(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The orderNumber corresponding to the Order that this OrderResponse represents.
setOrderNumber(String) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.Order: Number used to identify this order.
setOrderNumber(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
setOrderSavings(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The savings from adjustments applied to the order via OrderResponse.adjustments.
setOrderSubmitDate(Instant) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto: The Instant of when this order was submitted.
setParentLineNumber(String) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItem: The LineItem.getLineNumber() of this item's parent item.
setParentLineNumber(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItemDto
setPeriodFrequency(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.RecurringPriceDetail: The frequency with which the recurring RecurringPriceDetail.price should be charged., e.g., a value of 1 combined with RecurringPriceDetail.periodType of MONTH would indicate to a subscription service that the RecurringPriceDetail.price should be charged every 1 month.
setPeriodLimit(Integer) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.RecurringPriceDetail: Defines the number of periods the price should recur.
setPeriodType(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.RecurringPriceDetail: The period type for the price, e.g.
setPostalCode(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
setPotentialSavings(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.CodeResponse
setPrice(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.RecurringPriceDetail: The amount of the recurring price.
setPriceBeforeAdjustments(MonetaryAmount) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroup: The shipping price of this fulfillment group before adjustments are applied.
setPriceBeforeAdjustments(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
setPriceBeforeAdjustmentsByServiceLevel(Map<String, MonetaryAmount>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
setPrimaryPhone(String) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroup: The primary phone number for this fulfillment group.
setPrimaryPhone(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
setProductId(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.FreeGiftItem: The sku of the item to be automatically added.
setProratedAdjustments(List<ProratedOfferAdjustment>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: Prorated adjustment information for this line item.
setProratedFulfillmentAdjustments(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse: Prorated fulfillment adjustments for the fulfillment group itself.
setProratedItemAdjustments(List) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: Prorated adjustment information for this line item.
setProrationType(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: Determines how an offer's discount amount is distributed across the offer's related order item types.
setQualifierDetails(List<OfferItemDetail>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: A list of OfferItemDetails representing the qualifier items where this adjustment was from.
setQuantity(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: The total quantity across all price variations of this item.
setQuantity(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: The quantity of items that match this detail.
setQuantity(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.FreeGiftItem: The quantity of the item to be automatically added.
setQuantity(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ItemProrationDetail: The total quantity.
setQuantity(int) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustment: The quantity of merchandising items from the LineItem to which this adjustment applies.
setQuantity(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustmentDto
setQuantity(int) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustment: The quantity of merchandising items from the LineItem to which this adjustment applies.
setQuantity(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustmentDto: The quantity of merchandising items from the EnhancedLineItem to which this adjustment applies.
setQuantity(int) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem: Number of like merchandising items being sold or fulfilled together in this order.
setQuantity(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto: The quantity of the item in the order.
setQuantityPerUsage(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: The quantity per offer usage of the target item that this adjustment is for.
setQuantityPerUsage(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferItemDetail: The quantity per offer usage of the item that is a qualifier or target.
setRecipientName(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
setRecurringAdjustedTotal(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: The final recurring (a.k.a., subscription) price of this item with adjustments applied.
setRecurringAdjustedTotal(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: The final recurring (a.k.a., subscription) price of this item with adjustments applied.
setRecurringSavings(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: The savings to apply to recurring (a.k.a., subscription) prices.
setRecurringSavings(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: The savings to apply to recurring (a.k.a., subscription) prices.
setRelatedOrderLineItemNumber(String) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentLineItem: The line number of the related OrderLineItem.
setRelatedOrderLineItemNumber(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentLineItemDto
setRunOrderAndItemOffers(boolean) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.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.
setRunOrderAndItemOffers(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
setSalePrice(MonetaryAmount) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem: Special price at which to sell or fulfill a single merchandising item represented by this order line item.
setSalePrice(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto: Sale price.
setSaleRecurringPrice(RecurringPriceDetail) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem: Set the details related to a sale recurring (or subscription) price include the terms.
setSaleRecurringPrice(RecurringPriceDetail) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto
setSavings(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse: The total savings across all ItemResponse.itemResponseDetails.
setSavings(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail: The total savings across all ItemResponseDetail.itemAdjustments.
setSecondaryPhone(String) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroup: The secondary phone number for this fulfillment group.
setSecondaryPhone(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
setSegment(String) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItem: Set the segment which this item is part of.
setSegment(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItemDto
setSenderName(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
setServiceLevel(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment: The serviceLevel that this adjustment applies to (typically used only with fulfillment group offers to indicate that the discount applies to the portion of the fulfillment price related to a specific service level.
setSharedCodes(Set<String>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Codes: Code strings added to the order that may be tied to an offer's shared codes and used to apply it.
setStandardPrice(MonetaryAmount) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem: The standard price at which a single merchandising item represented by this order line item is sold or fulfilled.
setStandardPrice(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto: The one-time price typically discounted.
setStandardRecurringPrice(RecurringPriceDetail) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem: Set the details related to a recurring (or subscription) price include the terms.
setStandardRecurringPrice(RecurringPriceDetail) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto
setSubscription(boolean) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem: Whether this is a subscription item and thus qualifies it for future billing discounts.
setSubscription(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto: Whether the item represents a subscription.
setTargetsCanBeTargets(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: Deprecated.
since 1.6, in favor of offer stacking and combinability
setTermDurationLength(Integer) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.RecurringPriceDetail: The length of the terms, e.g., if this is 36 and RecurringPriceDetail.termDurationType is MONTHS, then the RecurringPriceDetail.price should be charged for 36 months.
setTermDurationType(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.RecurringPriceDetail: The term duration type, e.g.
setTimeOfRequest(Instant) - Method in interface com.broadleafcommerce.promotion.offer.client.web.context.Order: The time that the request to apply offers to this order was made.
setTimeOfRequest(Instant) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
setTotalFutureCredits(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The total future credits from adjustments applied across all areas of the order.
setTotalitarian(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef: Whether the offer is marked as totalitarian, meaning that it can be the only offer applied..
setTotalSavings(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The total savings from adjustments applied across all areas of the order.
setTrackingIds(Set<String>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Codes: Tracking ids associated with external systems like the Campaigns Service that could be tied to an offer's campaign tracking ids.
setType(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment
setType(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.LineItemRef: The type of this line item.
setUnitAmount(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ItemProrationDetail: The unit proration amount.
setupModule(Module.SetupContext) - Method in class com.broadleafcommerce.promotion.offer.client.jackson.BroadleafOfferClientModule
setUsageValid(boolean) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult: If this is set to false, one or more offers or offer codes is no longer valid and need to be removed from the list of previously applied offers.
setUsername(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext: The customer's username.
setUsesLeft(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsage: The number of uses left for this info's related shared code.
setUsesLeft(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferUsabilityInfo: The number of uses left for this info's related offer.
setUsesLeftPerCustomer(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsage: The number of uses left for the current customer for this info's related offer.
setUsesLeftPerCustomer(int) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferUsabilityInfo: The number of uses left for the current customer for this info's related offer.
setValidationFailureMessages(Map<String, String>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult: A map which holds pairings of Strings in invalidOfferRefIds and invalidOfferCodes as key values to messages as values which hold a description of why an offer is no longer valid.
setVoucherCampaignId(String) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Voucher: The id of the voucher campaign, which will be used to generate voucher codes after a successful checkout.
setVouchers(List<Voucher>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse: The Vouchers that this order is qualified for.
setVouchers(List<Voucher>) - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto: The Vouchers that this OrderDto has.

T

toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Codes
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CodeUsage
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.Destination
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.BestOfferCombination
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.CodeResponse
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.EvaluateOfferResponse
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.FulfillmentGroupResponse
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemAdjustment
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponse
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.ItemResponseDetail
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentGroupDto
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.FulfillmentLineItemDto
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.FreeGiftItem
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ItemProrationDetail
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.LineItemRef
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferItemDetail
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustmentDto
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustmentDto
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.info.Voucher
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.LineItemDto
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferAndOfferCodeUsageValidationResult
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferCodeDto
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OfferUsabilityInfo
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderDto
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.OrderLineItemDto
toString() - Method in class com.broadleafcommerce.promotion.offer.client.web.context.RecurringPriceDetail

U

UNAVAILABLE_TO_USER - Enum constant in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.CodeUsabilityType: Means that the code cannot be used by the user - e.g.
unitsPerYear() - Method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultTermDurationType
USABLE - Enum constant in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.CodeUsabilityType: The only value which means that the code can be used.

V

valueOf(String) - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.CodeUsabilityType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultAdjustmentType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultFreeTrialLengthUnits: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultRecurringPeriodType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultTermDurationType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.CodeUsabilityType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultAdjustmentType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultFreeTrialLengthUnits: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultRecurringPeriodType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultTermDurationType: Returns an array containing the constants of this enum class, in the order they are declared.
version() - Method in class com.broadleafcommerce.promotion.offer.client.jackson.BroadleafOfferClientModule
Voucher - Class in com.broadleafcommerce.promotion.offer.client.web.context.info: Represents a voucher that an order is qualified for.
Voucher() - Constructor for class com.broadleafcommerce.promotion.offer.client.web.context.info.Voucher

W

WEEKS - Enum constant in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultFreeTrialLengthUnits
WEEKS - Enum constant in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultTermDurationType

Y

YEARS - Enum constant in enum class com.broadleafcommerce.promotion.offer.client.web.context.type.DefaultTermDurationType

A B C D E F G H I L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form