Index

A B C D E F G H I J L O P R S T V 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addTaxDetail(SimpleTaxRecord, TaxItem, TaxInfo, BigDecimal, boolean) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
adjustTaxes(AdjustTaxTransactionRequest, ContextInfo) - Method in class com.broadleafcommerce.tax.delegate.DefaultTaxDelegate
 
adjustTaxes(AdjustTaxTransactionRequest, ContextInfo) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
adjustTaxes(AdjustTaxTransactionRequest, ContextInfo) - Method in interface com.broadleafcommerce.tax.TaxAccessor
For Tax Accessors that support "commitTaxes", this allows for adjustments after taxes have been committed.
AdjustTaxTransactionRequest - Class in com.broadleafcommerce.tax.domain
Encapsulated request that indicates that a Tax transaction should be adjusted.
AdjustTaxTransactionRequest() - Constructor for class com.broadleafcommerce.tax.domain.AdjustTaxTransactionRequest
 
attributes - Variable in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
Additional attributes for this tax response.
attributes - Variable in class com.broadleafcommerce.tax.domain.TaxResponseGroup
Additional attributes for this tax response.
attributes(Map<String, Object>) - Method in class com.broadleafcommerce.tax.domain.TaxDetail.TaxDetailBuilder
Additional attributes for this tax detail

B

build() - Method in class com.broadleafcommerce.tax.domain.TaxDetail.TaxDetailBuilder
 
buildCacheKey(ContextInfo) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
builder() - Static method in class com.broadleafcommerce.tax.domain.TaxDetail
 

C

calculateExcludedTax(MonetaryAmount, BigDecimal, TaxInfo, ContextInfo) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
Calculate tax and taxable amounts for excluded taxes.
calculateIncludedTax(MonetaryAmount, BigDecimal, TaxInfo, ContextInfo) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
Calculate tax and taxable amounts for included taxes.
calculateTaxes(TaxCalculationRequest, ContextInfo) - Method in class com.broadleafcommerce.tax.delegate.DefaultTaxDelegate
 
calculateTaxes(TaxCalculationRequest, ContextInfo) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
calculateTaxes(TaxCalculationRequest, ContextInfo) - Method in interface com.broadleafcommerce.tax.TaxAccessor
Takes the TaxCalculationRequest and computes sales tax.
calculateTaxes(List<T1>, ContextInfo) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
Deprecated.
calculateTaxes(List<T1>, ContextInfo) - Method in interface com.broadleafcommerce.tax.TaxAccessor
calculateTaxes(T1) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
Deprecated.
calculateTaxes(T1) - Method in interface com.broadleafcommerce.tax.TaxAccessor
canEqual(Object) - Method in class com.broadleafcommerce.tax.domain.AdjustTaxTransactionRequest
 
canEqual(Object) - Method in class com.broadleafcommerce.tax.domain.CommitTaxRequest
 
canEqual(Object) - Method in class com.broadleafcommerce.tax.domain.CommitTaxResponse
 
canEqual(Object) - Method in class com.broadleafcommerce.tax.domain.ReverseTaxTransactionRequest
 
canEqual(Object) - Method in class com.broadleafcommerce.tax.domain.ReverseTaxTransactionResponse
 
canEqual(Object) - Method in class com.broadleafcommerce.tax.domain.TaxAddress
 
canEqual(Object) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationGroup
 
canEqual(Object) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationRequest
 
canEqual(Object) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationResponse
 
canEqual(Object) - Method in class com.broadleafcommerce.tax.domain.TaxDetail
 
canEqual(Object) - Method in class com.broadleafcommerce.tax.domain.TaxInfo
 
canEqual(Object) - Method in class com.broadleafcommerce.tax.domain.TaxISOCountry
 
canEqual(Object) - Method in class com.broadleafcommerce.tax.domain.TaxItem
 
canEqual(Object) - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
 
canEqual(Object) - Method in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
 
canEqual(Object) - Method in class com.broadleafcommerce.tax.domain.TaxResponseGroup
 
canEqual(Object) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxConfig
 
canEqual(Object) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxRecord
 
canHandle(R, ContextInfo) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
canHandle(R, ContextInfo) - Method in interface com.broadleafcommerce.tax.TaxProvider
Indicates if this TaxProvider can handle requests for the given TaxCalculationRequest and ContextInfo, which can be null.
com.broadleafcommerce.tax - package com.broadleafcommerce.tax
 
com.broadleafcommerce.tax.autoconfigure - package com.broadleafcommerce.tax.autoconfigure
 
com.broadleafcommerce.tax.delegate - package com.broadleafcommerce.tax.delegate
 
com.broadleafcommerce.tax.domain - package com.broadleafcommerce.tax.domain
 
com.broadleafcommerce.tax.domain.type - package com.broadleafcommerce.tax.domain.type
 
com.broadleafcommerce.tax.simple - package com.broadleafcommerce.tax.simple
 
commitTaxes(CommitTaxRequest, ContextInfo) - Method in class com.broadleafcommerce.tax.delegate.DefaultTaxDelegate
 
commitTaxes(CommitTaxRequest, ContextInfo) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
commitTaxes(CommitTaxRequest, ContextInfo) - Method in interface com.broadleafcommerce.tax.TaxAccessor
Some TaxAccessor instances allow clients to "commit" taxes, which essentially marks them as being collected and owed to a jurisdiction or tax authority.
commitTaxes(T1) - Method in interface com.broadleafcommerce.tax.TaxAccessor
CommitTaxRequest - Class in com.broadleafcommerce.tax.domain
Encapsulated request that indicates that a Tax transaction should be committed.
CommitTaxRequest() - Constructor for class com.broadleafcommerce.tax.domain.CommitTaxRequest
 
CommitTaxResponse - Class in com.broadleafcommerce.tax.domain
Encapsulated response indicating that a tax transaction was committed.
CommitTaxResponse() - Constructor for class com.broadleafcommerce.tax.domain.CommitTaxResponse
 
country(String) - Method in class com.broadleafcommerce.tax.domain.TaxDetail.TaxDetailBuilder
The country for this tax.
createDefaultConfigCache() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
Creates a LRUMap to contain SimpleTaxConfig instances for different applications and / or tenants.
createSimpleTaxConfigFromJson(String) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
createSimpleTaxConfigFromResourcePath(String) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 

D

defaultIfNoneFound(SimpleTaxConfig) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
DefaultTaxDelegate<T1 extends TaxRequest,T2 extends TaxResponse> - Class in com.broadleafcommerce.tax.delegate
This component resolves a TaxProvider based on the provided ContextInfo and delegates appropriate tax calls to that provider.
DefaultTaxDelegate(List<TaxProvider<T1, T2>>, TaxDelegateProperties, TypeFactory) - Constructor for class com.broadleafcommerce.tax.delegate.DefaultTaxDelegate
 
