Index (Broadleaf Order Common 1.5.6-GA API)

A B C D E F G H I N O P S T V
All Classes and Interfaces|All Packages|Serialized Form

A

addAdditionalAttribute(String, Object) - Method in class com.broadleafcommerce.order.common.domain.Address: Takes in any additional attributes passed in the request not matching any defined properties.
Address - Class in com.broadleafcommerce.order.common.domain: The street address for a physical location.
Address() - Constructor for class com.broadleafcommerce.order.common.domain.Address
AddressType - Interface in com.broadleafcommerce.order.common.domain.enums: The AddressType is used to represent the types addresses that can be related to a payment
Adjustment - Class in com.broadleafcommerce.order.common.domain: An adjustment to be applied to the original price of the containing entity.
Adjustment() - Constructor for class com.broadleafcommerce.order.common.domain.Adjustment
AttributeChoiceValue - Class in com.broadleafcommerce.order.common.domain: A selected option attribute choice value for a product option to be stored in a cart, cart item, order, or order item's attribute choices.
AttributeChoiceValue() - Constructor for class com.broadleafcommerce.order.common.domain.AttributeChoiceValue
AttributeChoiceValue(String, String, String) - Constructor for class com.broadleafcommerce.order.common.domain.AttributeChoiceValue

B

BILLING - Enum constant in enum com.broadleafcommerce.order.common.domain.enums.DefaultAddressTypes
BUNDLE_ITEM_ADJUSTMENT - Enum constant in enum com.broadleafcommerce.order.common.domain.enums.DefaultAlternateAdjustmentSource: This value indicates that the adjustment was added by the price proration of the bundle price to its items.

C

CampaignRef - Class in com.broadleafcommerce.order.common.domain: A reference to a campaign and code.
CampaignRef() - Constructor for class com.broadleafcommerce.order.common.domain.CampaignRef
canEqual(Object) - Method in class com.broadleafcommerce.order.common.domain.Address
canEqual(Object) - Method in class com.broadleafcommerce.order.common.domain.Adjustment
canEqual(Object) - Method in class com.broadleafcommerce.order.common.domain.AttributeChoiceValue
canEqual(Object) - Method in class com.broadleafcommerce.order.common.domain.CampaignRef
canEqual(Object) - Method in class com.broadleafcommerce.order.common.domain.CustomerRef
canEqual(Object) - Method in class com.broadleafcommerce.order.common.domain.FulfillmentOption
canEqual(Object) - Method in class com.broadleafcommerce.order.common.domain.ItemProrationDetail
canEqual(Object) - Method in class com.broadleafcommerce.order.common.domain.OfferItemDetail
canEqual(Object) - Method in class com.broadleafcommerce.order.common.domain.OfferRef
canEqual(Object) - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail
canEqual(Object) - Method in class com.broadleafcommerce.order.common.domain.Phone
canEqual(Object) - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption
canEqual(Object) - Method in class com.broadleafcommerce.order.common.domain.ProratedOfferAdjustment
canEqual(Object) - Method in class com.broadleafcommerce.order.common.domain.Voucher
CART_ITEM_PRICE_OVERRIDE - Enum constant in enum com.broadleafcommerce.order.common.domain.enums.DefaultOverrideTypes: Used when a CSR has overridden the unit price on a particular cart item.
com.broadleafcommerce.order.common.domain - package com.broadleafcommerce.order.common.domain
com.broadleafcommerce.order.common.domain.enums - package com.broadleafcommerce.order.common.domain.enums
CustomerRef - Class in com.broadleafcommerce.order.common.domain: A reference to a customer.
CustomerRef() - Constructor for class com.broadleafcommerce.order.common.domain.CustomerRef

D

DefaultAddressTypes - Enum in com.broadleafcommerce.order.common.domain.enums
DefaultAlternateAdjustmentSource - Enum in com.broadleafcommerce.order.common.domain.enums: The default alternate adjustment source names.
DefaultOfferProrationType - Enum in com.broadleafcommerce.order.common.domain.enums: Enumerates the default types of offer discount proration.
DefaultOverrideTypes - Enum in com.broadleafcommerce.order.common.domain.enums: Enumerates the default types of overrides that can be performed by a CSR on a cart.

E

equals(Object) - Method in class com.broadleafcommerce.order.common.domain.Address
equals(Object) - Method in class com.broadleafcommerce.order.common.domain.Adjustment
equals(Object) - Method in class com.broadleafcommerce.order.common.domain.AttributeChoiceValue
equals(Object) - Method in class com.broadleafcommerce.order.common.domain.CampaignRef
equals(Object) - Method in class com.broadleafcommerce.order.common.domain.CustomerRef
equals(Object) - Method in class com.broadleafcommerce.order.common.domain.FulfillmentOption
equals(Object) - Method in class com.broadleafcommerce.order.common.domain.ItemProrationDetail
equals(Object) - Method in class com.broadleafcommerce.order.common.domain.OfferItemDetail
equals(Object) - Method in class com.broadleafcommerce.order.common.domain.OfferRef
equals(Object) - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail
equals(Object) - Method in class com.broadleafcommerce.order.common.domain.Phone
equals(Object) - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption
equals(Object) - Method in class com.broadleafcommerce.order.common.domain.ProratedOfferAdjustment
equals(Object) - Method in class com.broadleafcommerce.order.common.domain.Voucher

F

FULFILLMENT_PRICE_OVERRIDE - Enum constant in enum com.broadleafcommerce.order.common.domain.enums.DefaultOverrideTypes: Used when a CSR has overridden the total fulfillment price on a particular fulfillment group.
FulfillmentOption - Class in com.broadleafcommerce.order.common.domain: A fulfillment option is used to hold information about a particular type of fulfillment implementation.
FulfillmentOption() - Constructor for class com.broadleafcommerce.order.common.domain.FulfillmentOption
FulfillmentType - Enum in com.broadleafcommerce.order.common.domain.enums: Provides a set of default fulfillment types for a fulfillment group.

G

getAccountHierarchy() - Method in class com.broadleafcommerce.order.common.domain.CustomerRef: The hierarchy of accounts, from the root account to the account member's account.
getAccountId() - Method in class com.broadleafcommerce.order.common.domain.CustomerRef: The ID of the account the customer belongs to.
getAdditionalAttributes() - Method in class com.broadleafcommerce.order.common.domain.Address: Return any additional attributes passed in the request not matching any defined properties.
getAdditionalAttributes() - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption: Map to hold arbitrary additional attributes.
getAddressLine1() - Method in class com.broadleafcommerce.order.common.domain.Address: Primary address information, typically street name and building number.
getAddressLine2() - Method in class com.broadleafcommerce.order.common.domain.Address: Secondary address information, like apartment, suite, or unit number.
getAddressLine3() - Method in class com.broadleafcommerce.order.common.domain.Address: Tertiary address information, typically for international addresses.
getAlternateAdjustmentSource() - Method in class com.broadleafcommerce.order.common.domain.Adjustment: If this adjustment is not created by an offer this parameter will specify the source of adjustment.
getAmount() - Method in class com.broadleafcommerce.order.common.domain.Adjustment: The amount of this adjustment.
getAmount() - Method in class com.broadleafcommerce.order.common.domain.ProratedOfferAdjustment: The amount of the prorated adjustment for the item.
getAttributes() - Method in class com.broadleafcommerce.order.common.domain.OfferRef: Dynamic attributes that are a part of the offer.
getAttributes() - Method in class com.broadleafcommerce.order.common.domain.Voucher: Map holding any additional attributes that do not match any defined properties.
getAuthor() - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail: The admin user who performed the override.
getCalculatorIds() - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption: The list of calculatorIds which were used to compute the price for this option.
getCampaignCode() - Method in class com.broadleafcommerce.order.common.domain.CampaignRef: The user provided text code that refers to the campaign.
getCampaignTrackingId() - Method in class com.broadleafcommerce.order.common.domain.Adjustment: The campaign tracking id (if any) for this adjustment.
getCampaignTrackingId() - Method in class com.broadleafcommerce.order.common.domain.CampaignRef: A text identifier used to track a specific campaign.
getCartLabel() - Method in class com.broadleafcommerce.order.common.domain.OfferRef: A label for this offer typically used by the storefront.
getCity() - Method in class com.broadleafcommerce.order.common.domain.Address: The city, town or village of this address.
getCodeUsed() - Method in class com.broadleafcommerce.order.common.domain.Adjustment: The code used (if any) that triggered the application of the offer for this adjustment.
getComment() - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail: The optional, long-form comment explaining any extra context for the override.
getCompanyName() - Method in class com.broadleafcommerce.order.common.domain.Address: The name of the company at this address.
getCompletedName() - Method in class com.broadleafcommerce.order.common.domain.Address: Returns the completed name : Either the Address.fullName if present or the concatenation of the Address.firstName and Address.lastName.
getCountry() - Method in class com.broadleafcommerce.order.common.domain.Address: The country for this address.
getCountryCode() - Method in class com.broadleafcommerce.order.common.domain.Phone: The country calling code that acts as a prefix to the main telephone number.
getCounty() - Method in class com.broadleafcommerce.order.common.domain.Address: The county of this address.
getCustomerId() - Method in class com.broadleafcommerce.order.common.domain.CustomerRef: The customer's id.
getDescription() - Method in class com.broadleafcommerce.order.common.domain.FulfillmentOption: The description of this option.
getDescription() - Method in class com.broadleafcommerce.order.common.domain.OfferRef: A description of what benefits the offer provides to a customer.
getDescription() - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption
getEmailAddress() - Method in class com.broadleafcommerce.order.common.domain.Address: The email address of the individual at this physical address.
getErrorMessage() - Method in class com.broadleafcommerce.order.common.domain.Voucher: The error message from voucher code generation for this voucher.
getEstimatedMaxDaysToFulfill() - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption: The maximum number of days expected for delivery.
getEstimatedMinDaysToFulfill() - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption: The minimum number of days estimated for delivery.
getExtension() - Method in class com.broadleafcommerce.order.common.domain.Phone: The internal extension for this phone.
getFirstName() - Method in class com.broadleafcommerce.order.common.domain.Address: The first name of the individual at this address.
getFulfillmentReference() - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption: This is the "reference number" of the FulfillmentGroup or FulfillmentItem that this fulfillment price applies to.
getFulfillmentType() - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption: Broad categorization of how this fulfillment option is fulfilled.
getFullName() - Method in class com.broadleafcommerce.order.common.domain.Address: The combined names of the individual at this address.
getFullName() - Method in class com.broadleafcommerce.order.common.domain.CustomerRef: The customer's full name, if available.
getGeneratedCampaignCode() - Method in class com.broadleafcommerce.order.common.domain.Voucher: The generated campaign code for this voucher.
getId() - Method in class com.broadleafcommerce.order.common.domain.OfferRef: The ID of the offer.
getItemAdjustmentQuantity() - Method in class com.broadleafcommerce.order.common.domain.Adjustment: The quantity of the current line item that this offer was applied to.
getItemAdjustmentQuantity() - Method in class com.broadleafcommerce.order.common.domain.OfferItemDetail: The quantity of the qualifier or target item that this offer was applied to.
getItemId() - Method in class com.broadleafcommerce.order.common.domain.OfferItemDetail: The id of the item that is a qualifier or target.
getItemProrationDetails() - Method in class com.broadleafcommerce.order.common.domain.ProratedOfferAdjustment: The details about how this prorated adjustment on a per-quantity basis.
getLabel() - Method in class com.broadleafcommerce.order.common.domain.AttributeChoiceValue: What the customer sees for display.
getLastName() - Method in class com.broadleafcommerce.order.common.domain.Address: The last name of the individual at this address.
getName() - Method in class com.broadleafcommerce.order.common.domain.FulfillmentOption: The name of this option.
getName() - Method in class com.broadleafcommerce.order.common.domain.OfferRef: The name of the offer.
getOfferCodeRef() - Method in class com.broadleafcommerce.order.common.domain.Adjustment: A reference to the OfferCode (if any).
getOfferId() - Method in class com.broadleafcommerce.order.common.domain.OfferItemDetail: The offer id where this item is a qualifier or target of.
getOfferId() - Method in class com.broadleafcommerce.order.common.domain.Voucher: The OfferRef.getId() of the voucher offer.
getOfferRef() - Method in class com.broadleafcommerce.order.common.domain.Adjustment: A reference to the offer that originated this adjustment.
getOfferRef() - Method in class com.broadleafcommerce.order.common.domain.ProratedOfferAdjustment: The OfferRef for the offer where this prorated adjustment is from.
getOfferUses() - Method in class com.broadleafcommerce.order.common.domain.Adjustment: The number of times that the offer this adjustment was created from is applied.
getOfferUses() - Method in class com.broadleafcommerce.order.common.domain.OfferItemDetail: The number of times the offer is applied.
getOptionLabel() - Method in class com.broadleafcommerce.order.common.domain.AttributeChoiceValue: The label shown to customers for the option.
getOriginalAmount() - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail: The amount contained in the field prior to being overridden.
getOverrideAmount() - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail: The amount which the field has been overridden to.
getPhoneFax() - Method in class com.broadleafcommerce.order.common.domain.Address: The fax number for this address.
getPhoneNumber() - Method in class com.broadleafcommerce.order.common.domain.Phone: The telephone number, including the area code.
getPhonePrimary() - Method in class com.broadleafcommerce.order.common.domain.Address: The primary phone number for this address.
getPhoneSecondary() - Method in class com.broadleafcommerce.order.common.domain.Address: The secondary phone number for this address.
getPostalCode() - Method in class com.broadleafcommerce.order.common.domain.Address: Postal code or ZIP code for this address.
getPrice() - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption: The fulfillment price of this fulfillment option.
getProrationType() - Method in class com.broadleafcommerce.order.common.domain.OfferRef: Determines how an offer's discount amount is distributed across the offer's related order item types.
getQualifierDetails() - Method in class com.broadleafcommerce.order.common.domain.Adjustment: A list of OfferItemDetails representing the qualifier items where this adjustment was from.
getQuantity() - Method in class com.broadleafcommerce.order.common.domain.ItemProrationDetail: The total quantity.
getQuantityPerUsage() - Method in class com.broadleafcommerce.order.common.domain.Adjustment: The quantity per offer usage of the target item that this adjustment is for.
getQuantityPerUsage() - Method in class com.broadleafcommerce.order.common.domain.OfferItemDetail: The quantity per offer usage of the item that is a qualifier or target.
getReason() - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail: The reason the override was performed, for example, "Price Match".
getRootAccountId() - Method in class com.broadleafcommerce.order.common.domain.CustomerRef: The ID of the root account the account member belongs to.
getServiceLevel() - Method in class com.broadleafcommerce.order.common.domain.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 class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption: Specific description for how this fulfillment option is fulfilled.
getStateProvinceRegion() - Method in class com.broadleafcommerce.order.common.domain.Address: The state, province or region of this address.
getTaxCode() - Method in class com.broadleafcommerce.order.common.domain.FulfillmentOption: The tax code for this option.
getTaxCode() - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption: A tax code for this fulfillment option.
getType() - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail: The type of override performed, e.g.
getUnitAmount() - Method in class com.broadleafcommerce.order.common.domain.ItemProrationDetail: The unit proration amount.
getUserId() - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail: The user ID of the admin user who performed the override.
getUsername() - Method in class com.broadleafcommerce.order.common.domain.CustomerRef: The customer's username.
getValue() - Method in class com.broadleafcommerce.order.common.domain.AttributeChoiceValue: The value based on what the user selected.
getVoucherCampaignId() - Method in class com.broadleafcommerce.order.common.domain.Voucher: The id of the voucher campaign, which will be used for voucher code generation later on.

