Index (Broadleaf Order Common 1.4.0-GA API)

A C D E F G H I N O P S T V W

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
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

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.FulfillmentOption
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.Payment
canEqual(Object) - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
canEqual(Object) - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction
canEqual(Object) - Method in class com.broadleafcommerce.order.common.domain.Phone
canEqual(Object) - Method in class com.broadleafcommerce.order.common.domain.Voucher
com.broadleafcommerce.order.common.domain - package com.broadleafcommerce.order.common.domain
com.broadleafcommerce.order.common.domain.enums - package com.broadleafcommerce.order.common.domain.enums

D

DefaultAlternateAdjustmentSource - Enum in com.broadleafcommerce.order.common.domain.enums: The default alternate adjustment source names.
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.
DefaultTransactionManagementStates - Enum in com.broadleafcommerce.order.common.domain.enums: Describes how a transaction is being used, if it needs to be reversed, or if it has been reversed.
DefaultTransactionStatuses - Enum in com.broadleafcommerce.order.common.domain.enums

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.FulfillmentOption
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.Payment
equals(Object) - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
equals(Object) - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction
equals(Object) - Method in class com.broadleafcommerce.order.common.domain.Phone
equals(Object) - Method in class com.broadleafcommerce.order.common.domain.Voucher

F

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: Enumerates the types of fulfillment for a fulfillment group.

G