DefaultTaxDelegate(List<TaxProvider<T1, T2>>, TaxDelegateProperties, TypeFactory, CircuitBreaker) - Constructor for class com.broadleafcommerce.tax.delegate.DefaultTaxDelegate
 
determineIsTaxIncluded(Boolean, Boolean) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
Deprecated.
Use the overload that accepts a ContextInfo, determineIsTaxIncluded(Boolean, Boolean, ContextInfo).
determineIsTaxIncluded(Boolean, Boolean, ContextInfo) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
Returns true if either of the TaxItem.getTaxIncluded() and SimpleTaxRecord.getVat() flags are true.
determineNonSimpleTaxProviders(List<TaxProvider<T1, T2>>) - Method in class com.broadleafcommerce.tax.delegate.DefaultTaxDelegate
Returns a Map of TaxProviders whose key is TaxProvider.getProviderId() and whose value is the TaxProvider instance.
determineRate(TaxItem, SimpleTaxRecord) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
Deprecated.
determineRate(TaxItem, SimpleTaxRecord, boolean) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
determineSimpleTaxProvider(List<TaxProvider<T1, T2>>) - Method in class com.broadleafcommerce.tax.delegate.DefaultTaxDelegate
This must return a TaxProvider instance whose TaxProvider.getProviderId() returns SIMPLE_TAX_PROVIDER_ID or it must return null if no SimpleTaxProvider is configured.
DiscriminatedProperties<P> - Class in com.broadleafcommerce.tax.autoconfigure
Mechanism to allow us to specify tax properties defined for different tenants and/or applications.
DiscriminatedProperties() - Constructor for class com.broadleafcommerce.tax.autoconfigure.DiscriminatedProperties
 

E

equals(Object) - Method in class com.broadleafcommerce.tax.domain.AdjustTaxTransactionRequest
 
equals(Object) - Method in class com.broadleafcommerce.tax.domain.CommitTaxRequest
 
equals(Object) - Method in class com.broadleafcommerce.tax.domain.CommitTaxResponse
 
equals(Object) - Method in class com.broadleafcommerce.tax.domain.ReverseTaxTransactionRequest
 
equals(Object) - Method in class com.broadleafcommerce.tax.domain.ReverseTaxTransactionResponse
 
equals(Object) - Method in class com.broadleafcommerce.tax.domain.TaxAddress
 
equals(Object) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationGroup
 
equals(Object) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationRequest
 
equals(Object) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationResponse
 
equals(Object) - Method in class com.broadleafcommerce.tax.domain.TaxDetail
 
equals(Object) - Method in class com.broadleafcommerce.tax.domain.TaxInfo
 
equals(Object) - Method in class com.broadleafcommerce.tax.domain.TaxISOCountry
 
equals(Object) - Method in class com.broadleafcommerce.tax.domain.TaxItem
 
equals(Object) - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
 
equals(Object) - Method in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
 
equals(Object) - Method in class com.broadleafcommerce.tax.domain.TaxResponseGroup
 
equals(Object) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxConfig
 
equals(Object) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxRecord
 
exemptionAmount - Variable in class com.broadleafcommerce.tax.domain.TaxInfo
The amount of this item that is not taxable.

F

findByCountry(List<SimpleTaxRecord>, TaxAddress) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
findByPostalCode(List<SimpleTaxRecord>, TaxAddress) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
findBySubdivision(List<SimpleTaxRecord>, TaxAddress) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
findBySubdivisionAndCity(List<SimpleTaxRecord>, TaxAddress) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
FULFILLMENT - Enum constant in enum class com.broadleafcommerce.tax.domain.type.TaxItemType
Designates a fulfillment line item that will have a fulfillment (a.k.a., shipping or delivery) price.
fulfillmentGroupReferenceNumber - Variable in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
The fulfillment group reference number.
fulfillmentGroupReferenceNumber - Variable in class com.broadleafcommerce.tax.domain.TaxResponseGroup
The fulfillment group reference number.

G

getAddressLine1() - Method in class com.broadleafcommerce.tax.domain.TaxAddress
Primary address information, typically street name and building number.
getAddressLine2() - Method in class com.broadleafcommerce.tax.domain.TaxAddress
Secondary address information, like apartment, suite, or unit number.
getAddressLine3() - Method in class com.broadleafcommerce.tax.domain.TaxAddress
Tertiary address information, typically for international addresses.
getAllowTaxExemption() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxRecord
Indicates if a Tax exemption is allowed.
getAlpha2() - Method in class com.broadleafcommerce.tax.domain.TaxISOCountry
The two letter code for this country.
getAlpha3() - Method in class com.broadleafcommerce.tax.domain.TaxISOCountry
The three letter code for this country.
getApplication() - Method in class com.broadleafcommerce.tax.autoconfigure.DiscriminatedProperties
 
getAttributes() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationGroup
Additional attributes for this tax group.
getAttributes() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationRequest
Additional attributes for this tax request.
getAttributes() - Method in class com.broadleafcommerce.tax.domain.TaxDetail
Additional attributes for this tax detail
getAttributes() - Method in class com.broadleafcommerce.tax.domain.TaxInfo
Additional attributes for this tax info
getAttributes() - Method in class com.broadleafcommerce.tax.domain.TaxItem
Any additional attributes for this tax item.
getAttributes() - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
Additional attributes for this tax group.
getAttributes() - Method in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
Additional attributes for this tax response.
getAttributes() - Method in class com.broadleafcommerce.tax.domain.TaxResponseGroup
Additional attributes for this tax response.
getCartId() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationRequest
ID of the shopping cart.
getCircuitBreaker() - Method in class com.broadleafcommerce.tax.delegate.DefaultTaxDelegate
 
getCity() - Method in class com.broadleafcommerce.tax.domain.TaxAddress
The city, town or village of this address.
getCity() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxRecord
This city for this record.
getConfigFromCache(String) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
Fetches the SimpleTaxConfig from cache so that it does not have to be deserialized every time.
getConfigJsonString() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProperties
This is a JSON string that conforms to SimpleTaxConfig.
getConfigJsonString(ContextInfo) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProperties
This is a JSON string that conforms to SimpleTaxConfig.
getConfigPath() - Method in class com.broadleafcommerce.tax.simple.LegacySimpleTaxProperties
Deprecated.
 
getConfigPath() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProperties
Provides a path to a Resource.
getConfigPath(ContextInfo) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProperties
Provides a path to a Resource.
getCountry() - Method in class com.broadleafcommerce.tax.domain.TaxAddress
The country for this address.
getCountry() - Method in class com.broadleafcommerce.tax.domain.TaxDetail
The country for this tax.
getCountryDefault() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxRecord
Whether this record is the default for the mapped country.
getCounty() - Method in class com.broadleafcommerce.tax.domain.TaxAddress
The county of this address.
getCurrency() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationRequest
Currency of the Cart.
getCurrency() - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
 