H

hashCode() - Method in class com.broadleafcommerce.order.common.domain.Address
hashCode() - Method in class com.broadleafcommerce.order.common.domain.Adjustment
hashCode() - Method in class com.broadleafcommerce.order.common.domain.AttributeChoiceValue
hashCode() - Method in class com.broadleafcommerce.order.common.domain.CampaignRef
hashCode() - Method in class com.broadleafcommerce.order.common.domain.CustomerRef
hashCode() - Method in class com.broadleafcommerce.order.common.domain.FulfillmentOption
hashCode() - Method in class com.broadleafcommerce.order.common.domain.ItemProrationDetail
hashCode() - Method in class com.broadleafcommerce.order.common.domain.OfferItemDetail
hashCode() - Method in class com.broadleafcommerce.order.common.domain.OfferRef
hashCode() - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail
hashCode() - Method in class com.broadleafcommerce.order.common.domain.Phone
hashCode() - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption
hashCode() - Method in class com.broadleafcommerce.order.common.domain.ProratedOfferAdjustment
hashCode() - Method in class com.broadleafcommerce.order.common.domain.Voucher

I

isActive() - Method in class com.broadleafcommerce.order.common.domain.Address: Whether this address is an active address of the owner.
isBillingAddress(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultAddressTypes
isDefault() - Method in class com.broadleafcommerce.order.common.domain.Address: Whether this address is the default address of the owner.
isFulfillmentItemDetail() - Method in class com.broadleafcommerce.order.common.domain.OfferItemDetail: Indicates if this detail is for a fulfillment item.
isGenerationSuccessful() - Method in class com.broadleafcommerce.order.common.domain.Voucher: Indicates whether the post-checkout voucher code generation was successful.
isRegistered() - Method in class com.broadleafcommerce.order.common.domain.CustomerRef: Defines whether or not the customer is registered.
isShippingAddress(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultAddressTypes
isTargetAndQualifierProration(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultOfferProrationType
isTargetOnlyProration(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultOfferProrationType
isTaxable() - Method in class com.broadleafcommerce.order.common.domain.FulfillmentOption: Whether any shipping prices should be taxable for this option.
isTaxable() - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption: Indicate if this fulfillment price is taxable.
isUseFlatRates() - Method in class com.broadleafcommerce.order.common.domain.FulfillmentOption: Whether to use flat rates for this option.
isValidationSuccessful() - Method in class com.broadleafcommerce.order.common.domain.Voucher: Indicates whether the post-checkout voucher validation was successful.
ItemProrationDetail - Class in com.broadleafcommerce.order.common.domain: Represents the detail for an order-level adjustment for an item on a per-quantity basis.
ItemProrationDetail() - Constructor for class com.broadleafcommerce.order.common.domain.ItemProrationDetail

N

name() - Method in interface com.broadleafcommerce.order.common.domain.enums.AddressType
NONE - Enum constant in enum com.broadleafcommerce.order.common.domain.enums.FulfillmentType: Indicate that no fulfillment is required.

O

OfferItemDetail - Class in com.broadleafcommerce.order.common.domain: A DTO structure that provides offer qualifier or target information for a given item.
OfferItemDetail() - Constructor for class com.broadleafcommerce.order.common.domain.OfferItemDetail
OfferRef - Class in com.broadleafcommerce.order.common.domain: A reference to some external offer.
OfferRef() - Constructor for class com.broadleafcommerce.order.common.domain.OfferRef
OverrideDetail - Class in com.broadleafcommerce.order.common.domain: Audit information for a CSR override which was performed.
OverrideDetail() - Constructor for class com.broadleafcommerce.order.common.domain.OverrideDetail

P

Phone - Class in com.broadleafcommerce.order.common.domain
Phone() - Constructor for class com.broadleafcommerce.order.common.domain.Phone
PICKUP - Enum constant in enum com.broadleafcommerce.order.common.domain.enums.FulfillmentType: The fulfillment group contains goods that need to be picked up at a store or other location in order to be fulfilled.
PricedFulfillmentOption - Class in com.broadleafcommerce.order.common.domain: Represents specific fulfillment price data for a particular FulfillmentGroup or FulfillmentItem, including the fulfillment service level and price.
PricedFulfillmentOption() - Constructor for class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption
ProratedOfferAdjustment - Class in com.broadleafcommerce.order.common.domain: DTO containing prorated price adjustment information for a EnhancedLineItem caused by an order-level or fulfillment group-level offer.
ProratedOfferAdjustment() - Constructor for class com.broadleafcommerce.order.common.domain.ProratedOfferAdjustment

S

SAME_DAY_DELIVERY - Enum constant in enum com.broadleafcommerce.order.common.domain.enums.FulfillmentType: The fulfillment group contains goods that need to be delivered to the destination on the same day that the order is placed.
setAccountHierarchy(List<String>) - Method in class com.broadleafcommerce.order.common.domain.CustomerRef: The hierarchy of accounts, from the root account to the account member's account.
setAccountId(String) - Method in class com.broadleafcommerce.order.common.domain.CustomerRef: The ID of the account the customer belongs to.
setActive(boolean) - Method in class com.broadleafcommerce.order.common.domain.Address: Whether this address is an active address of the owner.
setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.order.common.domain.Address: Map holding any additional attributes passed in the request not matching any defined properties.
setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption: Map to hold arbitrary additional attributes.
setAddressLine1(String) - Method in class com.broadleafcommerce.order.common.domain.Address: Primary address information, typically street name and building number.
setAddressLine2(String) - Method in class com.broadleafcommerce.order.common.domain.Address: Secondary address information, like apartment, suite, or unit number.
setAddressLine3(String) - Method in class com.broadleafcommerce.order.common.domain.Address: Tertiary address information, typically for international addresses.
setAlternateAdjustmentSource(String) - Method in class com.broadleafcommerce.order.common.domain.Adjustment: If this adjustment is not created by an offer this parameter will specify the source of adjustment.
setAmount(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.Adjustment: The amount of this adjustment.
setAmount(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.ProratedOfferAdjustment: The amount of the prorated adjustment for the item.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.order.common.domain.OfferRef: Dynamic attributes that are a part of the offer.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.order.common.domain.Voucher: Map holding any additional attributes that do not match any defined properties.
setAuthor(String) - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail: The admin user who performed the override.
setCalculatorIds(Set<String>) - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption: The list of calculatorIds which were used to compute the price for this option.
setCampaignCode(String) - Method in class com.broadleafcommerce.order.common.domain.CampaignRef: The user provided text code that refers to the campaign.
setCampaignTrackingId(String) - Method in class com.broadleafcommerce.order.common.domain.Adjustment: The campaign tracking id (if any) for this adjustment.
setCampaignTrackingId(String) - Method in class com.broadleafcommerce.order.common.domain.CampaignRef: A text identifier used to track a specific campaign.
setCartLabel(String) - Method in class com.broadleafcommerce.order.common.domain.OfferRef: A label for this offer typically used by the storefront.
setCity(String) - Method in class com.broadleafcommerce.order.common.domain.Address: The city, town or village of this address.
setCodeUsed(String) - Method in class com.broadleafcommerce.order.common.domain.Adjustment: The code used (if any) that triggered the application of the offer for this adjustment.
setComment(String) - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail: The optional, long-form comment explaining any extra context for the override.
setCompanyName(String) - Method in class com.broadleafcommerce.order.common.domain.Address: The name of the company at this address.
setCountry(String) - Method in class com.broadleafcommerce.order.common.domain.Address: The country for this address.
setCountryCode(String) - Method in class com.broadleafcommerce.order.common.domain.Phone: The country calling code that acts as a prefix to the main telephone number.
setCounty(String) - Method in class com.broadleafcommerce.order.common.domain.Address: The county of this address.
setCustomerId(String) - Method in class com.broadleafcommerce.order.common.domain.CustomerRef: The customer's id.
setDefault(boolean) - Method in class com.broadleafcommerce.order.common.domain.Address: Whether this address is the default address of the owner.
setDescription(String) - Method in class com.broadleafcommerce.order.common.domain.FulfillmentOption: The description of this option.
setDescription(String) - Method in class com.broadleafcommerce.order.common.domain.OfferRef: A description of what benefits the offer provides to a customer.
setDescription(String) - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption: Human-readable description (e.g.
setEmailAddress(String) - Method in class com.broadleafcommerce.order.common.domain.Address: The email address of the individual at this physical address.
setErrorMessage(String) - Method in class com.broadleafcommerce.order.common.domain.Voucher: The error message from voucher code generation for this voucher.
setEstimatedMaxDaysToFulfill(Integer) - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption: The maximum number of days expected for delivery.
setEstimatedMinDaysToFulfill(Integer) - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption: The minimum number of days estimated for delivery.
setExtension(String) - Method in class com.broadleafcommerce.order.common.domain.Phone: The internal extension for this phone.
setFirstName(String) - Method in class com.broadleafcommerce.order.common.domain.Address: The first name of the individual at this address.
setFulfillmentItemDetail(boolean) - Method in class com.broadleafcommerce.order.common.domain.OfferItemDetail: Indicates if this detail is for a fulfillment item.
setFulfillmentReference(String) - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption: This is the "reference number" of the FulfillmentGroup or FulfillmentItem that this fulfillment price applies to.
setFulfillmentType(String) - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption: Broad categorization of how this fulfillment option is fulfilled.
setFullName(String) - Method in class com.broadleafcommerce.order.common.domain.Address: The combined names of the individual at this address.
setFullName(String) - Method in class com.broadleafcommerce.order.common.domain.CustomerRef: The customer's full name, if available.
setGeneratedCampaignCode(String) - Method in class com.broadleafcommerce.order.common.domain.Voucher: The generated campaign code for this voucher.
setGenerationSuccessful(boolean) - Method in class com.broadleafcommerce.order.common.domain.Voucher: Indicates whether the post-checkout voucher code generation was successful.
setId(String) - Method in class com.broadleafcommerce.order.common.domain.OfferRef: The ID of the offer.
setItemAdjustmentQuantity(int) - Method in class com.broadleafcommerce.order.common.domain.Adjustment: The quantity of the current line item that this offer was applied to.
setItemAdjustmentQuantity(int) - Method in class com.broadleafcommerce.order.common.domain.OfferItemDetail: The quantity of the qualifier or target item that this offer was applied to.
setItemId(String) - Method in class com.broadleafcommerce.order.common.domain.OfferItemDetail: The id of the item that is a qualifier or target.
setItemProrationDetails(List<ItemProrationDetail>) - Method in class com.broadleafcommerce.order.common.domain.ProratedOfferAdjustment: The details about how this prorated adjustment on a per-quantity basis.
setLabel(String) - Method in class com.broadleafcommerce.order.common.domain.AttributeChoiceValue: What the customer sees for display.
setLastName(String) - Method in class com.broadleafcommerce.order.common.domain.Address: The last name of the individual at this address.
setName(String) - Method in class com.broadleafcommerce.order.common.domain.FulfillmentOption: The name of this option.
setName(String) - Method in class com.broadleafcommerce.order.common.domain.OfferRef: The name of the offer.
setOfferCodeRef(String) - Method in class com.broadleafcommerce.order.common.domain.Adjustment: A reference to the OfferCode (if any).
setOfferId(String) - Method in class com.broadleafcommerce.order.common.domain.OfferItemDetail: The offer id where this item is a qualifier or target of.
setOfferId(String) - Method in class com.broadleafcommerce.order.common.domain.Voucher: The OfferRef.getId() of the voucher offer.
setOfferRef(OfferRef) - Method in class com.broadleafcommerce.order.common.domain.Adjustment: A reference to the offer that originated this adjustment.
setOfferRef(OfferRef) - Method in class com.broadleafcommerce.order.common.domain.ProratedOfferAdjustment: The OfferRef for the offer where this prorated adjustment is from.
setOfferUses(int) - Method in class com.broadleafcommerce.order.common.domain.Adjustment: The number of times that the offer this adjustment was created from is applied.
setOfferUses(int) - Method in class com.broadleafcommerce.order.common.domain.OfferItemDetail: The number of times the offer is applied.
setOptionLabel(String) - Method in class com.broadleafcommerce.order.common.domain.AttributeChoiceValue: The label shown to customers for the option.
setOriginalAmount(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail: The amount contained in the field prior to being overridden.
setOverrideAmount(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail: The amount which the field has been overridden to.
setPhoneFax(Phone) - Method in class com.broadleafcommerce.order.common.domain.Address: The fax number for this address.
setPhoneNumber(String) - Method in class com.broadleafcommerce.order.common.domain.Phone: The telephone number, including the area code.
setPhonePrimary(Phone) - Method in class com.broadleafcommerce.order.common.domain.Address: The primary phone number for this address.
setPhoneSecondary(Phone) - Method in class com.broadleafcommerce.order.common.domain.Address: The secondary phone number for this address.
setPostalCode(String) - Method in class com.broadleafcommerce.order.common.domain.Address: Postal code or ZIP code for this address.
setPrice(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption: The fulfillment price of this fulfillment option.
setProrationType(String) - Method in class com.broadleafcommerce.order.common.domain.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.order.common.domain.Adjustment: A list of OfferItemDetails representing the qualifier items where this adjustment was from.
setQuantity(int) - Method in class com.broadleafcommerce.order.common.domain.ItemProrationDetail: The total quantity.
setQuantityPerUsage(int) - Method in class com.broadleafcommerce.order.common.domain.Adjustment: The quantity per offer usage of the target item that this adjustment is for.
setQuantityPerUsage(int) - Method in class com.broadleafcommerce.order.common.domain.OfferItemDetail: The quantity per offer usage of the item that is a qualifier or target.
setReason(String) - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail: The reason the override was performed, for example, "Price Match".
setRegistered(boolean) - Method in class com.broadleafcommerce.order.common.domain.CustomerRef: Defines whether or not the customer is registered.
setRootAccountId(String) - Method in class com.broadleafcommerce.order.common.domain.CustomerRef: The ID of the root account the account member belongs to.
setServiceLevel(String) - Method in class com.broadleafcommerce.order.common.domain.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.
setServiceLevel(String) - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption: Specific description for how this fulfillment option is fulfilled.
setStateProvinceRegion(String) - Method in class com.broadleafcommerce.order.common.domain.Address: The state, province or region of this address.
setTaxable(boolean) - Method in class com.broadleafcommerce.order.common.domain.FulfillmentOption: Whether any shipping prices should be taxable for this option.
setTaxable(boolean) - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption: Indicate if this fulfillment price is taxable.
setTaxCode(String) - Method in class com.broadleafcommerce.order.common.domain.FulfillmentOption: The tax code for this option.
setTaxCode(String) - Method in class com.broadleafcommerce.order.common.domain.PricedFulfillmentOption: A tax code for this fulfillment option.
setType(String) - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail: The type of override performed, e.g.
setUnitAmount(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.ItemProrationDetail: The unit proration amount.
setUseFlatRates(boolean) - Method in class com.broadleafcommerce.order.common.domain.FulfillmentOption: Whether to use flat rates for this option.
setUserId(String) - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail: The user ID of the admin user who performed the override.
setUsername(String) - Method in class com.broadleafcommerce.order.common.domain.CustomerRef: The customer's username.
setValidationSuccessful(boolean) - Method in class com.broadleafcommerce.order.common.domain.Voucher: Indicates whether the post-checkout voucher validation was successful.
setValue(String) - Method in class com.broadleafcommerce.order.common.domain.AttributeChoiceValue: The value based on what the user selected.
setVoucherCampaignId(String) - Method in class com.broadleafcommerce.order.common.domain.Voucher: The id of the voucher campaign, which will be used for voucher code generation later on.
SHIP - Enum constant in enum com.broadleafcommerce.order.common.domain.enums.FulfillmentType: The fulfillment group contains goods that need to be physically shipped in order to be fulfilled.
SHIPPING - Enum constant in enum com.broadleafcommerce.order.common.domain.enums.DefaultAddressTypes

T

TARGET_AND_QUALIFIER - Enum constant in enum com.broadleafcommerce.order.common.domain.enums.DefaultOfferProrationType: The discount for an offer is distributed across targeted and qualifying items.
TARGET_ONLY - Enum constant in enum com.broadleafcommerce.order.common.domain.enums.DefaultOfferProrationType: The discount is only prorated/distributed to the targeted items of the offer.
toString() - Method in class com.broadleafcommerce.order.common.domain.Address
toString() - Method in class com.broadleafcommerce.order.common.domain.Adjustment
toString() - Method in class com.broadleafcommerce.order.common.domain.AttributeChoiceValue
toString() - Method in class com.broadleafcommerce.order.common.domain.CampaignRef
toString() - Method in class com.broadleafcommerce.order.common.domain.CustomerRef
toString() - Method in class com.broadleafcommerce.order.common.domain.FulfillmentOption
toString() - Method in class com.broadleafcommerce.order.common.domain.ItemProrationDetail
toString() - Method in class com.broadleafcommerce.order.common.domain.OfferItemDetail
toString() - Method in class com.broadleafcommerce.order.common.domain.OfferRef
toString() - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail
toString() - Method in class com.broadleafcommerce.order.common.domain.Phone
toString() - Method in class com.broadleafcommerce.order.common.domain.ProratedOfferAdjustment
toString() - Method in class com.broadleafcommerce.order.common.domain.Voucher

V

valueOf(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultAddressTypes: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultAlternateAdjustmentSource: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultOfferProrationType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultOverrideTypes: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.FulfillmentType: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultAddressTypes: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultAlternateAdjustmentSource: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultOfferProrationType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultOverrideTypes: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.broadleafcommerce.order.common.domain.enums.FulfillmentType: Returns an array containing the constants of this enum type, in the order they are declared.
VIRTUAL - Enum constant in enum com.broadleafcommerce.order.common.domain.enums.FulfillmentType: The fulfillment group contains goods that are to be virtually fulfilled.
Voucher - Class in com.broadleafcommerce.order.common.domain: Represents a voucher for a Cart or an Order containing a voucher code to use for a future purchase.
Voucher() - Constructor for class com.broadleafcommerce.order.common.domain.Voucher

A B C D E F G H I N O P S T V
All Classes and Interfaces|All Packages|Serialized Form