com.broadleafcommerce.oms.fulfillment.domain

Interface FulfillmentOrderItem

All Known Implementing Classes:

FulfillmentOrderItemImpl

public interface FulfillmentOrderItem

Much like FulfillmentGroupItems represent what is expected to ship (or be fulfilled) to where, this represents what is ACTUALLY shipped or fulfilled. Sometimes things happen like an item is suddenly discontinued, or inventory becomes unavailable. Since Fulfillment Group Items are essentially immutable after the order is submitted, this provides a way to indicate what is actually shipped for that particular fulfillment group item.

Author:

Kelly Tisdell

Method Summary

Modifier and Type	Method and Description
List<AppeasementAdjustment>	getAppeasements() After fulfillment, a CSR may wish to adjust the price of a fulfillment item to reflect and adjustments that were given out (e.g.
org.broadleafcommerce.openadmin.audit.AdminAuditable	getAuditable() Auditing data for this fulfillmentOrderItem
int	getConfirmedReturnQuantity() This is the aggregate of all return confirmed quantities, across all ReturnConfirmations
org.broadleafcommerce.core.order.domain.FulfillmentGroupItem	getFulfillmentGroupItem() The related FulfillmentGroupItem
org.broadleafcommerce.common.money.Money	getFulfillmentItemAmount() The amount that should be charged / refunded for this FulfillmentOrderItem when this item is fulfilled.
FulfillmentOrder	getFulfillmentOrder() Returns the related fulfillmentOrder
Long	getId() Returns the unique id for the item.
Integer	getQuantity() The quantity for this item.
int	getQuantityAuthorizedForReturn() This is the aggregate of all return authorization quantity items, across all ReturnAuthorizationItems
org.broadleafcommerce.common.money.Money	getTotalAppeasements() Convenience method to return non null sum of all appeasements for this fulfillment item
org.broadleafcommerce.common.money.Money	getTotalProcessedAppeasements() Convenience method to return non null sum of all processed appeasements for this fulfillment item
org.broadleafcommerce.common.money.Money	getTotalUnprocessedAppeasements() Convenience method to return non null sum of all unprocessed appeasements for this fulfillment item
void	setAppeasements(List<AppeasementAdjustment> appeasements) After fulfillment, a CSR may wish to adjust the price of a fulfillment item to reflect and adjustments that were given out (e.g.
void	setAuditable(org.broadleafcommerce.openadmin.audit.AdminAuditable auditable) Auditing data for this fulfillmentOrderItem
void	setConfirmedReturnQuantity(int quantity) This is the aggregate of all return confirmed quantities, across all ReturnConfirmations
void	setFulfillmentGroupItem(org.broadleafcommerce.core.order.domain.FulfillmentGroupItem fgItem) Sets the related FulfillmentGroupItem
void	setFulfillmentItemAmount(org.broadleafcommerce.common.money.Money amount) Sets the amount that should be charged for this FulfillmentOrderItem when this item is fulfilled.
void	setFulfillmentOrder(FulfillmentOrder fulfillmentOrder) Sets the related fulfillmentOrder
void	setId(Long id) Sets the unique id for the item.
void	setQuantity(Integer quantity) The quantity for this item
void	setQuantityAuthorizedForReturn(int quantity) Sets the aggregate quantity authorized for return, across all ReturnAuthorizationItems

Method Detail

setId

void setId(Long id)

Sets the unique id for the item.

Parameters:

id -

getId

Long getId()

Returns the unique id for the item.

Returns:

setFulfillmentOrder

void setFulfillmentOrder(FulfillmentOrder fulfillmentOrder)

Sets the related fulfillmentOrder

Parameters:

fulfillmentOrder -

getFulfillmentOrder

FulfillmentOrder getFulfillmentOrder()

Returns the related fulfillmentOrder

Returns:

setFulfillmentGroupItem

void setFulfillmentGroupItem(org.broadleafcommerce.core.order.domain.FulfillmentGroupItem fgItem)

Sets the related FulfillmentGroupItem

getFulfillmentGroupItem

org.broadleafcommerce.core.order.domain.FulfillmentGroupItem getFulfillmentGroupItem()

The related FulfillmentGroupItem

Returns:

setQuantity

void setQuantity(Integer quantity)

The quantity for this item

Parameters:

quantity -

getQuantity

Integer getQuantity()

The quantity for this item.

Returns:

getFulfillmentItemAmount

org.broadleafcommerce.common.money.Money getFulfillmentItemAmount()

The amount that should be charged / refunded for this FulfillmentOrderItem when this item is fulfilled. Typically used for companies that authorize an amount but do not debit until fufillment. Also used by the returns process as the default amount for the item.

Returns:

setFulfillmentItemAmount

void setFulfillmentItemAmount(org.broadleafcommerce.common.money.Money amount)

Sets the amount that should be charged for this FulfillmentOrderItem when this item is fulfilled. Typically used for companies that authorize an amount but do not debit until fufillment.

Parameters:

amount -

setAuditable

void setAuditable(org.broadleafcommerce.openadmin.audit.AdminAuditable auditable)

Auditing data for this fulfillmentOrderItem

Parameters:

auditable -

getAuditable

org.broadleafcommerce.openadmin.audit.AdminAuditable getAuditable()

Auditing data for this fulfillmentOrderItem

Returns:

getQuantityAuthorizedForReturn

int getQuantityAuthorizedForReturn()

This is the aggregate of all return authorization quantity items, across all ReturnAuthorizationItems

Returns:

setQuantityAuthorizedForReturn

void setQuantityAuthorizedForReturn(int quantity)

Sets the aggregate quantity authorized for return, across all ReturnAuthorizationItems

Parameters:

quantity -

getConfirmedReturnQuantity

int getConfirmedReturnQuantity()

This is the aggregate of all return confirmed quantities, across all ReturnConfirmations

Returns:

setConfirmedReturnQuantity

void setConfirmedReturnQuantity(int quantity)

This is the aggregate of all return confirmed quantities, across all ReturnConfirmations

getAppeasements

List<AppeasementAdjustment> getAppeasements()

After fulfillment, a CSR may wish to adjust the price of a fulfillment item to reflect and adjustments that were given out (e.g. item goes on sale after it has been fulfilled but company policy allows a price match after a certain threshold and will issue a refund) Any price adjustments made to the item after fulfillment will be handled through an "appeasement adjustment" and can be referenced on any subsequent refund and return calculation.

Returns:

list of applied appeasements

setAppeasements

void setAppeasements(List<AppeasementAdjustment> appeasements)

After fulfillment, a CSR may wish to adjust the price of a fulfillment item to reflect and adjustments that were given out (e.g. item goes on sale after it has been fulfilled but company policy allows a price match after a certain threshold and will issue a refund) Any price adjustments made to the item after fulfillment will be handled through an "appeasement adjustment" and can be referenced on any subsequent refund and return calculation.

getTotalAppeasements

org.broadleafcommerce.common.money.Money getTotalAppeasements()

Convenience method to return non null sum of all appeasements for this fulfillment item

Returns:

getTotalProcessedAppeasements

org.broadleafcommerce.common.money.Money getTotalProcessedAppeasements()

Convenience method to return non null sum of all processed appeasements for this fulfillment item

Returns:

getTotalUnprocessedAppeasements

org.broadleafcommerce.common.money.Money getTotalUnprocessedAppeasements()

Convenience method to return non null sum of all unprocessed appeasements for this fulfillment item

Returns: