Index (Broadleaf Fulfillment Common 2.0.1-GA API)

A C D E F G H I O S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

Address - Class in com.broadleafcommerce.fulfillment.common.domain: Represent an address, partial address, or location for the purposes of determining fulfillment options, prices, and delivery estimates.
Address() - Constructor for class com.broadleafcommerce.fulfillment.common.domain.Address

C

canEqual(Object) - Method in class com.broadleafcommerce.fulfillment.common.domain.Distance
canEqual(Object) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOriginInfo
canEqual(Object) - Method in class com.broadleafcommerce.fulfillment.common.domain.Weight
com.broadleafcommerce.fulfillment.common.domain - package com.broadleafcommerce.fulfillment.common.domain
com.broadleafcommerce.fulfillment.common.domain.type - package com.broadleafcommerce.fulfillment.common.domain.type

D

Dimensions - Class in com.broadleafcommerce.fulfillment.common.domain: Represents 3 spatial dimensions - length, width, depth.
Dimensions() - Constructor for class com.broadleafcommerce.fulfillment.common.domain.Dimensions
Dimensions(BigDecimal, BigDecimal, BigDecimal, String) - Constructor for class com.broadleafcommerce.fulfillment.common.domain.Dimensions
Distance - Class in com.broadleafcommerce.fulfillment.common.domain: Represents a distance with a value and unit of measure.
Distance() - Constructor for class com.broadleafcommerce.fulfillment.common.domain.Distance
Distance(BigDecimal, String) - Constructor for class com.broadleafcommerce.fulfillment.common.domain.Distance

E

equals(Object) - Method in class com.broadleafcommerce.fulfillment.common.domain.Distance
equals(Object) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOriginInfo
equals(Object) - Method in class com.broadleafcommerce.fulfillment.common.domain.Weight

F

FulfillmentOptionRequest - Class in com.broadleafcommerce.fulfillment.common.domain: Contains cart data needed by FulfillmentServices to produce fulfillment options.
FulfillmentOptionRequest() - Constructor for class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOptionRequest
FulfillmentOptionResponse - Class in com.broadleafcommerce.fulfillment.common.domain
FulfillmentOptionResponse() - Constructor for class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOptionResponse
FulfillmentOriginInfo - Class in com.broadleafcommerce.fulfillment.common.domain: Indicates fulfillment origin information such as inventory location for a FulfillmentPricingItem.
FulfillmentOriginInfo() - Constructor for class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOriginInfo
FulfillmentPricingConfig - Class in com.broadleafcommerce.fulfillment.common.domain: Container for fulfillment pricing configuration properties.
FulfillmentPricingConfig() - Constructor for class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingConfig
FulfillmentPricingGroup - Class in com.broadleafcommerce.fulfillment.common.domain: This is synonymous with a Cart's Fulfillment Group but with only those details that are important for fulfillment pricing.
FulfillmentPricingGroup() - Constructor for class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingGroup
FulfillmentPricingItem - Class in com.broadleafcommerce.fulfillment.common.domain: DTO for fields that are used for getting fulfillment prices for FulfillmentItems.
FulfillmentPricingItem() - Constructor for class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem
FulfillmentPricingStrategy - Enum Class in com.broadleafcommerce.fulfillment.common.domain.type: Enumeration to indicate whether we should provide options and prices for the Fulfillment Group or for each Fulfillment Item.

G