getCustomer() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationRequest
Identifier for the customer that these taxes will apply to.
getCustomer() - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
The customer that these taxes will apply to.
getCustomerTaxExemptionCode() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationRequest
Tax exemption code, if known, for the customer.
getDefaultConfigCache() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
getDefaultRate() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxConfig
The default rate if no matching in SimpleTaxConfig.getTaxTables() found.
getDefaultSimpleTaxConfig() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
getDescription() - Method in class com.broadleafcommerce.tax.domain.TaxItem
The description for this item.
getExampleSimpleTaxConfig() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
getExemptionAmount() - Method in class com.broadleafcommerce.tax.domain.TaxInfo
The amount of this item that is not taxable.
getFallbackTaxProviderId(ContextInfo) - Method in class com.broadleafcommerce.tax.delegate.TaxDelegateProperties
The fallback tax provider for the given ContextInfo.
getField(String, ContextInfo) - Method in class com.broadleafcommerce.tax.autoconfigure.DiscriminatedProperties
 
getField(String, String, String) - Method in class com.broadleafcommerce.tax.autoconfigure.DiscriminatedProperties
Looks for a property based first on the applicaionId and then the tenantId and then with no discrimination.
getFromAddress() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationGroup
The address that the items will be shipped from.
getFromAddress() - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
The address that the items will be shipped from.
getFulfillmentGroupReferenceNumber() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationGroup
The fulfillment group reference number.
getFulfillmentGroupReferenceNumber() - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
The fulfillment group reference number.
getFulfillmentGroupReferenceNumber() - Method in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
The fulfillment group reference number.
getFulfillmentGroupReferenceNumber() - Method in class com.broadleafcommerce.tax.domain.TaxResponseGroup
The fulfillment group reference number.
getInternalAttributes() - Method in class com.broadleafcommerce.tax.domain.CommitTaxResponse
Any internal attributes that may need to be used for later tax operations.
getInternalAttributes() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationResponse
Any internal attributes to be copied over to an order on post commit tax operations.
getItemId() - Method in class com.broadleafcommerce.tax.domain.TaxInfo
The id of the line item for this tax info.
getItemId() - Method in class com.broadleafcommerce.tax.domain.TaxItem
The unique identifier for this line item.
getJurisCode() - Method in class com.broadleafcommerce.tax.domain.TaxItem
The jurisdiction code for this item.
getJurisdictionName() - Method in class com.broadleafcommerce.tax.domain.TaxDetail
The jurisdiction name.
getJurisdictionType() - Method in class com.broadleafcommerce.tax.domain.TaxDetail
The jurisdiction type, e.g.
getJurisName() - Method in class com.broadleafcommerce.tax.domain.TaxItem
The jurisdiction name for this item.
getJurisType() - Method in class com.broadleafcommerce.tax.domain.TaxItem
The jurisdiction type for this item.
getName() - Method in class com.broadleafcommerce.tax.domain.TaxISOCountry
 
getNoDefaultRateFound() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
getNumericCode() - Method in class com.broadleafcommerce.tax.domain.TaxISOCountry
The three digit code for this country.
getObjectMapper() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
getOrder() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
Order this component with a low precedence.
getOrder() - Method in interface com.broadleafcommerce.tax.TaxProvider
Allows for ordering of priority or precedence for various TaxProvider implementations.
getOriginalTransactionDate() - Method in class com.broadleafcommerce.tax.domain.ReverseTaxTransactionRequest
The date of the original checkout or commit transaction.
getPostalCode() - Method in class com.broadleafcommerce.tax.domain.TaxAddress
Postal code or ZIP code for this address.
getPostalCode() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxRecord
This postal code for this record.
getPreferredTaxProviderId(ContextInfo) - Method in class com.broadleafcommerce.tax.delegate.TaxDelegateProperties
The preferred tax provider for the given ContextInfo.
getProperties() - Method in class com.broadleafcommerce.tax.delegate.DefaultTaxDelegate
 
getProviderId() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationRequest
This is simply a hint that can be provided by the client that indicates that taxes were previously calculated by a particular TaxProvider.
getProviderId() - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
The providerId indicates what provider returned the TaxResponse instances from a call to calculate taxes.
getProviderId() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
getProviderId() - Method in interface com.broadleafcommerce.tax.TaxProvider
This returns a string that is unique to identify each TaxProvider.
getQuantity() - Method in class com.broadleafcommerce.tax.domain.TaxItem
The tax item quantity.
getRate() - Method in class com.broadleafcommerce.tax.domain.TaxDetail
The rate of this tax.
getRate() - Method in class com.broadleafcommerce.tax.domain.TaxInfo
The rate that the item was taxed at.
getRate() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxRecord
The rate for this record.
getReason() - Method in class com.broadleafcommerce.tax.domain.AdjustTaxTransactionRequest
The reason that this tax transaction is being adjusted.
getRegion() - Method in class com.broadleafcommerce.tax.domain.TaxDetail
The region for this tax.
getResourceLoader() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
getSimpleTaxProps() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
getSimpleTaxProvider() - Method in class com.broadleafcommerce.tax.delegate.DefaultTaxDelegate
 
getSkuCode() - Method in class com.broadleafcommerce.tax.domain.TaxInfo
The sku code for the item.
getSkuCode() - Method in class com.broadleafcommerce.tax.domain.TaxItem
The sku code for this item.
getStateProvinceRegion() - Method in class com.broadleafcommerce.tax.domain.TaxAddress
The state, province or region of this address.
getStateProvinceRegion() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxRecord
This state, province, or region for this record.
getSubtotal() - Method in class com.broadleafcommerce.tax.domain.TaxItem
The subtotal of this item being paid for by a customer.
getTaxableAmount() - Method in class com.broadleafcommerce.tax.domain.TaxDetail
The amount that was taxable to determine the calculated tax.
getTaxableAmount() - Method in class com.broadleafcommerce.tax.domain.TaxInfo
The amount of this item that is taxable and was used to determine the calculated tax.
getTaxCalculated() - Method in class com.broadleafcommerce.tax.domain.TaxDetail
The calculated tax for this detail.
getTaxCalculated() - Method in class com.broadleafcommerce.tax.domain.TaxInfo
The tax calculated for the item.
getTaxCalculationGroups() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationRequest
Groups of shipping details for the purpose of tax calculation.
getTaxCode() - Method in class com.broadleafcommerce.tax.domain.TaxInfo
The tax code for the item.
getTaxCode() - Method in class com.broadleafcommerce.tax.domain.TaxItem
The tax code for this item.
getTaxConfig(T1, TaxItem) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
Deprecated.
use resolveSimpleTaxConfig
getTaxDetails() - Method in class com.broadleafcommerce.tax.domain.TaxInfo
Breakdown of taxes for this item.
getTaxGroups() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationResponse
This is a map of TaxResponseGroup objects keyed by fulfillment group reference.
getTaxId() - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
The tax id for this tax request
getTaxIncluded() - Method in class com.broadleafcommerce.tax.domain.TaxItem
Indicates if the taxes are already included in the price (subtotal).
getTaxInfo(SimpleTaxRecord, TaxItem, boolean, ContextInfo) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
Create and populate a TaxInfo for this TaxItem.
getTaxInfo(SimpleTaxRecord, TaxItem, CurrencyUnit) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
getTaxInfo(BigDecimal, TaxItem, CurrencyUnit) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
getTaxInfo(R, SimpleTaxRecord, TaxItem, CurrencyUnit, ContextInfo) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
Create and populate a TaxInfo for this TaxItem.
getTaxInfos() - Method in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
The tax infos for each of the line items, keyed by fulfillmentGroupReferenceNumber + "-" + itemId.
getTaxInfos() - Method in class com.broadleafcommerce.tax.domain.TaxResponseGroup
The tax infos for each of the line items, keyed by fulfillmentGroupReferenceNumber + "-" + itemId.
getTaxItems() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationGroup
The list of items to be taxed.
getTaxItems() - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
The list of items to be taxed.
getTaxName() - Method in class com.broadleafcommerce.tax.domain.TaxDetail
The name of the tax.
getTaxProviderId() - Method in class com.broadleafcommerce.tax.domain.CommitTaxResponse
Represents the TaxProvider that was used to respond to a corresponding CommitTaxRequest.
getTaxProviderId() - Method in class com.broadleafcommerce.tax.domain.ReverseTaxTransactionResponse
This is simply a hint that can be provided by the client that indicates that taxes were previously calculated by a particular TaxProvider.
getTaxProviderId() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationResponse
The ID of the TaxProvider that was used to process the corresponding request.
getTaxProviderMap() - Method in class com.broadleafcommerce.tax.delegate.DefaultTaxDelegate
 
getTaxRecord(TaxCalculationGroup, TaxItem, SimpleTaxConfig) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
getTaxRecord(T1, TaxItem, SimpleTaxConfig) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
Deprecated.
getTaxResponse(T1) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
Deprecated.
getTaxResponse(T1, SimpleTaxConfig) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
Deprecated.
getTaxTables() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxConfig
Map of a tax code to a list of tax records for that jurisdiction.
getTenant() - Method in class com.broadleafcommerce.tax.autoconfigure.DiscriminatedProperties
 
getToAddress() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationGroup
The address that the items will be shipped to.
getToAddress() - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
The address that the items will be shipped to.
getTotalAmount() - Method in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
The total amount of the items.
getTotalAmount() - Method in class com.broadleafcommerce.tax.domain.TaxResponseGroup
The total amount of the items.
getTotalExemption() - Method in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
The total amount that is not taxable from the items.
getTotalExemption() - Method in class com.broadleafcommerce.tax.domain.TaxResponseGroup
The total amount that is not taxable from the items.
getTotalTaxable() - Method in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
The total amount that is taxable from the items.
getTotalTaxable() - Method in class com.broadleafcommerce.tax.domain.TaxResponseGroup
The total amount that is taxable from the items.
getTotalTaxCalculated() - Method in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
The total tax calculated from all items.
getTotalTaxCalculated() - Method in class com.broadleafcommerce.tax.domain.TaxResponseGroup
The total tax calculated from all items.
getTransactionId() - Method in class com.broadleafcommerce.tax.domain.TaxDetail
The transaction ID for this tax detail.
getType() - Method in class com.broadleafcommerce.tax.domain.TaxItem
Specifies the kind of item this is such as FULFILLMENT or ORDER.
getTypeFactory() - Method in class com.broadleafcommerce.tax.delegate.DefaultTaxDelegate
 
getTypeFactory() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
getVat() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxRecord
True if this is a VAT tax
getVatRegistrationId() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationRequest
Optional VAT registration ID.

H

hashCode() - Method in class com.broadleafcommerce.tax.domain.AdjustTaxTransactionRequest
 
hashCode() - Method in class com.broadleafcommerce.tax.domain.CommitTaxRequest
 
hashCode() - Method in class com.broadleafcommerce.tax.domain.CommitTaxResponse
 
hashCode() - Method in class com.broadleafcommerce.tax.domain.ReverseTaxTransactionRequest
 
hashCode() - Method in class com.broadleafcommerce.tax.domain.ReverseTaxTransactionResponse
 
hashCode() - Method in class com.broadleafcommerce.tax.domain.TaxAddress
 
hashCode() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationGroup
 
hashCode() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationRequest
 
hashCode() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationResponse
 
hashCode() - Method in class com.broadleafcommerce.tax.domain.TaxDetail
 
hashCode() - Method in class com.broadleafcommerce.tax.domain.TaxInfo
 
hashCode() - Method in class com.broadleafcommerce.tax.domain.TaxISOCountry
 
hashCode() - Method in class com.broadleafcommerce.tax.domain.TaxItem
 
hashCode() - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
 
hashCode() - Method in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
 
hashCode() - Method in class com.broadleafcommerce.tax.domain.TaxResponseGroup
 
hashCode() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxConfig
 
hashCode() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxRecord
 

I

isEstimated() - Method in class com.broadleafcommerce.tax.domain.TaxInfo
Whether the calculated tax is an estimate.
isEstimator() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
isEstimator() - Method in interface com.broadleafcommerce.tax.TaxProvider
Indicates (or hints) if this provider estimates taxes.
isExempt() - Method in class com.broadleafcommerce.tax.domain.TaxDetail
Indicates if this is exempt from taxes, usually based on a tax exemption code.
isExempt() - Method in class com.broadleafcommerce.tax.domain.TaxInfo
Indicates if this is exempt from taxes, usually based on a tax exemption code.
isExempt(boolean) - Method in class com.broadleafcommerce.tax.domain.TaxDetail.TaxDetailBuilder
Indicates if this is exempt from taxes, usually based on a tax exemption code.
isSampleConfig() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxConfig
Whether this configuration is the out-of-the-box sample or is otherwise marked as a sample.
isSubdivisionMatch(TaxAddress, SimpleTaxRecord) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
isTaxable() - Method in class com.broadleafcommerce.tax.domain.TaxInfo
Whether the item is taxable.
isTaxable() - Method in class com.broadleafcommerce.tax.domain.TaxItem
Is this item tax exempt? Default is true
isTaxExempt(R, ContextInfo) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
isTaxIncluded() - Method in class com.broadleafcommerce.tax.domain.TaxInfo
Indicates if taxes were included in the original price or subtotal passed in.
isTemporaryCalculation() - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
For tax services that support it, records the transaction in the tax service for reporting purposes.
isVat() - Method in class com.broadleafcommerce.tax.domain.TaxDetail
Declares whether the taxes were included in the provided subtotal.
isVat() - Method in class com.broadleafcommerce.tax.domain.TaxInfo
Declares whether the taxes were included in the provided subtotal.
isVat(boolean) - Method in class com.broadleafcommerce.tax.domain.TaxDetail.TaxDetailBuilder
Declares whether the taxes were included in the provided subtotal.

J

jurisdictionName(String) - Method in class com.broadleafcommerce.tax.domain.TaxDetail.TaxDetailBuilder
The jurisdiction name.
jurisdictionType(String) - Method in class com.broadleafcommerce.tax.domain.TaxDetail.TaxDetailBuilder
The jurisdiction type, e.g.

L

LegacySimpleTaxProperties - Class in com.broadleafcommerce.tax.simple
Deprecated. 
LegacySimpleTaxProperties() - Constructor for class com.broadleafcommerce.tax.simple.LegacySimpleTaxProperties
Deprecated.
 
legacyTaxPropertiesValidator(LegacySimpleTaxProperties) - Method in class com.broadleafcommerce.tax.autoconfigure.TaxServiceAutoConfiguration
Deprecated.
LegacyTaxPropertiesValidator - Class in com.broadleafcommerce.tax.autoconfigure
Component to simply validate that nobody is using legacy properties to avoid confusion or accidents.
LegacyTaxPropertiesValidator(LegacySimpleTaxProperties) - Constructor for class com.broadleafcommerce.tax.autoconfigure.LegacyTaxPropertiesValidator
 
lookupTaxConfig(SimpleTaxConfig, TaxAddress) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
lookupTaxConfig(SimpleTaxConfig, TaxAddress, String) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 

O

ORDER - Enum constant in enum class com.broadleafcommerce.tax.domain.type.TaxItemType
Designates a regular order line item.

P

populateTaxResponse(TaxCalculationRequest, TaxCalculationResponse, SimpleTaxConfig, ContextInfo) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
populateTaxResponseGroup(TaxResponseGroup, R, TaxCalculationGroup, SimpleTaxConfig, CurrencyUnit, ContextInfo) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
putConfigInCache(String, SimpleTaxConfig) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
Puts the SimpleTaxConfig in a cache so that it does not have to be deserialized every time.

R

rate(BigDecimal) - Method in class com.broadleafcommerce.tax.domain.TaxDetail.TaxDetailBuilder
The rate of this tax.
region(String) - Method in class com.broadleafcommerce.tax.domain.TaxDetail.TaxDetailBuilder
The region for this tax.
resolveFallbackProvider(R, ContextInfo) - Method in class com.broadleafcommerce.tax.delegate.DefaultTaxDelegate
Attempts to resolve a fallback TaxProvider.
resolvePreferredTaxProvider(R, ContextInfo) - Method in class com.broadleafcommerce.tax.delegate.DefaultTaxDelegate
Resolves the preferred TaxProvider to be used to execute a tax request.
resolveSimpleTaxConfig(ContextInfo) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
reverseTaxTransaction(ReverseTaxTransactionRequest, ContextInfo) - Method in class com.broadleafcommerce.tax.delegate.DefaultTaxDelegate
 
reverseTaxTransaction(ReverseTaxTransactionRequest, ContextInfo) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
reverseTaxTransaction(ReverseTaxTransactionRequest, ContextInfo) - Method in interface com.broadleafcommerce.tax.TaxAccessor
For Tax Accessors that support "commitTaxes", this allows for reversal after taxes have been committed.
ReverseTaxTransactionRequest - Class in com.broadleafcommerce.tax.domain
Encapsulated request indicating that taxes that have been committed or saved should be reversed.
ReverseTaxTransactionRequest() - Constructor for class com.broadleafcommerce.tax.domain.ReverseTaxTransactionRequest
 
ReverseTaxTransactionResponse - Class in com.broadleafcommerce.tax.domain
Encapsulated response indicating that a request to reverse a tax transaction has been executed.
ReverseTaxTransactionResponse() - Constructor for class com.broadleafcommerce.tax.domain.ReverseTaxTransactionResponse
 

S

setAddressLine1(String) - Method in class com.broadleafcommerce.tax.domain.TaxAddress
Primary address information, typically street name and building number.
setAddressLine2(String) - Method in class com.broadleafcommerce.tax.domain.TaxAddress
Secondary address information, like apartment, suite, or unit number.
setAddressLine3(String) - Method in class com.broadleafcommerce.tax.domain.TaxAddress
Tertiary address information, typically for international addresses.
setAllowTaxExemption(Boolean) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxRecord
Indicates if a Tax exemption is allowed.
setAlpha2(String) - Method in class com.broadleafcommerce.tax.domain.TaxISOCountry
The two letter code for this country.
setAlpha3(String) - Method in class com.broadleafcommerce.tax.domain.TaxISOCountry
The three letter code for this country.
setApplication(Map<String, P>) - Method in class com.broadleafcommerce.tax.autoconfigure.DiscriminatedProperties
 
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationGroup
Additional attributes for this tax group.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationRequest
Additional attributes for this tax request.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.tax.domain.TaxDetail
Additional attributes for this tax detail
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.tax.domain.TaxInfo
Additional attributes for this tax info
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.tax.domain.TaxItem
Any additional attributes for this tax item.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
Additional attributes for this tax group.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
Additional attributes for this tax response.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.tax.domain.TaxResponseGroup
Additional attributes for this tax response.
setCartId(String) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationRequest
ID of the shopping cart.
setCity(String) - Method in class com.broadleafcommerce.tax.domain.TaxAddress
The city, town or village of this address.
setCity(String) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxRecord
This city for this record.
setConfigJsonString(String) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProperties
This is a JSON string that conforms to SimpleTaxConfig.
setConfigPath(String) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProperties
Provides a path to a Resource.
setConfigPath(Resource) - Method in class com.broadleafcommerce.tax.simple.LegacySimpleTaxProperties
Deprecated.
 
setCountry(String) - Method in class com.broadleafcommerce.tax.domain.TaxAddress
The country for this address.
setCountry(String) - Method in class com.broadleafcommerce.tax.domain.TaxDetail
The country for this tax.
setCountryDefault(Boolean) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxRecord
Whether this record is the default for the mapped country.
setCounty(String) - Method in class com.broadleafcommerce.tax.domain.TaxAddress
The county of this address.
setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationRequest
Currency of the Cart.
setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
 
