Index (Order Services Client 2.0.3-GA API)

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

B

BLC_CART - Enum constant in enum class com.broadleafcommerce.order.client.domain.enums.DefaultCartTypes: The cart type means that the order came from the BLC cart.

C

CANCELLED - Enum constant in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus: Indicates that the fulfillment has been cancelled.
CANCELLED - Enum constant in enum class com.broadleafcommerce.order.client.domain.ReturnAuthorizationStatus: Indicates that the return has been cancelled, and should not be processed further.
canEqual(Object) - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim
canEqual(Object) - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary
canEqual(Object) - Method in class com.broadleafcommerce.order.client.domain.ImageAssetRef
canEqual(Object) - Method in class com.broadleafcommerce.order.client.domain.Order
canEqual(Object) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment
canEqual(Object) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem
canEqual(Object) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail
canEqual(Object) - Method in class com.broadleafcommerce.order.client.domain.OrderItem
canEqual(Object) - Method in class com.broadleafcommerce.order.client.domain.OrderPricing
canEqual(Object) - Method in class com.broadleafcommerce.order.client.domain.payment.PaymentDistributionDetail
canEqual(Object) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization
canEqual(Object) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem
canEqual(Object) - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation
canEqual(Object) - Method in class com.broadleafcommerce.order.client.domain.Shipment
CAPTURE - Enum constant in enum class com.broadleafcommerce.order.client.domain.enums.DefaultFulfillmentCaptureClaimTypes: Deprecated.

Identifies that the FulfillmentCaptureClaim represents a new capture for an OrderFulfillment.
CAPTURE_AWAITING_RESULT - Enum constant in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus: Indicates that the fulfillment payment is sent to the payment gateway but awaiting transaction result.
CAPTURING_PAYMENT - Enum constant in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus: Indicates that the fulfillment payment is currently being captured.
CartType - Interface in com.broadleafcommerce.order.client.domain.enums: Describes the type of Cart.
CLAIM - Enum constant in enum class com.broadleafcommerce.order.client.domain.enums.DefaultFulfillmentCaptureClaimTypes: Deprecated.

Identifies that the FulfillmentCaptureClaim represents a claim against a previously-executed capture for an OrderFulfillment.
COD_FEE - Enum constant in enum class com.broadleafcommerce.order.client.domain.enums.DefaultOrderItemTypes: Represents a fee applied to the cart for Collect on Delivery.
com.broadleafcommerce.order.client.domain - package com.broadleafcommerce.order.client.domain
com.broadleafcommerce.order.client.domain.enums - package com.broadleafcommerce.order.client.domain.enums
com.broadleafcommerce.order.client.domain.payment - package com.broadleafcommerce.order.client.domain.payment
COMPLETED - Enum constant in enum class com.broadleafcommerce.order.client.domain.ReturnAuthorizationStatus: Indicates that the return is in a completed state.
COMPLETED - Enum constant in enum class com.broadleafcommerce.order.client.domain.ReturnConfirmationStatus: Indicates that the return confirmation is completely confirmed.
CONFIRMED - Enum constant in enum class com.broadleafcommerce.order.client.domain.ReturnAuthorizationStatus: Indicates that the items have been received or otherwise confirmed.

D

DefaultCartTypes - Enum Class in com.broadleafcommerce.order.client.domain.enums
DefaultFulfillmentCaptureClaimSummaryDiscriminatorTypes - Enum Class in com.broadleafcommerce.order.client.domain.enums
DefaultFulfillmentCaptureClaimTypes - Enum Class in com.broadleafcommerce.order.client.domain.enums: Deprecated, for removal: This API element is subject to removal in a future version.
In favor of using the TransactionSummary concept from PaymentTransactionServices, instead of recording captured amounts for fulfillments in the FulfillmentCaptureClaim structure.
DefaultOrderItemTypes - Enum Class in com.broadleafcommerce.order.client.domain.enums: The default order item types.
DefaultReturnAuthorizationItemReturnTypes - Enum Class in com.broadleafcommerce.order.client.domain: Default values for ReturnAuthorizationItem.getReturnType().

E

equals(Object) - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim
equals(Object) - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary
equals(Object) - Method in class com.broadleafcommerce.order.client.domain.ImageAssetRef
equals(Object) - Method in class com.broadleafcommerce.order.client.domain.Order
equals(Object) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment
equals(Object) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem
equals(Object) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail
equals(Object) - Method in class com.broadleafcommerce.order.client.domain.OrderItem
equals(Object) - Method in class com.broadleafcommerce.order.client.domain.OrderPricing
equals(Object) - Method in class com.broadleafcommerce.order.client.domain.payment.PaymentDistributionDetail
equals(Object) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization
equals(Object) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem
equals(Object) - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation
equals(Object) - Method in class com.broadleafcommerce.order.client.domain.Shipment
EXTRA_FEE - Enum constant in enum class com.broadleafcommerce.order.client.domain.enums.DefaultOrderItemTypes: Represents a fee applied to the order such as for Collect on Delivery or other payment options.

F

FULFILL_FAILED - Enum constant in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus: Indicates that the fulfillment failed to be fulfilled.
FULFILLED - Enum constant in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus: Indicates that the fulfillment has been fulfilled.
FULFILLING - Enum constant in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus: Indicates that the fulfillment is in the process of being fulfilled.
FulfillmentCaptureClaim - Class in com.broadleafcommerce.order.client.domain: Domain used to represent an payment is captured for an OrderFulfillment, or when a previously-captured amount (typically from an AuthorizeAndCapture transaction executed during checkout) is claimed for an OrderFulfillment.
FulfillmentCaptureClaim() - Constructor for class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim
FulfillmentCaptureClaimSummary - Class in com.broadleafcommerce.order.client.domain: Domain that summarizes the current state of capture transaction claims for a single fulfillment or payment.
FulfillmentCaptureClaimSummary() - Constructor for class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary

G