getAdditionalAttributes() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOptionRequest: Map to hold arbitrary additional attributes.
getAdditionalAttributes() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOriginInfo: Map to hold arbitrary additional attributes.
getAddress() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingGroup: The fulfillment address.
getAddress1() - Method in class com.broadleafcommerce.fulfillment.common.domain.Address: Street address line 1.
getAddress2() - Method in class com.broadleafcommerce.fulfillment.common.domain.Address: Street address line 2.
getAddress3() - Method in class com.broadleafcommerce.fulfillment.common.domain.Address: Street address line 3.
getCartSubtotal() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOptionRequest: This is an optional field.
getCity() - Method in class com.broadleafcommerce.fulfillment.common.domain.Address: The name of a city in which this address or partial address is located.
getCountry() - Method in class com.broadleafcommerce.fulfillment.common.domain.Address: Country code.
getDefaultServiceLevel() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingConfig: The default service level to use if an item or group has not set the level.
getDepth() - Method in class com.broadleafcommerce.fulfillment.common.domain.Dimensions: Sets the depth of the item (1 of 3 dimensions).
getDimensions() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: Dimensions per unit.
getFlatRates() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: A List of Flat Rates to consider when pricing Fulfillment Options.
getFulfillmentOriginInfos() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: Used to allow targeting of fulfillment pricing based on a location where the application expects the item to be shipped from.
getFulfillmentPriceGroups() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOptionRequest: List of FulfillmentPricingGroup containing data from each FulfillmentGroup pertinent to fulfillment pricing.
getFulfillmentPricingStrategy() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingConfig: Strategy that defines whether PricedFulfillmentOption should target FulfillmentGroups or FulfillmentItems.
getFulfillmentType() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingGroup: The fulfillment type of this group.
getFulfillmentType() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: The fulfillment type for this item if it has been assigned a PricedFulfillmentOption.
getGroupFulfillmentOptions() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOptionResponse: Map of PricedFulfillmentOptions for the FulfillmentGroups.
getGroupSubtotal() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingGroup: Optional merchandise subtotal of the Fulfillment Group.
getId() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingConfig: ID associated with this config.
getId() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingGroup: The reference number of the FulfillmentGroup that this group represents.
getInventoryLocationRef() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOriginInfo: The inventory location where this product will be fulfilled from.
getInventoryType() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: The inventory type of this item.
getItemFulfillmentOptions() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOptionResponse: Map of PricedFulfillmentOptions for the FulfillmentItems.
getItemReference() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: This is the reference number of the Fulfillment Item.
getItems() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingGroup: List of items in this group that need to be fulfilled.
getLatitude() - Method in class com.broadleafcommerce.fulfillment.common.domain.Address: Latitude for GPS coordinates.
getLength() - Method in class com.broadleafcommerce.fulfillment.common.domain.Dimensions: The length of the item (1 of 3 dimensions).
getLongitude() - Method in class com.broadleafcommerce.fulfillment.common.domain.Address: Longitude for GPS coordinates.
getPostalCode() - Method in class com.broadleafcommerce.fulfillment.common.domain.Address: Postal code (or ZIP code in the US) in which this address or partial address is located.
getQuantity() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: Quantity or number of units.
getRegion() - Method in class com.broadleafcommerce.fulfillment.common.domain.Address: State, Province, or Region in which this address or partial address is located.
getServiceLevel() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingGroup: Service level for the group.
getServiceLevel() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: The service level for this item if it has been assigned a PricedFulfillmentOption.
getSku() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: String representing the SKU.
getSupportedFulfillmentTypes() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingConfig: List of FulfillmentTypes that are supported by this application.
getTotalCartWeight() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOptionRequest: Optional total weight of the items in the cart.
getTotalGroupWeight() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingGroup: Optional aggregate weight of all items in the group.
getUnitOfMeasure() - Method in class com.broadleafcommerce.fulfillment.common.domain.Dimensions: The unit of measure for the length, width, and depth
getUnitOfMeasure() - Method in class com.broadleafcommerce.fulfillment.common.domain.Distance: The unit of measure of this distance.
getUnitOfMeasure() - Method in class com.broadleafcommerce.fulfillment.common.domain.Weight: The unit of measure of this weight.
getUnitPrice() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: The Cart price of one unit of this item.
getValue() - Method in class com.broadleafcommerce.fulfillment.common.domain.Distance: The numeric value of this distance.
getValue() - Method in class com.broadleafcommerce.fulfillment.common.domain.Weight: The numeric value of this weight.
getWeight() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: Weight per unit.
getWidth() - Method in class com.broadleafcommerce.fulfillment.common.domain.Dimensions: The width of the item (1 of 3 dimensions).
GROUP - Enum constant in enum class com.broadleafcommerce.fulfillment.common.domain.type.FulfillmentPricingStrategy: Indicates that fulfillment pricing should be applied to the Fulfillment Group, rather than each individual item.

H

hashCode() - Method in class com.broadleafcommerce.fulfillment.common.domain.Distance
hashCode() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOriginInfo
hashCode() - Method in class com.broadleafcommerce.fulfillment.common.domain.Weight

I

isPoBox() - Method in class com.broadleafcommerce.fulfillment.common.domain.Address: Indicates if this address or partial address is a Post Office (PO) Box.
isPriceCurrentServiceLevelsOnly() - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOptionRequest: Indicate whether all options should being priced or only the current selections.
ITEM - Enum constant in enum class com.broadleafcommerce.fulfillment.common.domain.type.FulfillmentPricingStrategy: Indicates that fulfillment pricing should be applied to the Fulfillment Item, rather than the containing Fulfillment Group.

O

of(BigDecimal, String) - Static method in class com.broadleafcommerce.fulfillment.common.domain.Distance: Get a new Distance object from the given value and unit.
of(BigDecimal, String) - Static method in class com.broadleafcommerce.fulfillment.common.domain.Weight: Get a new Weight object from the given value and unit.

S

setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOptionRequest: Map to hold arbitrary additional attributes.
setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOriginInfo: Map to hold arbitrary additional attributes.
setAddress(Address) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingGroup: The fulfillment address.
setAddress1(String) - Method in class com.broadleafcommerce.fulfillment.common.domain.Address: Street address line 1.
setAddress2(String) - Method in class com.broadleafcommerce.fulfillment.common.domain.Address: Street address line 2.
setAddress3(String) - Method in class com.broadleafcommerce.fulfillment.common.domain.Address: Street address line 3.
setCartSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOptionRequest: This is an optional field.
setCity(String) - Method in class com.broadleafcommerce.fulfillment.common.domain.Address: The name of a city in which this address or partial address is located.
setCountry(String) - Method in class com.broadleafcommerce.fulfillment.common.domain.Address: Country code.
setDefaultServiceLevel(String) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingConfig: The default service level to use if an item or group has not set the level.
setDepth(BigDecimal) - Method in class com.broadleafcommerce.fulfillment.common.domain.Dimensions: Sets the depth of the item (1 of 3 dimensions).
setDimensions(Dimensions) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: Dimensions per unit.
setFlatRates(Map<String, MonetaryAmount>) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: A List of Flat Rates to consider when pricing Fulfillment Options.
setFulfillmentOriginInfos(List<FulfillmentOriginInfo>) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: Used to allow targeting of fulfillment pricing based on a location where the application expects the item to be shipped from.
setFulfillmentPriceGroups(List<FulfillmentPricingGroup>) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOptionRequest: List of FulfillmentPricingGroup containing data from each FulfillmentGroup pertinent to fulfillment pricing.
setFulfillmentPricingStrategy(FulfillmentPricingStrategy) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingConfig: Strategy that defines whether PricedFulfillmentOption should target FulfillmentGroups or FulfillmentItems.
setFulfillmentType(String) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingGroup: The fulfillment type of this group.
setFulfillmentType(String) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: The fulfillment type for this item if it has been assigned a PricedFulfillmentOption.
setGroupSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingGroup: Optional merchandise subtotal of the Fulfillment Group.
setId(String) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingGroup: The reference number of the FulfillmentGroup that this group represents.
setId(String) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingConfig: ID associated with this config.
setInventoryLocationRef(String) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOriginInfo: The inventory location where this product will be fulfilled from.
setInventoryType(String) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: The inventory type of this item.
setItemReference(String) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: This is the reference number of the Fulfillment Item.
setItems(List<FulfillmentPricingItem>) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingGroup: List of items in this group that need to be fulfilled.
setLatitude(Double) - Method in class com.broadleafcommerce.fulfillment.common.domain.Address: Latitude for GPS coordinates.
setLength(BigDecimal) - Method in class com.broadleafcommerce.fulfillment.common.domain.Dimensions: Sets the length of the item (1 of 3 dimensions).
setLongitude(Double) - Method in class com.broadleafcommerce.fulfillment.common.domain.Address: Longitude for GPS coordinates.
setPoBox(boolean) - Method in class com.broadleafcommerce.fulfillment.common.domain.Address: Indicates if this address or partial address is a Post Office (PO) Box.
setPostalCode(String) - Method in class com.broadleafcommerce.fulfillment.common.domain.Address: Postal code (or ZIP code in the US) in which this address or partial address is located.
setPriceCurrentServiceLevelsOnly(boolean) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOptionRequest: Indicate whether all options should being priced or only the current selections.
setQuantity(int) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: Quantity or number of units.
setRegion(String) - Method in class com.broadleafcommerce.fulfillment.common.domain.Address: State, Province, or Region in which this address or partial address is located.
setServiceLevel(String) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingGroup: Service level for the group.
setServiceLevel(String) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: The service level for this item if it has been assigned a PricedFulfillmentOption.
setSku(String) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: String representing the SKU.
setSupportedFulfillmentTypes(Set<String>) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingConfig: List of FulfillmentTypes that are supported by this application.
setTotalCartWeight(Weight) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentOptionRequest: Optional total weight of the items in the cart.
setTotalGroupWeight(Weight) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingGroup: Optional aggregate weight of all items in the group.
setUnitOfMeasure(String) - Method in class com.broadleafcommerce.fulfillment.common.domain.Dimensions: The unit of measure for the length, width, and depth
setUnitOfMeasure(String) - Method in class com.broadleafcommerce.fulfillment.common.domain.Distance
setUnitOfMeasure(String) - Method in class com.broadleafcommerce.fulfillment.common.domain.Weight
setUnitPrice(MonetaryAmount) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: The Cart price of one unit of this item.
setValue(BigDecimal) - Method in class com.broadleafcommerce.fulfillment.common.domain.Distance
setValue(BigDecimal) - Method in class com.broadleafcommerce.fulfillment.common.domain.Weight
setWeight(Weight) - Method in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem: Weight per unit.
setWidth(BigDecimal) - Method in class com.broadleafcommerce.fulfillment.common.domain.Dimensions: Sets the width of the item (1 of 3 dimensions).
STANDARD_SERVICE_LEVEL - Static variable in class com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingConfig

T

toString() - Method in class com.broadleafcommerce.fulfillment.common.domain.Distance
toString() - Method in class com.broadleafcommerce.fulfillment.common.domain.Weight

V

valueOf(String) - Static method in enum class com.broadleafcommerce.fulfillment.common.domain.type.FulfillmentPricingStrategy: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.broadleafcommerce.fulfillment.common.domain.type.FulfillmentPricingStrategy: Returns an array containing the constants of this enum class, in the order they are declared.

W

Weight - Class in com.broadleafcommerce.fulfillment.common.domain: Generally represents weight, including a value and unit of measure.
Weight() - Constructor for class com.broadleafcommerce.fulfillment.common.domain.Weight
Weight(BigDecimal, String) - Constructor for class com.broadleafcommerce.fulfillment.common.domain.Weight

A C D E F G H I O S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form