setCustomer(String) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationRequest
Identifier for the customer that these taxes will apply to.
setCustomer(String) - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
The customer that these taxes will apply to.
setCustomerTaxExemptionCode(String) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationRequest
Tax exemption code, if known, for the customer.
setDefaultRate(SimpleTaxRecord) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxConfig
The default rate if no matching in SimpleTaxConfig.getTaxTables() found.
setDescription(String) - Method in class com.broadleafcommerce.tax.domain.TaxItem
The description for this item.
setEstimated(boolean) - Method in class com.broadleafcommerce.tax.domain.TaxInfo
Whether the calculated tax is an estimate.
setExempt(boolean) - Method in class com.broadleafcommerce.tax.domain.TaxDetail
Indicates if this is exempt from taxes, usually based on a tax exemption code.
setExempt(boolean) - Method in class com.broadleafcommerce.tax.domain.TaxInfo
Indicates if this is exempt from taxes, usually based on a tax exemption code.
setExemptionAmount(MonetaryAmount) - Method in class com.broadleafcommerce.tax.domain.TaxInfo
The amount of this item that is not taxable.
setFallbackTaxProviderId(String) - Method in class com.broadleafcommerce.tax.delegate.TaxDelegateProperties
If the preferred tax provider fails for any reason, a fallback may be used instead.
setFromAddress(TaxAddress) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationGroup
The address that the items will be shipped from.
setFromAddress(TaxAddress) - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
The address that the items will be shipped from.
setFulfillmentGroupReferenceNumber(String) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationGroup
The fulfillment group reference number.
setFulfillmentGroupReferenceNumber(String) - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
The fulfillment group reference number.
setFulfillmentGroupReferenceNumber(String) - Method in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
The fulfillment group reference number.
setFulfillmentGroupReferenceNumber(String) - Method in class com.broadleafcommerce.tax.domain.TaxResponseGroup
The fulfillment group reference number.
setInternalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.tax.domain.CommitTaxResponse
Any internal attributes that may need to be used for later tax operations.
setInternalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationResponse
Any internal attributes to be copied over to an order on post commit tax operations.
setItemId(String) - Method in class com.broadleafcommerce.tax.domain.TaxInfo
The id of the line item for this tax info.
setItemId(String) - Method in class com.broadleafcommerce.tax.domain.TaxItem
The unique identifier for this line item.
setJurisCode(String) - Method in class com.broadleafcommerce.tax.domain.TaxItem
The jurisdiction code for this item.
setJurisdictionName(String) - Method in class com.broadleafcommerce.tax.domain.TaxDetail
The jurisdiction name.
setJurisdictionType(String) - Method in class com.broadleafcommerce.tax.domain.TaxDetail
The jurisdiction type, e.g.
setJurisName(String) - Method in class com.broadleafcommerce.tax.domain.TaxItem
The jurisdiction name for this item.
setJurisType(String) - Method in class com.broadleafcommerce.tax.domain.TaxItem
The jurisdiction type for this item.
setName(String) - Method in class com.broadleafcommerce.tax.domain.TaxISOCountry
 
setNumericCode(Integer) - Method in class com.broadleafcommerce.tax.domain.TaxISOCountry
The three digit code for this country.
setOriginalTransactionDate(Instant) - Method in class com.broadleafcommerce.tax.domain.ReverseTaxTransactionRequest
The date of the original checkout or commit transaction.
setPostalCode(String) - Method in class com.broadleafcommerce.tax.domain.TaxAddress
Postal code or ZIP code for this address.
setPostalCode(String) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxRecord
This postal code for this record.
setPreferredTaxProviderId(String) - Method in class com.broadleafcommerce.tax.delegate.TaxDelegateProperties
The preferred tax provider.
setProviderId(String) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationRequest
This is simply a hint that can be provided by the client that indicates that taxes were previously calculated by a particular TaxProvider.
setProviderId(String) - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
The providerId indicates what provider returned the TaxResponse instances from a call to calculate taxes.
setQuantity(int) - Method in class com.broadleafcommerce.tax.domain.TaxItem
The tax item quantity.
setRate(Double) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxRecord
The rate for this record.
setRate(BigDecimal) - Method in class com.broadleafcommerce.tax.domain.TaxDetail
The rate of this tax.
setRate(BigDecimal) - Method in class com.broadleafcommerce.tax.domain.TaxInfo
The rate that the item was taxed at.
setReason(String) - Method in class com.broadleafcommerce.tax.domain.AdjustTaxTransactionRequest
The reason that this tax transaction is being adjusted.
setRegion(String) - Method in class com.broadleafcommerce.tax.domain.TaxDetail
The region for this tax.
setSampleConfig(boolean) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxConfig
Whether this configuration is the out-of-the-box sample or is otherwise marked as a sample.
setSkuCode(String) - Method in class com.broadleafcommerce.tax.domain.TaxInfo
The sku code for the item.
setSkuCode(String) - Method in class com.broadleafcommerce.tax.domain.TaxItem
The sku code for this item.
setStateProvinceRegion(String) - Method in class com.broadleafcommerce.tax.domain.TaxAddress
The state, province or region of this address.
setStateProvinceRegion(String) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxRecord
This state, province, or region for this record.
setSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.tax.domain.TaxItem
The subtotal of this item being paid for by a customer.
setTaxable(boolean) - Method in class com.broadleafcommerce.tax.domain.TaxInfo
Whether the item is taxable.
setTaxable(boolean) - Method in class com.broadleafcommerce.tax.domain.TaxItem
Is this item tax exempt? Default is true
setTaxableAmount(MonetaryAmount) - Method in class com.broadleafcommerce.tax.domain.TaxDetail
The amount that was taxable to determine the calculated tax.
setTaxableAmount(MonetaryAmount) - Method in class com.broadleafcommerce.tax.domain.TaxInfo
The amount of this item that is taxable and was used to determine the calculated tax.
setTaxCalculated(MonetaryAmount) - Method in class com.broadleafcommerce.tax.domain.TaxDetail
The calculated tax for this detail.
setTaxCalculated(MonetaryAmount) - Method in class com.broadleafcommerce.tax.domain.TaxInfo
The tax calculated for the item.
setTaxCalculationGroups(List<TaxCalculationGroup>) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationRequest
Groups of shipping details for the purpose of tax calculation.
setTaxCode(String) - Method in class com.broadleafcommerce.tax.domain.TaxInfo
The tax code for the item.
setTaxCode(String) - Method in class com.broadleafcommerce.tax.domain.TaxItem
The tax code for this item.
setTaxDetails(List<TaxDetail>) - Method in class com.broadleafcommerce.tax.domain.TaxInfo
Breakdown of taxes for this item.
setTaxGroups(Map<String, TaxResponseGroup>) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationResponse
This is a map of TaxResponseGroup objects keyed by fulfillment group reference.
setTaxId(String) - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
The tax id for this tax request
setTaxIncluded(boolean) - Method in class com.broadleafcommerce.tax.domain.TaxInfo
Indicates if taxes were included in the original price or subtotal passed in.
setTaxIncluded(Boolean) - Method in class com.broadleafcommerce.tax.domain.TaxItem
Indicates if the taxes are already included in the price (subtotal).
setTaxInfos(Map<String, TaxInfo>) - Method in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
The tax infos for each of the line items, keyed by fulfillmentGroupReferenceNumber + "-" + itemId.
setTaxInfos(Map<String, TaxInfo>) - Method in class com.broadleafcommerce.tax.domain.TaxResponseGroup
The tax infos for each of the line items, keyed by fulfillmentGroupReferenceNumber + "-" + itemId.
setTaxItems(List<TaxItem>) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationGroup
The list of items to be taxed.
setTaxItems(List<TaxItem>) - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
The list of items to be taxed.
setTaxName(String) - Method in class com.broadleafcommerce.tax.domain.TaxDetail
The name of the tax.
setTaxProviderId(String) - Method in class com.broadleafcommerce.tax.domain.CommitTaxResponse
Represents the TaxProvider that was used to respond to a corresponding CommitTaxRequest.
setTaxProviderId(String) - Method in class com.broadleafcommerce.tax.domain.ReverseTaxTransactionResponse
This is simply a hint that can be provided by the client that indicates that taxes were previously calculated by a particular TaxProvider.
setTaxProviderId(String) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationResponse
The ID of the TaxProvider that was used to process the corresponding request.
setTaxTables(Map<String, List<SimpleTaxRecord>>) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxConfig
Map of a tax code to a list of tax records for that jurisdiction.
setTemporaryCalculation(boolean) - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
For tax services that support it, records the transaction in the tax service for reporting purposes.
setTenant(Map<String, P>) - Method in class com.broadleafcommerce.tax.autoconfigure.DiscriminatedProperties
 