getAccountHierarchy() - Method in class com.broadleafcommerce.order.client.domain.Order: The hierarchy of accounts, from the root account to the account member's account.
getAccountId() - Method in class com.broadleafcommerce.order.client.domain.Order: The ID of the account the account member belongs to.
getActualCondition() - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The actual condition of the returned item received.
getAdditionalAttributes() - Method in class com.broadleafcommerce.order.client.domain.payment.PaymentDistributionDetail: General use map to capture any additional attributes needed for this detail.
getAdditionalShipments() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: All additional shipment details for this fulfillment.
getAddress() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The shipping address for this fulfillment.
getAdjustments() - Method in class com.broadleafcommerce.order.client.domain.Order: Adjustments to order pricing that were applied to OrderPricing.getSubtotal().
getAdjustments() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: Adjustments to fulfillment pricing that should be applied to OrderFulfillment.getFulfillmentCharge().
getAdjustmentsTotal() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The total adjustment price for all adjustments of an OrderItem.
getAdjustmentsTotal() - Method in class com.broadleafcommerce.order.client.domain.OrderPricing
getAltText() - Method in class com.broadleafcommerce.order.client.domain.ImageAssetRef: Text that corresponds to the HTML alt attribute that should be used when this asset is rendered in a browser.
getAmount() - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim: The amount that has been captured or claimed by the fulfillment against the payment.
getApproverEmail() - Method in class com.broadleafcommerce.order.client.domain.Order: The order approver's email address.
getAttributeChoices() - Method in class com.broadleafcommerce.order.client.domain.Order: Attribute choices for this order driven by its items' product options, where each key is the attributeName from an attribute choice.
getAttributeChoices() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: Attribute choices for this item driven by product options, where each key is the attributeName from an attribute choice.
getAttributes() - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim: Additional attributes for this claim.
getAttributes() - Method in class com.broadleafcommerce.order.client.domain.Order: Miscellaneous attributes for this order.
getAttributes() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: Additional attributes for this order fulfillment.
getAttributes() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: Miscellaneous attributes for this fulfillment item.
getAttributes() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: Additional attributes for this tax detail.
getAttributes() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: Miscellaneous attributes for this item.
getBrandId() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The id to the corresponding data driven enum for this item's product's brand.
getCampaignRefs() - Method in class com.broadleafcommerce.order.client.domain.Order: A list of campaign references that are attached to this order.
getCartCreateDate() - Method in class com.broadleafcommerce.order.client.domain.Order: The date that the originating cart was first created.
getCartId() - Method in class com.broadleafcommerce.order.client.domain.Order: The context ID of the original cart for this order.
getCartType() - Method in class com.broadleafcommerce.order.client.domain.Order: Returns the cart type or DefaultCartTypes.BLC_CART if null.
getCategoryIds() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The ids to the corresponding categories for this item's product.
getCheckoutRequestId() - Method in class com.broadleafcommerce.order.client.domain.Order: The id of the latest checkout request for the originating cart.
getClaims() - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary: The list of FulfillmentCaptureClaims for the OrderFulfillment.
getConfirmations() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The portions of this item which have been confirmed as returned.
getContentUrl() - Method in class com.broadleafcommerce.order.client.domain.ImageAssetRef: The fully-resolvable content-URL to the binary data of the asset.
getContextState() - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim: A subset of Tracking information to expose the context state for this object.
getContextState() - Method in class com.broadleafcommerce.order.client.domain.Order: A subset of Tracking information to expose the context state for this object.
getContextState() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: A subset of Tracking information to expose the context state for this object.
getContextState() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: A subset of Tracking information to expose the context state for this object.
getContextState() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: A subset of Tracking information to expose the context state for this object.
getCountry() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The 2 digit country code.
getCurrency() - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim: The currency unit used for monetary amounts.
getCurrency() - Method in class com.broadleafcommerce.order.client.domain.Order
getCurrency() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The currency unit used for the pricing of this OrderFulfillment.
getCurrency() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The currency for this tax detail.
getCurrency() - Method in class com.broadleafcommerce.order.client.domain.OrderItem
getCurrency() - Method in class com.broadleafcommerce.order.client.domain.OrderPricing: The currency unit used for the pricing of this Order.
getCurrency() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The currency unit used for monetary amounts.
getCustomerId() - Method in class com.broadleafcommerce.order.client.domain.Order: The ID of the customer that owns this order.
getCustomerName() - Method in class com.broadleafcommerce.order.client.domain.Order: The name of the customer that owns this order.
getDependentOrderItems() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: OrderItems that depend on this OrderItem.
getDiscriminatorId() - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary: The id of the discriminating entity for filtering the claims, usually the id of the order fulfillment or payment.
getDiscriminatorType() - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary: The type of discriminating entity for filtering the claims, usually order fulfillment or payment.
getEmailAddress() - Method in class com.broadleafcommerce.order.client.domain.Order: The customer's email address.
getEstimatedFulfillmentTotalToRefund() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The estimated fulfillment total which can be refunded.
getEstimatedFulfillmentTotalToRefund() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The estimated fulfillment total which can be refunded.
getEstimatedMerchandiseTotalToRefund() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The estimated merchandise total which can be refunded.
getEstimatedMerchandiseTotalToRefund() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The estimated merchandise total which can be refunded.
getEstimatedReturnShippingCharge() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The estimated charge to the customer to ship back the items to return.
getEstimatedTaxTotalToRefund() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The estimated tax total which can be refunded.
getEstimatedTaxTotalToRefund() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The estimated tax total which can be refunded.
getEstimatedTotalToRefund() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The estimated grand total which can be refunded.
getEstimatedTotalToRefund() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The estimated grand total which can be refunded.
getExpectedCondition() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The condition of the item expected when returned.
getExternalId() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: Intended to hold any unique identifier for this fulfillment as assigned by an external system.
getFeesTotal() - Method in class com.broadleafcommerce.order.client.domain.OrderPricing: The total fees of this Order.
getFulfillmentAdjustments() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: Adjustments to item fulfillment pricing that should be applied to the total of OrderFulfillmentItem.unitFulfillmentCharge.
getFulfillmentAdjustmentsTotal() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: Sum of the fulfillment's adjustments.
getFulfillmentAdjustmentsTotal() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The total of all the item fulfillment adjustments for this item.
getFulfillmentCharge() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The shipping charge for this fulfillment before adjustments are applied.
getFulfillmentItem() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The fulfillment item for this tax detail
getFulfillmentItems() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: Items within this fulfillment, each of which should relate back to a OrderItem.
getFulfillmentOption() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The fulfillment option chosen for the OrderFulfillment.getType().
getFulfillmentRefundAmount() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The fulfillment amount to refund when this item is returned, note that prorated fulfillment group adjustments are included.
getFulfillmentTotal() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The total shipping price of this fulfillment, including adjustments and item shipping prices.
getFulfillmentTotal() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The total fulfillment price of this item, including adjustments.
getFulfillmentTotal() - Method in class com.broadleafcommerce.order.client.domain.OrderPricing: The total fulfillment price of this Order, including adjustments.
getFulfillmentTotalRefunded() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The fulfillment total which has been refunded.
getFulfillmentTotalToRefund() - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The fulfillment total which can be refunded.
getGrandTotal() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The grand total of this fulfillment, including merchandise costs, all shipping costs including items, and tax.
getGroupReferenceNumber() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The reference number of the FulfillmentGroup this fulfillment was created from.
getId() - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim: The context ID of this claim.
getId() - Method in class com.broadleafcommerce.order.client.domain.Order: The context ID of the order.
getId() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The unique identifier for this fulfillment.
getId() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The context ID of this fulfillment item.
getId() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The database id
getId() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The context ID of the order.
getId() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The context ID of the return authorization.
getId() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The id of this return authorization item.
getId() - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The id of this return confirmation.
getImageAsset() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The image asset for this item, usually sourced from the product.
getIncludedFulfillmentTax() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The amount of fulfillment taxes that are included in the item subtotal (VAT).
getIncludedFulfillmentTax() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The amount of fulfillment taxes that are included in the item subtotal (VAT).
getIncludedMerchandiseTax() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The amount of merchandise taxes that are included in the item subtotal (VAT).
getIncludedMerchandiseTax() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The amount of merchandise taxes that are included in the item subtotal (VAT).
getIncludedTaxAmount() - Method in class com.broadleafcommerce.order.client.domain.OrderPricing: The amount of taxes that are included in the subtotal (VAT).
getInternalAttributes() - Method in class com.broadleafcommerce.order.client.domain.Order: Miscellaneous internal attributes for this item.
getInternalAttributes() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: Miscellaneous internal attributes for this fulfillment item.
getInternalAttributes() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: Miscellaneous internal attributes for this item.
getInventoryCheckStrategy() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The inventory check strategy of the item.
getInventoryLocationReference() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: This is an optional field where the ID or reference number of the expected InventoryLocation is stored.
getInventoryReservationStrategy() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The reservation strategy of the item.
getItemAdjustments() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: Adjustments to item pricing that should be applied to getSubtotal().
getItemMerchandiseSubtotal() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: Sum up the OrderFulfillmentItem#merchandiseTotalAmount across all of the fulfillment's items.
getItems() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The items which are being returned.
getItemTotal() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The total amount attributed to this fulfillment item.
getJurisdictionName() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The tax jurisdiction name.
getJurisdictionType() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The jurisdiction type, e.g.
getLocale() - Method in class com.broadleafcommerce.order.client.domain.Order: The locale for this order.
getMerchandiseAdjustmentsTotal() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The total of all the item adjustments for the merchandise.
getMerchandiseRefundAmount() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The merchandise amount to refund when this item is returned, note that prorated order adjustments are included.
getMerchandiseSubtotal() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The OrderFulfillmentItem.unitMerchandisePrice multiplied by OrderFulfillmentItem.quantity.
getMerchandiseTaxTotal() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The total tax of the item merchandise based on the price of the related OrderItem.
getMerchandiseTotal() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The merchandise total for all items in the fulfillment, including item adjustments and prorated order adjustments.
getMerchandiseTotal() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The merchandise total for the item quantity, including OrderFulfillmentItem.merchandiseSubtotal and item OrderFulfillmentItem.merchandiseAdjustmentsTotal.
getMerchandiseTotalRefunded() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The merchandise total which has been refunded.
getMerchandiseTotalToRefund() - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The merchandise total which can be refunded.
getMerchandisingContext() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: Defines the merchandising context of the item to signify where it is added from.
getMerchandisingTypeId() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The id to the corresponding data driven enum for this item's product's merchandising type.
getName() - Method in class com.broadleafcommerce.order.client.domain.Order: A unique name for the order, used for retrieval.
getName() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The name of this item.
getNonIncludedFulfillmentTax() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The amount of fulfillment taxes that are not included in the item subtotal.
getNonIncludedMerchandiseTax() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The amount of merchandise taxes that are not included in the item subtotal.
getNonIncludedTaxTotal() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The total amount of taxes that are not included in the item subtotal.
getNote() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: An optional note containing extra information about the item being returned.
getNote() - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: An optional note containing extra information about the item being returned.
getOfferCodes() - Method in class com.broadleafcommerce.order.client.domain.Order: A list of offer codes that were added to this order.
getOrder() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The owning order of this item.
getOrderFulfillment() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The owning order fulfillment of this item.
getOrderFulfillmentId() - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim: The context ID of the order fulfillment.
getOrderFulfillmentItemId() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The context ID of the OrderFulfillmentItem being returned.
getOrderFulfillmentNumber() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The number for this individual fulfillment, unique within the order.
getOrderId() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: A soft reference to the parent Order this fulfillment belongs to.
getOrderId() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The context ID of the order from which items are returned.
getOrderItemId() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The id of the OrderItem to be represented by this fulfillment item.
getOrderItems() - Method in class com.broadleafcommerce.order.client.domain.Order: Items that are contained within this order.
getOrderItemsWithDependentItems() - Method in class com.broadleafcommerce.order.client.domain.Order
getOrderMerchandiseAdjustmentsTotal() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: Total up the OrderFulfillmentItem.proratedOrderAdjustments for all the items in the fulfillment.
getOrderNumber() - Method in class com.broadleafcommerce.order.client.domain.Order: The unique number associated with this Order.
getOrderPricing() - Method in class com.broadleafcommerce.order.client.domain.Order: Embedded container for all pricing information on this order.
getOverrideDetails() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: List of details about any price overrides which have been performed on this fulfillment.
getOverrideDetails() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: List of details about any price overrides which have been performed on this item.
getOverrideTotalToRefund() - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The overridden grand total to refund.
getOwnerIdentifier() - Method in class com.broadleafcommerce.order.client.domain.Order
getPaymentDisplayType() - Method in class com.broadleafcommerce.order.client.domain.payment.PaymentDistributionDetail: The type of the payment.
getPaymentDistributionDetails() - Method in class com.broadleafcommerce.order.client.domain.Order: A list of PaymentDistributionDetails representing how this order's total is split across different payments.
getPaymentId() - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim: The context ID of the payment that the claimed transaction belongs to.
getPaymentId() - Method in class com.broadleafcommerce.order.client.domain.payment.PaymentDistributionDetail: The id of the payment.
getPricedFulfillmentOption() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The PricedFulfillmentOption chosen for the OrderFulfillment.getType().
getPricedFulfillmentOption() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The PricedFulfillmentOption chosen for this item.
getPriceListId() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The id of the price list used to get the pricing for this OrderItem.
getPricingStrategy() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The pricing strategy for this item.
getPrimaryReturnReason() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The primary reason for the return.
getProductId() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The id to the corresponding product for this item.
getProductTags() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The list of simple labels used to categorize the corresponding product for this item.
getProratedFulfillmentCharge() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The prorated shipping charge for this fulfillment item before adjustments are applied, derived from the FulfillmentGroup.getGroupFulfillmentPriceBeforeAdjustments().
getProratedOrderAdjustments() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The amount prorated to this item from order adjustments.
getProratedOrderAdjustments() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The amount prorated to this item from order adjustments.
getProratedOrderFulfillmentAdjustments() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: Prorated amount of the fulfillment adjustments that applies to the OrderFulfillment.fulfillmentCharge.
getProratedOrderFulfillmentAdjustments() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The amount prorated to this item from order fulfillment adjustments.
getQuantity() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The quantity of the item to be fulfilled by this fulfillment.
getQuantity() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The number of this item in the Order.
getQuantity() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The quantity of the item being returned.
getQuantity() - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The quantity of the item which was returned.
getRate() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The tax rate
getRatio() - Method in class com.broadleafcommerce.order.client.domain.payment.PaymentDistributionDetail: The percentage of the order total that is distributed to this payment, represented as a decimal.
getRecurringAdjustmentsTotalWithDependentItems() - Method in class com.broadleafcommerce.order.client.domain.OrderItem
getRecurringPeriodTypeWithDependentItems() - Method in class com.broadleafcommerce.order.client.domain.OrderItem
getRecurringPrice() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: This is the recurring price if any from the same source as the unitPrice.
getRecurringPriceTypeOverride() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: Overrides unitPriceType for the recurringPrice in cases where they must diverge.
getRecurringPriceWithDependentItems() - Method in class com.broadleafcommerce.order.client.domain.OrderItem
getRecurringSubtotalWithDependentItems() - Method in class com.broadleafcommerce.order.client.domain.OrderItem
getRecurringTotalWithDependentItems() - Method in class com.broadleafcommerce.order.client.domain.OrderItem
getReferenceNumber() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The reference number for this fulfillment item.
getRefundAmount() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The pre-calculated merchandise amount to refund when this OrderItem is returned.
getRegion() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The region that this tax was calculated.
getRequestId() - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim: The id representing the request to claim/execute one or more transactions.
getReturnShippingCharged() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The amount charged to the customer to ship back the items to return.
getReturnType() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The type of the return, indicating how it should be processed.
getRootAccountId() - Method in class com.broadleafcommerce.order.client.domain.Order: The ID of the root account the account member belongs to.
getSecondaryReturnReason() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The secondary reason for the return, providing more detail in addition to the ReturnAuthorizationItem.primaryReturnReason.
getShipDate() - Method in class com.broadleafcommerce.order.client.domain.Shipment: The date the shipment was shipped.
getShipment() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The primary shipment details for this fulfillment.
getShipperType() - Method in class com.broadleafcommerce.order.client.domain.Shipment: The shipper responsible for the shipment, for example a carrier.
getSku() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: Represents a SKU code, similar to productId or variantId, except this is a unified, unique concept across both products and variants.
getSortName() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: Pseudo name for this tax detail, representing a combination of several items, used for sorting purposes.
getStatus() - Method in class com.broadleafcommerce.order.client.domain.Order: The status of this order.
getStatus() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The status of this fulfillment.
getStatus() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The status of the return.
getStatus() - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The status of the returned item.
getSubmitDate() - Method in class com.broadleafcommerce.order.client.domain.Order: The date that this order was submitted.
getSubtotal() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The subtotal price of this OrderItem.
getSubtotal() - Method in class com.broadleafcommerce.order.client.domain.OrderPricing: The subtotal price of this Order.
getTargetDemographicId() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The id to the corresponding data driven enum for this item's product's target demographic.
getTaxableAmount() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The amount that was taxable to determine the calculated tax.
getTaxCalculated() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The amount of taxes calculated.
getTaxDetails() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The tax details for this fulfillment item.
getTaxIncludedType() - Method in class com.broadleafcommerce.order.client.domain.OrderPricing: Indicates if any taxes are included in the subtotal.
getTaxName() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The tax name for this tax detail.
getTaxTotal() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The total tax of this fulfillment, including merchandise and fulfillment tax.
getTaxTotalRefunded() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The tax total which has been refunded.
getTaxTotalToRefund() - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The tax total which can be refunded.
getTermDurationLength() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The length of the terms, e.g., if this is 36 and termDurationType is MONTHS, then the recurringPrice should be charged for 36 months.
getTermDurationType() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The term duration type, e.g.
getTitle() - Method in class com.broadleafcommerce.order.client.domain.ImageAssetRef: Text that corresponds to the HTML title attribute that should be used when this asset is rendered in a browser.
getTotal() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The total price of this OrderItem.
getTotal() - Method in class com.broadleafcommerce.order.client.domain.OrderPricing: The total price of this Order.
getTotalAmountCaptured() - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary: Deprecated.
In favor of using the TransactionSummary concept from PaymentTransactionServices to understand the amount captured for a fulfillment, instead of recording captured amounts for fulfillments in the FulfillmentCaptureClaim structure.
getTotalAmountClaimed() - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary: Total amount claimed.
getTotalFailedToRefund() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The grand total which has failed to be refunded.
getTotalFailedToRefund() - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The grand total which has failed to be refunded.
getTotalRefundAwaitingResult() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The grand total of refund that is awaiting result.
getTotalRefundAwaitingResult() - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The grand total of refund that is awaiting result.
getTotalRefunded() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The grand total which has been refunded.
getTotalRefunded() - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The estimated grand total which has been refunded.
getTotalTax() - Method in class com.broadleafcommerce.order.client.domain.OrderPricing: The total tax amount for this Order.
getTotalToRefund() - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The grand total which can be refunded.
getTrackingNumber() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: Optional tracking number for the return shipment of items.
getTrackingNumber() - Method in class com.broadleafcommerce.order.client.domain.Shipment: The tracking number for this shipment.
getTrackingUrl() - Method in class com.broadleafcommerce.order.client.domain.Shipment: The URL to the tracking page for this shipment.
getTransactionId() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The transaction ID for this tax detail.
getType() - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim: Deprecated.
In favor of using the TransactionSummary concept from PaymentTransactionServices, instead of recording captured amounts for fulfillments in the FulfillmentCaptureClaim structure.
getType() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The type of means by which this fulfillment is fulfilled.
getType() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The type of this item.
getUnitFulfillmentCharge() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The unit shipping charge of each item before adjustments are applied.
getUnitMerchandisePrice() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The individual unit price for the merchandise.
getUnitPrice() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The individual unit price for an OrderItem.
getUnitPriceType() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The type of the unit price for an OrderItem.
getUri() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The navigable uri of the corresponding catalog entry (e.g.
getUsagePrice() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: This is the usage price if any from the same source as the unitPrice.
getVariantId() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The id to the corresponding variant for this item.
getVendorRef() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: A reference to the corresponding vendor for this fulfillment.
getVendorRef() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: A reference to the corresponding vendor for this item.
getVersion() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The version of this OrderFulfillment.
getVersion() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The version of this ReturnAuthorization.
getVouchers() - Method in class com.broadleafcommerce.order.client.domain.Order: A list of Vouchers that this order is qualified for.

H

hashCode() - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim
hashCode() - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary
hashCode() - Method in class com.broadleafcommerce.order.client.domain.ImageAssetRef
hashCode() - Method in class com.broadleafcommerce.order.client.domain.Order
hashCode() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment
hashCode() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem
hashCode() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail
hashCode() - Method in class com.broadleafcommerce.order.client.domain.OrderItem
hashCode() - Method in class com.broadleafcommerce.order.client.domain.OrderPricing
hashCode() - Method in class com.broadleafcommerce.order.client.domain.payment.PaymentDistributionDetail
hashCode() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization
hashCode() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem
hashCode() - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation
hashCode() - Method in class com.broadleafcommerce.order.client.domain.Shipment

I

ImageAssetRef - Class in com.broadleafcommerce.order.client.domain: A reference object for holding data from a primary entity-asset (e.g., a product's primary image) that can be kept on an OrderItem for displaying product assets.
ImageAssetRef() - Constructor for class com.broadleafcommerce.order.client.domain.ImageAssetRef
isAvailableOnline() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: Whether or not this product is available online - ie inventory is available somewhere to fulfill this product.
isBroadleafCart(String) - Static method in enum class com.broadleafcommerce.order.client.domain.enums.DefaultCartTypes
isCancelled(String) - Static method in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus
isCancelled(String) - Static method in enum class com.broadleafcommerce.order.client.domain.ReturnAuthorizationStatus
isCapture(String) - Static method in enum class com.broadleafcommerce.order.client.domain.enums.DefaultFulfillmentCaptureClaimTypes: Deprecated.
isCaptureAwaitingResult(String) - Static method in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus
isCapturingPayment(String) - Static method in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus
isClaim(String) - Static method in enum class com.broadleafcommerce.order.client.domain.enums.DefaultFulfillmentCaptureClaimTypes: Deprecated.
isCompleted(String) - Static method in enum class com.broadleafcommerce.order.client.domain.ReturnAuthorizationStatus
isCompleted(String) - Static method in enum class com.broadleafcommerce.order.client.domain.ReturnConfirmationStatus
isConfirmed(String) - Static method in enum class com.broadleafcommerce.order.client.domain.ReturnAuthorizationStatus
isDiscountable() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: Whether or not this item can be applied to any offers or promotions.
isExtraFee(String) - Static method in enum class com.broadleafcommerce.order.client.domain.enums.DefaultOrderItemTypes
isFulfilled(String) - Static method in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus
isFulfillFailed(String) - Static method in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus
isFulfilling(String) - Static method in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus
isNew(String) - Static method in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus
isOrderFulfillment(String) - Static method in enum class com.broadleafcommerce.order.client.domain.enums.DefaultFulfillmentCaptureClaimSummaryDiscriminatorTypes
isOverrideFulfillmentPriceFlag() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: Whether the total fulfillment price of this OrderFulfillment was specifically overridden, whether from a CSR or an automatic process.
isOverridePriceFlag() - Method in class com.broadleafcommerce.order.client.domain.OrderItem: Whether the price of this OrderItem was specifically overridden, whether from a CSR or an automatic process.
isPartiallyConfirmed(String) - Static method in enum class com.broadleafcommerce.order.client.domain.ReturnAuthorizationStatus
isPayment(String) - Static method in enum class com.broadleafcommerce.order.client.domain.enums.DefaultFulfillmentCaptureClaimSummaryDiscriminatorTypes
isPaymentCaptured(String) - Static method in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus
isPaymentCaptureFailed(String) - Static method in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus
isPending(String) - Static method in enum class com.broadleafcommerce.order.client.domain.ReturnAuthorizationStatus
isPending(String) - Static method in enum class com.broadleafcommerce.order.client.domain.ReturnConfirmationStatus
isRefundAwaitingResult(String) - Static method in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus
isRefundAwaitingResult(String) - Static method in enum class com.broadleafcommerce.order.client.domain.ReturnConfirmationStatus
isRefundFailed(String) - Static method in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus
isRefundFailed(String) - Static method in enum class com.broadleafcommerce.order.client.domain.ReturnConfirmationStatus
isRefundFulfillmentCharge() - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: Whether the fulfillment charge should be refunded.
isRequiresCollectOnDelivery() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: Whether this OrderFulfillment requires at least part of the payment to be collected on delivery.
isStandard(String) - Static method in enum class com.broadleafcommerce.order.client.domain.enums.DefaultOrderItemTypes
isVat() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: Declares whether the taxes were included in the provided subtotal.

N

name() - Method in interface com.broadleafcommerce.order.client.domain.enums.CartType
NEW - Enum constant in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus: Indicates that the fulfillment is newly created.
NON_REFUND - Enum constant in enum class com.broadleafcommerce.order.client.domain.DefaultReturnAuthorizationItemReturnTypes: Indicates that this return should not result in a refund being issued.

O

Order - Class in com.broadleafcommerce.order.client.domain: Represents a purchase of items, often generated from a submitted cart.
Order() - Constructor for class com.broadleafcommerce.order.client.domain.Order
ORDER_FULFILLMENT - Enum constant in enum class com.broadleafcommerce.order.client.domain.enums.DefaultFulfillmentCaptureClaimSummaryDiscriminatorTypes: Declares that the FulfillmentCaptureClaimSummary.getDiscriminatorId() is an order fulfillment id.
OrderAttributeConstants - Class in com.broadleafcommerce.order.client.domain
OrderAttributeConstants() - Constructor for class com.broadleafcommerce.order.client.domain.OrderAttributeConstants
OrderFulfillment - Class in com.broadleafcommerce.order.client.domain: A group of item(s) from an Order that are fulfilled together.
OrderFulfillment() - Constructor for class com.broadleafcommerce.order.client.domain.OrderFulfillment
OrderFulfillmentItem - Class in com.broadleafcommerce.order.client.domain: Represents an OrderItem designated to a particular OrderFulfillment for fulfillment.
OrderFulfillmentItem() - Constructor for class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem
OrderFulfillmentItemTaxDetail - Class in com.broadleafcommerce.order.client.domain: Fine grained tax information about a fulfillment item.
OrderFulfillmentItemTaxDetail() - Constructor for class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail
OrderFulfillmentItemTaxDetail(OrderFulfillmentItemTaxDetail) - Constructor for class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: Copy constructor for tax detail.
OrderFulfillmentStatus - Enum Class in com.broadleafcommerce.order.client.domain: Default values for OrderFulfillment.getStatus().
OrderItem - Class in com.broadleafcommerce.order.client.domain: An item in an Order.
OrderItem() - Constructor for class com.broadleafcommerce.order.client.domain.OrderItem
OrderPricing - Class in com.broadleafcommerce.order.client.domain: Pricing information for an Order.
OrderPricing() - Constructor for class com.broadleafcommerce.order.client.domain.OrderPricing
ORIGINAL_CART_ITEM_ID - Static variable in class com.broadleafcommerce.order.client.domain.OrderAttributeConstants

P

PARTIALLY_CONFIRMED - Enum constant in enum class com.broadleafcommerce.order.client.domain.ReturnAuthorizationStatus: Indicates that the returns process is still pending confirmation, but some have items have been confirmed already.
PAYMENT - Enum constant in enum class com.broadleafcommerce.order.client.domain.enums.DefaultFulfillmentCaptureClaimSummaryDiscriminatorTypes: Declares that the FulfillmentCaptureClaimSummary.getDiscriminatorId() is a payment id.
PAYMENT_CAPTURE_FAILED - Enum constant in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus: Indicates that the fulfillment payment was unable to be captured.
PAYMENT_CAPTURED - Enum constant in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus: Indicates that the fulfillment payment was successfully captured.
PaymentDistributionDetail - Class in com.broadleafcommerce.order.client.domain.payment: Represents the amount distributed to an order's payment.
PaymentDistributionDetail() - Constructor for class com.broadleafcommerce.order.client.domain.payment.PaymentDistributionDetail
PENDING - Enum constant in enum class com.broadleafcommerce.order.client.domain.ReturnAuthorizationStatus: Indicates that the returns process has been initialized, and is pending confirmation.
PENDING - Enum constant in enum class com.broadleafcommerce.order.client.domain.ReturnConfirmationStatus: Indicates that the return confirmation process has started, and further processing is pending.
PENDING_INVENTORY - Enum constant in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus: Indicates that the fulfillment was created but cannot be fulfilled until inventory is available.

R

REFUND - Enum constant in enum class com.broadleafcommerce.order.client.domain.DefaultReturnAuthorizationItemReturnTypes: Indicates that this return should result in a refund being issued.
REFUND_AWAITING_RESULT - Enum constant in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus: Indicates that the fulfillment payment is sent to the payment gateway but awaiting refund transaction result.
REFUND_AWAITING_RESULT - Enum constant in enum class com.broadleafcommerce.order.client.domain.ReturnConfirmationStatus: Indicates that the refund for the return confirmation is sent to payment gateway and awaiting transaction result.
REFUND_FAILED - Enum constant in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus: Indicates that the fulfillment payments were not fully refunded.
REFUND_FAILED - Enum constant in enum class com.broadleafcommerce.order.client.domain.ReturnConfirmationStatus: Indicates that the refund for the return confirmation failed.
ReturnAuthorization - Class in com.broadleafcommerce.order.client.domain: Represents an initiated return for items in an Order.
ReturnAuthorization() - Constructor for class com.broadleafcommerce.order.client.domain.ReturnAuthorization
ReturnAuthorizationItem - Class in com.broadleafcommerce.order.client.domain: Represents an item which is being returned in a ReturnAuthorization.
ReturnAuthorizationItem() - Constructor for class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem
ReturnAuthorizationStatus - Enum Class in com.broadleafcommerce.order.client.domain: Default values for ReturnAuthorization.status
ReturnConfirmation - Class in com.broadleafcommerce.order.client.domain: Represents a portion of a ReturnAuthorizationItem which has been confirmed as returned.
ReturnConfirmation() - Constructor for class com.broadleafcommerce.order.client.domain.ReturnConfirmation
ReturnConfirmationStatus - Enum Class in com.broadleafcommerce.order.client.domain: Default values for ReturnConfirmation.status

S

setAccountHierarchy(List<String>) - Method in class com.broadleafcommerce.order.client.domain.Order: The hierarchy of accounts, from the root account to the account member's account.
setAccountId(String) - Method in class com.broadleafcommerce.order.client.domain.Order: The ID of the account the account member belongs to.
setActualCondition(String) - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The actual condition of the returned item received.
setAdditionalAttributes(Map<String, String>) - Method in class com.broadleafcommerce.order.client.domain.payment.PaymentDistributionDetail: General use map to capture any additional attributes needed for this detail.
setAdditionalShipments(List<Shipment>) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: All additional shipment details for this fulfillment.
setAddress(Address) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The shipping address for this fulfillment.
setAdjustments(List<Adjustment>) - Method in class com.broadleafcommerce.order.client.domain.Order: Adjustments to order pricing that were applied to OrderPricing.getSubtotal().
setAdjustments(List<Adjustment>) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: Adjustments to fulfillment pricing that should be applied to OrderFulfillment.getFulfillmentCharge().
setAdjustmentsTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The total adjustment price for all adjustments of an OrderItem.
setAdjustmentsTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderPricing: The total adjustment price for all adjustments of an Order and its Order.getOrderItems().
setAltText(String) - Method in class com.broadleafcommerce.order.client.domain.ImageAssetRef: Text that corresponds to the HTML alt attribute that should be used when this asset is rendered in a browser.
setAmount(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim: The amount that has been captured or claimed by the fulfillment against the payment.
setApproverEmail(String) - Method in class com.broadleafcommerce.order.client.domain.Order: The order approver's email address.
setAttributeChoices(Map<String, AttributeChoiceValue>) - Method in class com.broadleafcommerce.order.client.domain.Order: Attribute choices for this order driven by its items' product options, where each key is the attributeName from an attribute choice.
setAttributeChoices(Map<String, AttributeChoiceValue>) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: Attribute choices for this item driven by product options, where each key is the attributeName from an attribute choice.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim: Additional attributes for this claim.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.order.client.domain.Order: Miscellaneous attributes for this order.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: Additional attributes for this order fulfillment.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: Miscellaneous attributes for this fulfillment item.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: Additional attributes for this tax detail.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: Miscellaneous attributes for this item.
setAvailableOnline(boolean) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: Whether or not this product is available online - ie inventory is available somewhere to fulfill this product.
setBrandId(String) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The id to the corresponding data driven enum for this item's product's brand.
setCampaignRefs(List<CampaignRef>) - Method in class com.broadleafcommerce.order.client.domain.Order: A list of campaign references that are attached to this order.
setCartCreateDate(Instant) - Method in class com.broadleafcommerce.order.client.domain.Order: The date that the originating cart was first created.
setCartId(String) - Method in class com.broadleafcommerce.order.client.domain.Order: The context ID of the original cart for this order.
setCartType(String) - Method in class com.broadleafcommerce.order.client.domain.Order: The type of cart for this order.
setCategoryIds(Set<String>) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The ids to the corresponding categories for this item's product.
setCheckoutRequestId(String) - Method in class com.broadleafcommerce.order.client.domain.Order: The id of the latest checkout request for the originating cart.
setClaims(List<FulfillmentCaptureClaim>) - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary: The list of FulfillmentCaptureClaims for the OrderFulfillment.
setConfirmations(List<ReturnConfirmation>) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The portions of this item which have been confirmed as returned.
setContentUrl(String) - Method in class com.broadleafcommerce.order.client.domain.ImageAssetRef: The fully-resolvable content-URL to the binary data of the asset.
setContextState(ContextState) - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim: A subset of Tracking information to expose the context state for this object.
setContextState(ContextState) - Method in class com.broadleafcommerce.order.client.domain.Order: A subset of Tracking information to expose the context state for this object.
setContextState(ContextState) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: A subset of Tracking information to expose the context state for this object.
setContextState(ContextState) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: A subset of Tracking information to expose the context state for this object.
setContextState(ContextState) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: A subset of Tracking information to expose the context state for this object.
setCountry(String) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The 2 digit country code.
setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim: The currency unit used for monetary amounts.
setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.order.client.domain.Order
setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The currency unit used for the pricing of this OrderFulfillment.
setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The currency for this tax detail.
setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.order.client.domain.OrderPricing: The currency unit used for the pricing of this Order.
setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The currency unit used for monetary amounts.
setCustomerId(String) - Method in class com.broadleafcommerce.order.client.domain.Order: The ID of the customer that owns this order.
setCustomerName(String) - Method in class com.broadleafcommerce.order.client.domain.Order: The name of the customer that owns this order.
setDependentOrderItems(List<OrderItem>) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: OrderItems that depend on this OrderItem.
setDiscountable(boolean) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: Whether or not this item can be applied to any offers or promotions.
setDiscriminatorId(String) - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary: The id of the discriminating entity for filtering the claims, usually the id of the order fulfillment or payment.
setDiscriminatorType(String) - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary: The type of discriminating entity for filtering the claims, usually order fulfillment or payment.
setEmailAddress(String) - Method in class com.broadleafcommerce.order.client.domain.Order: The customer's email address.
setEstimatedFulfillmentTotalToRefund(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The estimated fulfillment total which can be refunded.
setEstimatedFulfillmentTotalToRefund(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The estimated fulfillment total which can be refunded.
setEstimatedMerchandiseTotalToRefund(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The estimated merchandise total which can be refunded.
setEstimatedMerchandiseTotalToRefund(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The estimated merchandise total which can be refunded.
setEstimatedReturnShippingCharge(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The estimated charge to the customer to ship back the items to return.
setEstimatedTaxTotalToRefund(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The estimated tax total which can be refunded.
setEstimatedTaxTotalToRefund(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The estimated tax total which can be refunded.
setEstimatedTotalToRefund(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The estimated grand total which can be refunded.
setEstimatedTotalToRefund(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The estimated grand total which can be refunded.
setExpectedCondition(String) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The condition of the item expected when returned.
setExternalId(String) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: Intended to hold any unique identifier for this fulfillment as assigned by an external system.
setFeesTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderPricing: The total fees of this Order.
setFulfillmentAdjustments(List<Adjustment>) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: Adjustments to item fulfillment pricing that should be applied to the total of OrderFulfillmentItem.unitFulfillmentCharge.
setFulfillmentAdjustmentsTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: Sum of the fulfillment's adjustments.
setFulfillmentAdjustmentsTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The total of all the item fulfillment adjustments for this item.
setFulfillmentCharge(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The shipping charge for this fulfillment before adjustments are applied.
setFulfillmentItem(OrderFulfillmentItem) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The fulfillment item for this tax detail
setFulfillmentItems(List<OrderFulfillmentItem>) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: Items within this fulfillment, each of which should relate back to a OrderItem.
setFulfillmentOption(FulfillmentOption) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The fulfillment option chosen for the OrderFulfillment.getType().
setFulfillmentRefundAmount(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The fulfillment amount to refund when this item is returned, note that prorated fulfillment group adjustments are included.
setFulfillmentTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The total shipping price of this fulfillment, including adjustments and item shipping prices.
setFulfillmentTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The total fulfillment price of this item, including adjustments.
setFulfillmentTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderPricing: The total fulfillment price of this Order, including adjustments.
setFulfillmentTotalRefunded(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The fulfillment total which has been refunded.
setFulfillmentTotalToRefund(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The fulfillment total which can be refunded.
setGrandTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The grand total of this fulfillment, including merchandise costs, all shipping costs including items, and tax.
setGroupReferenceNumber(String) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The reference number of the FulfillmentGroup this fulfillment was created from.
setId(String) - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim: The context ID of this claim.
setId(String) - Method in class com.broadleafcommerce.order.client.domain.Order: The context ID of the order.
setId(String) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The unique identifier for this fulfillment.
setId(String) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The context ID of this fulfillment item.
setId(String) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The database id
setId(String) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The context ID of the order.
setId(String) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The context ID of the return authorization.
setId(String) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The id of this return authorization item.
setId(String) - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The id of this return confirmation.
setImageAsset(ImageAssetRef) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The image asset for this item, usually sourced from the product.
setIncludedFulfillmentTax(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The amount of fulfillment taxes that are included in the item subtotal (VAT).
setIncludedFulfillmentTax(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The amount of fulfillment taxes that are included in the item subtotal (VAT).
setIncludedMerchandiseTax(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The amount of merchandise taxes that are included in the item subtotal (VAT).
setIncludedMerchandiseTax(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The amount of merchandise taxes that are included in the item subtotal (VAT).
setIncludedTaxAmount(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderPricing: The amount of taxes that are included in the subtotal (VAT).
setInternalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.order.client.domain.Order: Miscellaneous internal attributes for this item.
setInternalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: Miscellaneous internal attributes for this fulfillment item.
setInternalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: Miscellaneous internal attributes for this item.
setInventoryCheckStrategy(String) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The inventory check strategy of the item.
setInventoryLocationReference(String) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: This is an optional field where the ID or reference number of the expected InventoryLocation is stored.
setInventoryReservationStrategy(String) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The reservation strategy of the item.
setItemAdjustments(List<Adjustment>) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: Adjustments to item pricing that should be applied to getSubtotal().
setItems(List<ReturnAuthorizationItem>) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The items which are being returned.
setItemTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The total amount attributed to this fulfillment item.
setJurisdictionName(String) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The tax jurisdiction name.
setJurisdictionType(String) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The jurisdiction type, e.g.
setLocale(Locale) - Method in class com.broadleafcommerce.order.client.domain.Order: The locale for this order.
setMerchandiseAdjustmentsTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The total of all the item adjustments for the merchandise.
setMerchandiseRefundAmount(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The merchandise amount to refund when this item is returned, note that prorated order adjustments are included.
setMerchandiseSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The OrderFulfillmentItem.unitMerchandisePrice multiplied by OrderFulfillmentItem.quantity.
setMerchandiseTaxTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The total tax of the item merchandise based on the price of the related OrderItem.
setMerchandiseTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The merchandise total for all items in the fulfillment, including item adjustments and prorated order adjustments.
setMerchandiseTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The merchandise total for the item quantity, including OrderFulfillmentItem.merchandiseSubtotal and item OrderFulfillmentItem.merchandiseAdjustmentsTotal.
setMerchandiseTotalRefunded(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The merchandise total which has been refunded.
setMerchandiseTotalToRefund(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The merchandise total which can be refunded.
setMerchandisingContext(String) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: Defines the merchandising context of the item to signify where it is added from.
setMerchandisingTypeId(String) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The id to the corresponding data driven enum for this item's product's merchandising type.
setName(String) - Method in class com.broadleafcommerce.order.client.domain.Order: A unique name for the order, used for retrieval.
setName(String) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The name of this item.
setNonIncludedFulfillmentTax(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The amount of fulfillment taxes that are not included in the item subtotal.
setNonIncludedMerchandiseTax(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The amount of merchandise taxes that are not included in the item subtotal.
setNonIncludedTaxTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The total amount of taxes that are not included in the item subtotal.
setNote(String) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: An optional note containing extra information about the item being returned.
setNote(String) - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: An optional note containing extra information about the item being returned.
setOfferCodes(List<String>) - Method in class com.broadleafcommerce.order.client.domain.Order: A list of offer codes that were added to this order.
setOrder(Order) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The owning order of this item.
setOrderFulfillment(OrderFulfillment) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The owning order fulfillment of this item.
setOrderFulfillmentId(String) - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim: The context ID of the order fulfillment.
setOrderFulfillmentItemId(String) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The context ID of the OrderFulfillmentItem being returned.
setOrderFulfillmentNumber(String) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The number for this individual fulfillment, unique within the order.
setOrderId(String) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: A soft reference to the parent Order this fulfillment belongs to.
setOrderId(String) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The context ID of the order from which items are returned.
setOrderItemId(String) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The id of the OrderItem to be represented by this fulfillment item.
setOrderItems(List<OrderItem>) - Method in class com.broadleafcommerce.order.client.domain.Order: Items that are contained within this order.
setOrderNumber(String) - Method in class com.broadleafcommerce.order.client.domain.Order: The unique number associated with this Order.
setOrderPricing(OrderPricing) - Method in class com.broadleafcommerce.order.client.domain.Order: Embedded container for all pricing information on this order.
setOverrideDetails(List<OverrideDetail>) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: List of details about any price overrides which have been performed on this fulfillment.
setOverrideDetails(List<OverrideDetail>) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: List of details about any price overrides which have been performed on this item.
setOverrideFulfillmentPriceFlag(boolean) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: Whether the total fulfillment price of this OrderFulfillment was specifically overridden, whether from a CSR or an automatic process.
setOverridePriceFlag(boolean) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: Whether the price of this OrderItem was specifically overridden, whether from a CSR or an automatic process.
setOverrideTotalToRefund(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The overridden grand total to refund.
setPaymentDisplayType(String) - Method in class com.broadleafcommerce.order.client.domain.payment.PaymentDistributionDetail: The type of the payment.
setPaymentDistributionDetails(List<PaymentDistributionDetail>) - Method in class com.broadleafcommerce.order.client.domain.Order: A list of PaymentDistributionDetails representing how this order's total is split across different payments.
setPaymentId(String) - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim: The context ID of the payment that the claimed transaction belongs to.
setPaymentId(String) - Method in class com.broadleafcommerce.order.client.domain.payment.PaymentDistributionDetail: The id of the payment.
setPricedFulfillmentOption(PricedFulfillmentOption) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The PricedFulfillmentOption chosen for the OrderFulfillment.getType().
setPricedFulfillmentOption(PricedFulfillmentOption) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The PricedFulfillmentOption chosen for this item.
setPriceListId(String) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The id of the price list used to get the pricing for this OrderItem.
setPricingStrategy(String) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The pricing strategy for this item.
setPrimaryReturnReason(String) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The primary reason for the return.
setProductId(String) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The id to the corresponding product for this item.
setProductTags(List<String>) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The list of simple labels used to categorize the corresponding product for this item.
setProratedFulfillmentCharge(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The prorated shipping charge for this fulfillment item before adjustments are applied, derived from the FulfillmentGroup.getGroupFulfillmentPriceBeforeAdjustments().
setProratedOrderAdjustments(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The amount prorated to this item from order adjustments.
setProratedOrderAdjustments(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The amount prorated to this item from order adjustments.
setProratedOrderFulfillmentAdjustments(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: Prorated amount of the fulfillment adjustments that applies to the OrderFulfillment.fulfillmentCharge.
setProratedOrderFulfillmentAdjustments(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The amount prorated to this item from order fulfillment adjustments.
setQuantity(int) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The quantity of the item to be fulfilled by this fulfillment.
setQuantity(int) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The number of this item in the Order.
setQuantity(int) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The quantity of the item being returned.
setQuantity(int) - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The quantity of the item which was returned.
setRate(BigDecimal) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The tax rate
setRatio(BigDecimal) - Method in class com.broadleafcommerce.order.client.domain.payment.PaymentDistributionDetail: The percentage of the order total that is distributed to this payment, represented as a decimal.
setRecurringPrice(RecurringPriceDetail) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: This is the recurring price if any from the same source as the unitPrice.
setRecurringPriceTypeOverride(String) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: Overrides unitPriceType for the recurringPrice in cases where they must diverge.
setReferenceNumber(String) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The reference number for this fulfillment item.
setRefundAmount(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The pre-calculated merchandise amount to refund when this OrderItem is returned.
setRefundFulfillmentCharge(boolean) - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: Whether the fulfillment charge should be refunded.
setRegion(String) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The region that this tax was calculated.
setRequestId(String) - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim: The id representing the request to claim/execute one or more transactions.
setRequiresCollectOnDelivery(boolean) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: Whether this OrderFulfillment requires at least part of the payment to be collected on delivery.
setReturnShippingCharged(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The amount charged to the customer to ship back the items to return.
setReturnType(String) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The type of the return, indicating how it should be processed.
setRootAccountId(String) - Method in class com.broadleafcommerce.order.client.domain.Order: The ID of the root account the account member belongs to.
setSecondaryReturnReason(String) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem: The secondary reason for the return, providing more detail in addition to the ReturnAuthorizationItem.primaryReturnReason.
setShipDate(Instant) - Method in class com.broadleafcommerce.order.client.domain.Shipment: The date the shipment was shipped.
setShipment(Shipment) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The primary shipment details for this fulfillment.
setShipperType(String) - Method in class com.broadleafcommerce.order.client.domain.Shipment: The shipper responsible for the shipment, for example a carrier.
setSku(String) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: Represents a SKU code, similar to productId or variantId, except this is a unified, unique concept across both products and variants.
setStatus(String) - Method in class com.broadleafcommerce.order.client.domain.Order: The status of this order.
setStatus(String) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The status of this fulfillment.
setStatus(String) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The status of the return.
setStatus(String) - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The status of the returned item.
setSubmitDate(Instant) - Method in class com.broadleafcommerce.order.client.domain.Order: The date that this order was submitted.
setSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The subtotal price of this OrderItem.
setSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderPricing: The subtotal price of this Order.
setTargetDemographicId(String) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The id to the corresponding data driven enum for this item's product's target demographic.
setTaxableAmount(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The amount that was taxable to determine the calculated tax.
setTaxCalculated(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The amount of taxes calculated.
setTaxDetails(List<OrderFulfillmentItemTaxDetail>) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The tax details for this fulfillment item.
setTaxIncludedType(String) - Method in class com.broadleafcommerce.order.client.domain.OrderPricing: Indicates if any taxes are included in the subtotal.
setTaxName(String) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The tax name for this tax detail.
setTaxTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The total tax of this fulfillment, including merchandise and fulfillment tax.
setTaxTotalRefunded(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The tax total which has been refunded.
setTaxTotalToRefund(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The tax total which can be refunded.
setTermDurationLength(Integer) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The length of the terms, e.g., if this is 36 and termDurationType is MONTHS, then the recurringPrice should be charged for 36 months.
setTermDurationType(String) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The term duration type, e.g.
setTitle(String) - Method in class com.broadleafcommerce.order.client.domain.ImageAssetRef: Text that corresponds to the HTML title attribute that should be used when this asset is rendered in a browser.
setTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The total price of this OrderItem.
setTotal(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderPricing: The total price of this Order.
setTotalAmountCaptured(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary: Deprecated.
In favor of using the TransactionSummary concept from PaymentTransactionServices to understand the amount captured for a fulfillment, instead of recording captured amounts for fulfillments in the FulfillmentCaptureClaim structure.
setTotalAmountClaimed(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary: Total amount claimed.
setTotalFailedToRefund(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The grand total which has failed to be refunded.
setTotalFailedToRefund(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The grand total which has failed to be refunded.
setTotalRefundAwaitingResult(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The grand total of refund that is awaiting result.
setTotalRefundAwaitingResult(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The grand total of refund that is awaiting result.
setTotalRefunded(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The grand total which has been refunded.
setTotalRefunded(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The estimated grand total which has been refunded.
setTotalTax(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderPricing: The total tax amount for this Order.
setTotalToRefund(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation: The grand total which can be refunded.
setTrackingNumber(String) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: Optional tracking number for the return shipment of items.
setTrackingNumber(String) - Method in class com.broadleafcommerce.order.client.domain.Shipment: The tracking number for this shipment.
setTrackingUrl(String) - Method in class com.broadleafcommerce.order.client.domain.Shipment: The URL to the tracking page for this shipment.
setTransactionId(String) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: The transaction ID for this tax detail.
setType(String) - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim: Deprecated.
In favor of using the TransactionSummary concept from PaymentTransactionServices, instead of recording captured amounts for fulfillments in the FulfillmentCaptureClaim structure.
setType(String) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The type of means by which this fulfillment is fulfilled.
setType(String) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The type of this item.
setUnitFulfillmentCharge(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The unit shipping charge of each item before adjustments are applied.
setUnitMerchandisePrice(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem: The individual unit price for the merchandise.
setUnitPrice(MonetaryAmount) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The individual unit price for an OrderItem.
setUnitPriceType(String) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The type of the unit price for an OrderItem.
setUri(String) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The navigable uri of the corresponding catalog entry (e.g.
setUsagePrice(UsagePriceDetail) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: This is the usage price if any from the same source as the unitPrice.
setVariantId(String) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: The id to the corresponding variant for this item.
setVat(boolean) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail: Declares whether the taxes were included in the provided subtotal.
setVendorRef(String) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: A reference to the corresponding vendor for this fulfillment.
setVendorRef(String) - Method in class com.broadleafcommerce.order.client.domain.OrderItem: A reference to the corresponding vendor for this item.
setVersion(Integer) - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment: The version of this OrderFulfillment.
setVersion(Integer) - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization: The version of this ReturnAuthorization.
setVouchers(List<Voucher>) - Method in class com.broadleafcommerce.order.client.domain.Order: A list of Vouchers that this order is qualified for.
Shipment - Class in com.broadleafcommerce.order.client.domain: Shipping information for a specific shipment.
Shipment() - Constructor for class com.broadleafcommerce.order.client.domain.Shipment
STANDARD - Enum constant in enum class com.broadleafcommerce.order.client.domain.enums.DefaultOrderItemTypes: A normal order item with typical behavior.

T

toString() - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim
toString() - Method in class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary
toString() - Method in class com.broadleafcommerce.order.client.domain.ImageAssetRef
toString() - Method in class com.broadleafcommerce.order.client.domain.Order
toString() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillment
toString() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem
toString() - Method in class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail
toString() - Method in class com.broadleafcommerce.order.client.domain.OrderItem
toString() - Method in class com.broadleafcommerce.order.client.domain.OrderPricing
toString() - Method in class com.broadleafcommerce.order.client.domain.payment.PaymentDistributionDetail
toString() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorization
toString() - Method in class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem
toString() - Method in class com.broadleafcommerce.order.client.domain.ReturnConfirmation
toString() - Method in class com.broadleafcommerce.order.client.domain.Shipment

V

valueOf(String) - Static method in enum class com.broadleafcommerce.order.client.domain.DefaultReturnAuthorizationItemReturnTypes: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.order.client.domain.enums.DefaultCartTypes: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.order.client.domain.enums.DefaultFulfillmentCaptureClaimSummaryDiscriminatorTypes: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.order.client.domain.enums.DefaultFulfillmentCaptureClaimTypes: Deprecated.

Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.order.client.domain.enums.DefaultOrderItemTypes: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.order.client.domain.ReturnAuthorizationStatus: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.order.client.domain.ReturnConfirmationStatus: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.broadleafcommerce.order.client.domain.DefaultReturnAuthorizationItemReturnTypes: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.order.client.domain.enums.DefaultCartTypes: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.order.client.domain.enums.DefaultFulfillmentCaptureClaimSummaryDiscriminatorTypes: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.order.client.domain.enums.DefaultFulfillmentCaptureClaimTypes: Deprecated.

Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.order.client.domain.enums.DefaultOrderItemTypes: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.order.client.domain.ReturnAuthorizationStatus: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.order.client.domain.ReturnConfirmationStatus: Returns an array containing the constants of this enum class, in the order they are declared.

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