getAdditionalAttributes() - Method in class com.broadleafcommerce.order.common.domain.Address: Return any additional attributes passed in the request not matching any defined properties.
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.
getAdjustmentsTotal() - Method in class com.broadleafcommerce.order.common.domain.Payment: The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.
getAdjustmentsTotal() - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
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.Payment: The amount for which this payment is allotted.
getAmount() - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
getAmount() - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The amount related to this transaction.
getAmountAuthorized() - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary: The total authorized amount for capture.
getAmountCaptured() - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary: The total captured amount.
getAmountCredited() - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary: The total detached credit amount.
getAmountRefunded() - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary: The total refunded amount.
getAmountSettled() - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary: The total settled amount.
getAmountVoided() - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary: The total voided amount.
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.Payment: General use map to capture any additional attributes needed for this Payment
getAttributes() - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
getAttributes() - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: Map of specific attributes that have been gathered from the raw response.
getAuthor() - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail: The admin user who performed the override.
getBillingAddress() - Method in class com.broadleafcommerce.order.common.domain.Payment: The billing address associated with this payment.
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.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.
getCustomerIpAddress() - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The customer IP address that instigated this transaction
getCustomerPaymentAccountId() - Method in class com.broadleafcommerce.order.common.domain.Payment: The id of the customer's saved payment account that was used to build this payment object.
getDateRecorded() - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The timestamp when this transaction response was recorded
getDeclineType() - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The type of transaction failure (hard vs soft failure)
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.
getDisplayAttributes() - Method in class com.broadleafcommerce.order.common.domain.Payment: General use map to capture any display properties for this Payment
getDisplayAttributes() - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
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.
getExtension() - Method in class com.broadleafcommerce.order.common.domain.Phone: The internal extension for this phone.
getFailureType() - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The type of transaction failure
getFirstName() - Method in class com.broadleafcommerce.order.common.domain.Address: The first name of the individual at this address.
getFriendlyName() - Method in enum com.broadleafcommerce.order.common.domain.enums.PaymentTransactionAdditionalFieldType
getFulfillmentTotal() - Method in class com.broadleafcommerce.order.common.domain.Payment: The payment's total fulfillment cost
getFulfillmentTotal() - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
getFullName() - Method in class com.broadleafcommerce.order.common.domain.Address: The combined names of the individual at this address.
getGatewayResponseCode() - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The response code provided by the payment gateway which may represent a success or failure
getGatewayType() - Method in class com.broadleafcommerce.order.common.domain.Payment: The gateway used to process this payment.
getGatewayType() - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
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.
getId() - Method in class com.broadleafcommerce.order.common.domain.Payment: The id of this payment.
getId() - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The id of this payment transaction.
getIsSingleUsePaymentMethod() - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
getItemId() - Method in class com.broadleafcommerce.order.common.domain.OfferItemDetail: The id of the item that is a qualifier or target.
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.
getManagementState() - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The state of this transaction - e.g.
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.
getName() - Method in class com.broadleafcommerce.order.common.domain.Payment: The name of this payment.
getName() - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
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.
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.
getParentTransactionId() - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The id of the parent PaymentTransaction.
getPaymentGatewayProperties() - Method in class com.broadleafcommerce.order.common.domain.Payment: Map to capture any gateway-specific information needed to perform gateway transactions
getPaymentId() - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
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.
getQuantity() - Method in class com.broadleafcommerce.order.common.domain.OfferItemDetail: The quantity of the item that is a qualifier or target.
getRawResponse() - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The string representation of the serialized response from the gateway.
getReason() - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail: The reason the override was performed, for example, "Price Match".
getRequestId() - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The id used to represent the request that produced this transaction.
getShouldSavePaymentToCustomer() - Method in class com.broadleafcommerce.order.common.domain.Payment: Should the payment method be saved to the customer
getStateProvinceRegion() - Method in class com.broadleafcommerce.order.common.domain.Address: The state, province or region of this address.
getStatus() - Method in class com.broadleafcommerce.order.common.domain.Payment: Deprecated.
in favor of PaymentSummary
getStatus() - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The status of the transaction
getSubtotal() - Method in class com.broadleafcommerce.order.common.domain.Payment: The payment's total usually excluding adjustments, tax, and shipping.
getSubtotal() - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
getTaxCode() - Method in class com.broadleafcommerce.order.common.domain.FulfillmentOption: The tax code for this option.
getTaxTotal() - Method in class com.broadleafcommerce.order.common.domain.Payment: The payment's total tax cost
getTaxTotal() - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
getTransactionReferenceId() - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The transaction id known by the payment gateway.
getTransactions() - Method in class com.broadleafcommerce.order.common.domain.Payment: Transaction data representing each payment gateway interaction related to this payment.
getType() - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail: The type of override performed, e.g.
getType() - Method in class com.broadleafcommerce.order.common.domain.Payment: The type of this payment like Credit Card or Gift Card.
getType() - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The type of this transaction (authorize, capture, refund, etc.)
getUserId() - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail: The user ID of the admin user who performed the override.
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.FulfillmentOption
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.Payment
hashCode() - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
hashCode() - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction
hashCode() - Method in class com.broadleafcommerce.order.common.domain.Phone
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.
isArchived() - Method in class com.broadleafcommerce.order.common.domain.Payment: Whether or not this payment has been archived.
isAvailableForGeneralUse(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultTransactionManagementStates
isCheckoutComplete(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultTransactionManagementStates
isCheckoutInProgress(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultTransactionManagementStates
isDefault() - Method in class com.broadleafcommerce.order.common.domain.Address: Whether this address is the default address of the owner.
isFailedReversal(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultTransactionManagementStates
isFailure(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultTransactionStatuses
isGenerationSuccessful() - Method in class com.broadleafcommerce.order.common.domain.Voucher: Indicates whether the post-checkout voucher code generation was successful.
isIndeterminateResult() - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: Tells if this transaction has an indeterminate result.
isRequires3DSVerification(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultTransactionStatuses
isRequiresReversal(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultTransactionManagementStates
isReversalInProgress(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultTransactionManagementStates
isReversalTransaction(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultTransactionManagementStates
isReversed(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultTransactionManagementStates
isReversedOrReversalTransaction(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultTransactionManagementStates
isSendingToProcessor(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultTransactionStatuses
isSingleUsePaymentMethod() - Method in class com.broadleafcommerce.order.common.domain.Payment: Whether or not the underlying payment method can only be used once.
isSuccess(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultTransactionStatuses
isTaxable() - Method in class com.broadleafcommerce.order.common.domain.FulfillmentOption: Whether any shipping prices should be taxable for this option.
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.

N

name() - Method in interface com.broadleafcommerce.order.common.domain.enums.TransactionManagementState
name() - Method in interface com.broadleafcommerce.order.common.domain.enums.TransactionStatus

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

Payment - Class in com.broadleafcommerce.order.common.domain: This entity is designed to store payment methods associated to a Cart, the Payment.getAmount() the user is to be charged via that payment method, and the history of attempted transactions (authorizations, charges, refunds, etc.) against that payment method for the owning Cart.
Payment() - Constructor for class com.broadleafcommerce.order.common.domain.Payment
PaymentSummary - Class in com.broadleafcommerce.order.common.domain: The domain that summarizes the current state of transactions against the payment.
PaymentSummary() - Constructor for class com.broadleafcommerce.order.common.domain.PaymentSummary
PaymentTransaction - Class in com.broadleafcommerce.order.common.domain: Used to store individual transactions about a particular payment.
PaymentTransaction() - Constructor for class com.broadleafcommerce.order.common.domain.PaymentTransaction
PaymentTransactionAdditionalFieldType - Enum in com.broadleafcommerce.order.common.domain.enums
Phone - Class in com.broadleafcommerce.order.common.domain
Phone() - Constructor for class com.broadleafcommerce.order.common.domain.Phone

S

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.
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.
setAdjustmentsTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.Payment: The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.
setAdjustmentsTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
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.Payment: The amount for which this payment is allotted.
setAmount(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
setAmount(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The amount related to this transaction.
setAmountAuthorized(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary: The total authorized amount for capture.
setAmountCaptured(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary: The total captured amount.
setAmountCredited(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary: The total detached credit amount.
setAmountRefunded(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary: The total refunded amount.
setAmountSettled(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary: The total settled amount.
setAmountVoided(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary: The total voided amount.
setArchived(boolean) - Method in class com.broadleafcommerce.order.common.domain.Payment: Whether or not this payment has been archived.
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, String>) - Method in class com.broadleafcommerce.order.common.domain.Payment: General use map to capture any additional attributes needed for this Payment
setAttributes(Map<String, String>) - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
setAttributes(Map<String, String>) - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: Map of specific attributes that have been gathered from the raw response.
setAuthor(String) - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail: The admin user who performed the override.
setBillingAddress(Address) - Method in class com.broadleafcommerce.order.common.domain.Payment: The billing address associated with this payment.
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.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.
setCustomerIpAddress(String) - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The customer IP address that instigated this transaction
setCustomerPaymentAccountId(String) - Method in class com.broadleafcommerce.order.common.domain.Payment: The id of the customer's saved payment account that was used to build this payment object.
setDateRecorded(Instant) - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The timestamp when this transaction response was recorded
setDeclineType(String) - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The type of transaction failure (hard vs soft failure)
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.
setDisplayAttributes(Map<String, String>) - Method in class com.broadleafcommerce.order.common.domain.Payment: General use map to capture any display properties for this Payment
setDisplayAttributes(Map<String, String>) - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
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.
setExtension(String) - Method in class com.broadleafcommerce.order.common.domain.Phone: The internal extension for this phone.
setFailureType(String) - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The type of transaction failure
setFirstName(String) - Method in class com.broadleafcommerce.order.common.domain.Address: The first name of the individual at this address.
setFulfillmentTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.Payment: The payment's total fulfillment cost
setFulfillmentTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
setFullName(String) - Method in class com.broadleafcommerce.order.common.domain.Address: The combined names of the individual at this address.
setGatewayResponseCode(String) - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The response code provided by the payment gateway which may represent a success or failure
setGatewayType(String) - Method in class com.broadleafcommerce.order.common.domain.Payment: The gateway used to process this payment.
setGatewayType(String) - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
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.
setId(String) - Method in class com.broadleafcommerce.order.common.domain.Payment: The id of this payment.
setId(String) - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The id of this payment transaction.
setIndeterminateResult(boolean) - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: Tells if this transaction has an indeterminate result.
setIsSingleUsePaymentMethod(Boolean) - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
setItemId(String) - Method in class com.broadleafcommerce.order.common.domain.OfferItemDetail: The id of the item that is a qualifier or target.
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.
setManagementState(String) - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The state of this transaction - e.g.
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.
setName(String) - Method in class com.broadleafcommerce.order.common.domain.Payment: The name of this payment.
setName(String) - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
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.
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.
setParentTransactionId(String) - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The id of the parent PaymentTransaction.
setPaymentGatewayProperties(Map<String, String>) - Method in class com.broadleafcommerce.order.common.domain.Payment: Map to capture any gateway-specific information needed to perform gateway transactions
setPaymentId(String) - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
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.
setQuantity(int) - Method in class com.broadleafcommerce.order.common.domain.OfferItemDetail: The quantity of the item that is a qualifier or target.
setRawResponse(String) - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The string representation of the serialized response from the gateway.
setReason(String) - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail: The reason the override was performed, for example, "Price Match".
setRequestId(String) - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The id used to represent the request that produced this transaction.
setShouldSavePaymentToCustomer(boolean) - Method in class com.broadleafcommerce.order.common.domain.Payment: Should the payment method be saved to the customer
setSingleUsePaymentMethod(boolean) - Method in class com.broadleafcommerce.order.common.domain.Payment: Whether or not the underlying payment method can only be used once.
setStateProvinceRegion(String) - Method in class com.broadleafcommerce.order.common.domain.Address: The state, province or region of this address.
setStatus(String) - Method in class com.broadleafcommerce.order.common.domain.Payment: Deprecated.
in favor of PaymentSummary
setStatus(String) - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The status of the transaction
setSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.Payment: The payment's total usually excluding adjustments, tax, and shipping.
setSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
setTaxable(boolean) - Method in class com.broadleafcommerce.order.common.domain.FulfillmentOption: Whether any shipping prices should be taxable for this option.
setTaxCode(String) - Method in class com.broadleafcommerce.order.common.domain.FulfillmentOption: The tax code for this option.
setTaxTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.Payment: The payment's total tax cost
setTaxTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
setTransactionReferenceId(String) - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The transaction id known by the payment gateway.
setTransactions(List<PaymentTransaction>) - Method in class com.broadleafcommerce.order.common.domain.Payment: Transaction data representing each payment gateway interaction related to this payment.
setType(String) - Method in class com.broadleafcommerce.order.common.domain.OverrideDetail: The type of override performed, e.g.
setType(String) - Method in class com.broadleafcommerce.order.common.domain.Payment: The type of this payment like Credit Card or Gift Card.
setType(String) - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: The type of this transaction (authorize, capture, refund, etc.)
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.
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.

T

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.FulfillmentOption
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.Payment
toString() - Method in class com.broadleafcommerce.order.common.domain.PaymentSummary
toString() - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction
toString() - Method in class com.broadleafcommerce.order.common.domain.Phone
toString() - Method in class com.broadleafcommerce.order.common.domain.Voucher
TransactionManagementState - Interface in com.broadleafcommerce.order.common.domain.enums: Describes the state of a PaymentTransaction - e.g.
TransactionStatus - Interface in com.broadleafcommerce.order.common.domain.enums

V

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.DefaultOverrideTypes: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultTransactionManagementStates: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.DefaultTransactionStatuses: 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.
valueOf(String) - Static method in enum com.broadleafcommerce.order.common.domain.enums.PaymentTransactionAdditionalFieldType: Returns the enum constant of this type with the specified name.
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.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.DefaultTransactionManagementStates: 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.DefaultTransactionStatuses: 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.
values() - Static method in enum com.broadleafcommerce.order.common.domain.enums.PaymentTransactionAdditionalFieldType: Returns an array containing the constants of this enum type, in the order they are declared.
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

W

wasSuccessful() - Method in class com.broadleafcommerce.order.common.domain.PaymentTransaction: Whether or not this transaction was successful based on getStatus().

A C D E F G H I N O P S T V W