setToAddress(TaxAddress) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationGroup
The address that the items will be shipped to.
setToAddress(TaxAddress) - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
The address that the items will be shipped to.
setTotalAmount(MonetaryAmount) - Method in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
The total amount of the items.
setTotalAmount(MonetaryAmount) - Method in class com.broadleafcommerce.tax.domain.TaxResponseGroup
The total amount of the items.
setTotalExemption(MonetaryAmount) - Method in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
The total amount that is not taxable from the items.
setTotalExemption(MonetaryAmount) - Method in class com.broadleafcommerce.tax.domain.TaxResponseGroup
The total amount that is not taxable from the items.
setTotalTaxable(MonetaryAmount) - Method in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
The total amount that is taxable from the items.
setTotalTaxable(MonetaryAmount) - Method in class com.broadleafcommerce.tax.domain.TaxResponseGroup
The total amount that is taxable from the items.
setTotalTaxCalculated(MonetaryAmount) - Method in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
The total tax calculated from all items.
setTotalTaxCalculated(MonetaryAmount) - Method in class com.broadleafcommerce.tax.domain.TaxResponseGroup
The total tax calculated from all items.
setTransactionId(String) - Method in class com.broadleafcommerce.tax.domain.TaxDetail
The transaction ID for this tax detail.
setType(String) - Method in class com.broadleafcommerce.tax.domain.TaxItem
Specifies the kind of item this is such as FULFILLMENT or ORDER.
setVat(boolean) - Method in class com.broadleafcommerce.tax.domain.TaxDetail
Declares whether the taxes were included in the provided subtotal.
setVat(boolean) - Method in class com.broadleafcommerce.tax.domain.TaxInfo
Declares whether the taxes were included in the provided subtotal.
setVat(Boolean) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxRecord
True if this is a VAT tax
setVatRegistrationId(String) - Method in class com.broadleafcommerce.tax.domain.TaxCalculationRequest
Optional VAT registration ID.
SIMPLE_TAX_CONFIG_EXAMPLE - Static variable in class com.broadleafcommerce.tax.simple.SimpleTaxProperties
 
SIMPLE_TAX_PROVIDER_ID - Static variable in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
SimpleTaxConfig - Class in com.broadleafcommerce.tax.simple
Tax configuration read from a file.
SimpleTaxConfig() - Constructor for class com.broadleafcommerce.tax.simple.SimpleTaxConfig
 
SimpleTaxProperties - Class in com.broadleafcommerce.tax.simple
Provides properties for the SimpleTaxProvider, optionally discriminated by tenantId or applicationId.
SimpleTaxProperties() - Constructor for class com.broadleafcommerce.tax.simple.SimpleTaxProperties
 
SimpleTaxProvider<T1 extends TaxRequest,T2 extends TaxResponse> - Class in com.broadleafcommerce.tax.simple
Simple implementation of TaxProvider primarily used for estimating taxes, but can be used for providing full taxes for implementors without complex tax needs.
SimpleTaxProvider(ObjectMapper, TypeFactory, SimpleTaxProperties) - Constructor for class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
SimpleTaxProvider(ObjectMapper, TypeFactory, SimpleTaxProperties, ResourceLoader) - Constructor for class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
SimpleTaxRecord - Class in com.broadleafcommerce.tax.simple
A single configuration of a tax rate according to a location.
SimpleTaxRecord() - Constructor for class com.broadleafcommerce.tax.simple.SimpleTaxRecord
 

T

taxableAmount(MonetaryAmount) - Method in class com.broadleafcommerce.tax.domain.TaxDetail.TaxDetailBuilder
The amount that was taxable to determine the calculated tax.
TaxAccessor<T1 extends TaxRequest,T2 extends TaxResponse> - Interface in com.broadleafcommerce.tax
Provides a common interface for components whos job it is to interact with a 1st or 3rd party tax service or tax data, or whos job it is to delegate to such a component.
TaxAddress - Class in com.broadleafcommerce.tax.domain
An address used to determine taxes for a TaxRequest.
TaxAddress() - Constructor for class com.broadleafcommerce.tax.domain.TaxAddress
 
taxCalculated(MonetaryAmount) - Method in class com.broadleafcommerce.tax.domain.TaxDetail.TaxDetailBuilder
The calculated tax for this detail.
TaxCalculationGroup - Class in com.broadleafcommerce.tax.domain
 
TaxCalculationGroup() - Constructor for class com.broadleafcommerce.tax.domain.TaxCalculationGroup
 
TaxCalculationRequest - Class in com.broadleafcommerce.tax.domain
 
TaxCalculationRequest() - Constructor for class com.broadleafcommerce.tax.domain.TaxCalculationRequest
 
TaxCalculationResponse - Class in com.broadleafcommerce.tax.domain
 
TaxCalculationResponse() - Constructor for class com.broadleafcommerce.tax.domain.TaxCalculationResponse
 
TaxDelegate<T1 extends TaxRequest,T2 extends TaxResponse> - Interface in com.broadleafcommerce.tax.delegate
This class represents an object that delegates to the appropriate TaxProvider.
TaxDelegateProperties - Class in com.broadleafcommerce.tax.delegate
Properties to support the TaxDelegate configuration, especially the DefaultTaxDelegate.
TaxDelegateProperties() - Constructor for class com.broadleafcommerce.tax.delegate.TaxDelegateProperties
 
TaxDetail - Class in com.broadleafcommerce.tax.domain
Detailed tax information for a item, via TaxInfo.
TaxDetail() - Constructor for class com.broadleafcommerce.tax.domain.TaxDetail
 
TaxDetail(String, String, String, String, String, MonetaryAmount, BigDecimal, MonetaryAmount, String, Map<String, Object>, boolean, boolean) - Constructor for class com.broadleafcommerce.tax.domain.TaxDetail
 
TaxDetail.TaxDetailBuilder - Class in com.broadleafcommerce.tax.domain
 
TaxInfo - Class in com.broadleafcommerce.tax.domain
Tax information returned from a TaxProvider for a single line item.
TaxInfo() - Constructor for class com.broadleafcommerce.tax.domain.TaxInfo
 
taxInfos - Variable in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
The tax infos for each of the line items, keyed by fulfillmentGroupReferenceNumber + "-" + itemId.
taxInfos - Variable in class com.broadleafcommerce.tax.domain.TaxResponseGroup
The tax infos for each of the line items, keyed by fulfillmentGroupReferenceNumber + "-" + itemId.
TaxISOCountry - Class in com.broadleafcommerce.tax.domain
This domain object represents the ISO 3166 standard published by the International Organization for Standardization (ISO), and defines codes for the names of countries, dependent territories, and special areas of geographical interest.
TaxISOCountry() - Constructor for class com.broadleafcommerce.tax.domain.TaxISOCountry
 
TaxItem - Class in com.broadleafcommerce.tax.domain
An item to be taxed.
TaxItem() - Constructor for class com.broadleafcommerce.tax.domain.TaxItem
 
TaxItemType - Enum Class in com.broadleafcommerce.tax.domain.type
Designation used by TaxItems to specify what type of item they are such as Fulfillment or Order item.
taxName(String) - Method in class com.broadleafcommerce.tax.domain.TaxDetail.TaxDetailBuilder
The name of the tax.
TaxProvider<T1 extends TaxRequest,T2 extends TaxResponse> - Interface in com.broadleafcommerce.tax
Represents a component that is tasked with calculating taxes, or calling a 1st or 3rd party service to calculate taxes.
taxProviderDelegate(TaxDelegateProperties, List<TaxProvider<TaxRequest, TaxResponse>>, TypeFactory) - Method in class com.broadleafcommerce.tax.autoconfigure.TaxServiceAutoConfiguration
 
TaxRequest - Class in com.broadleafcommerce.tax.domain
Deprecated.
Please use TaxCalculationResponse or one of its subclasses.
TaxRequest() - Constructor for class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
 
TaxResponse - Class in com.broadleafcommerce.tax.domain
Deprecated.
Please use TaxCalculationResponse or one of its subclasses.
TaxResponse() - Constructor for class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
 
TaxResponseGroup - Class in com.broadleafcommerce.tax.domain
This represents of group of items whos taxes have been calculated together, typically with the same shipping address(es).
TaxResponseGroup() - Constructor for class com.broadleafcommerce.tax.domain.TaxResponseGroup
 
TaxServiceAutoConfiguration - Class in com.broadleafcommerce.tax.autoconfigure
 
TaxServiceAutoConfiguration() - Constructor for class com.broadleafcommerce.tax.autoconfigure.TaxServiceAutoConfiguration
 
toString() - Method in class com.broadleafcommerce.tax.domain.AdjustTaxTransactionRequest
 
toString() - Method in class com.broadleafcommerce.tax.domain.CommitTaxRequest
 
toString() - Method in class com.broadleafcommerce.tax.domain.CommitTaxResponse
 
toString() - Method in class com.broadleafcommerce.tax.domain.ReverseTaxTransactionRequest
 
toString() - Method in class com.broadleafcommerce.tax.domain.ReverseTaxTransactionResponse
 
toString() - Method in class com.broadleafcommerce.tax.domain.TaxAddress
 
toString() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationGroup
 
toString() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationRequest
 
toString() - Method in class com.broadleafcommerce.tax.domain.TaxCalculationResponse
 
toString() - Method in class com.broadleafcommerce.tax.domain.TaxDetail.TaxDetailBuilder
 
toString() - Method in class com.broadleafcommerce.tax.domain.TaxDetail
 
toString() - Method in class com.broadleafcommerce.tax.domain.TaxInfo
 
toString() - Method in class com.broadleafcommerce.tax.domain.TaxISOCountry
 
toString() - Method in class com.broadleafcommerce.tax.domain.TaxItem
 
toString() - Method in class com.broadleafcommerce.tax.domain.TaxRequest
Deprecated.
 
toString() - Method in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
 
toString() - Method in class com.broadleafcommerce.tax.domain.TaxResponseGroup
 
toString() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxConfig
 
toString() - Method in class com.broadleafcommerce.tax.simple.SimpleTaxRecord
 
totalAmount - Variable in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
The total amount of the items.
totalAmount - Variable in class com.broadleafcommerce.tax.domain.TaxResponseGroup
The total amount of the items.
totalExemption - Variable in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
The total amount that is not taxable from the items.
totalExemption - Variable in class com.broadleafcommerce.tax.domain.TaxResponseGroup
The total amount that is not taxable from the items.
totalTaxable - Variable in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
The total amount that is taxable from the items.
totalTaxable - Variable in class com.broadleafcommerce.tax.domain.TaxResponseGroup
The total amount that is taxable from the items.
totalTaxCalculated - Variable in class com.broadleafcommerce.tax.domain.TaxResponse
Deprecated.
The total tax calculated from all items.
totalTaxCalculated - Variable in class com.broadleafcommerce.tax.domain.TaxResponseGroup
The total tax calculated from all items.
transactionId(String) - Method in class com.broadleafcommerce.tax.domain.TaxDetail.TaxDetailBuilder
The transaction ID for this tax detail.

V

validate() - Method in class com.broadleafcommerce.tax.autoconfigure.LegacyTaxPropertiesValidator
 
validate(ContextInfo) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
validate(ContextInfo) - Method in interface com.broadleafcommerce.tax.TaxProvider
This can be used to determine if configurations, credential, and connections are correct and working properly together.
validateRequest(CommitTaxRequest, ContextInfo) - Method in class com.broadleafcommerce.tax.delegate.DefaultTaxDelegate
 
validateRequest(ReverseTaxTransactionRequest, ContextInfo) - Method in class com.broadleafcommerce.tax.delegate.DefaultTaxDelegate
 
validateRequest(TaxCalculationRequest, ContextInfo) - Method in class com.broadleafcommerce.tax.delegate.DefaultTaxDelegate
 
valueOf(String) - Static method in enum class com.broadleafcommerce.tax.domain.type.TaxItemType
Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.broadleafcommerce.tax.domain.type.TaxItemType
Returns an array containing the constants of this enum class, in the order they are declared.
voidTaxTransaction(VoidTransactionRequest, ContextInfo) - Method in class com.broadleafcommerce.tax.delegate.DefaultTaxDelegate
 
voidTaxTransaction(VoidTransactionRequest, ContextInfo) - Method in class com.broadleafcommerce.tax.simple.SimpleTaxProvider
 
voidTaxTransaction(VoidTransactionRequest, ContextInfo) - Method in interface com.broadleafcommerce.tax.TaxAccessor
Typically used in the case of full order cancellations.
VoidTransactionRequest - Class in com.broadleafcommerce.tax.domain
Represents a void of a tax transaction.
VoidTransactionRequest() - Constructor for class com.broadleafcommerce.tax.domain.VoidTransactionRequest
 
A B C D E F G H I J L O P R S T V 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form