com.retek.component.customerorder
Interface ReturnLine

All Superinterfaces:
BusinessObject, CustomerOrderTransactionItem, DistributedObject
All Known Subinterfaces:
ReturnLineRib
All Known Implementing Classes:
ReturnLineImpl

public interface ReturnLine
extends DistributedObject, CustomerOrderTransactionItem

Interface defining the operations for customer return line within the customer order domain. A return line manages the return of item quantity for an item which has been shipped for a particular order line.


Field Summary
static java.lang.String ACTUAL_RETURNED_QTY
           
static java.lang.String CAN_RELEASE_IMMEDIATELY
           
static java.lang.String CREATE_DATE
           
static java.lang.String EXPECTED_RETURN_QTY
           
static java.lang.String ORDER_LINE_TYPE
           
static java.lang.String REFUND_RECIPIENT_ADDRESS
           
static java.lang.String REFUND_TENDER_TYPE
           
static java.lang.String RETURN_DISPOSITION
           
static java.lang.String RETURN_REASON
           
static java.lang.String RETURN_REQUIRED
           
static java.lang.String RETURN_WAREHOUSE
           
static java.lang.String SHIPPED_CONTAINER
           
static java.lang.String STATE
           
 
Method Summary
 void cancel(OrderCancelReason reason, User user)
           
 Quantity getActualReturnedQty()
          Return the item quantity which was actually returned for the return line.
 java.lang.String getAuthorizationNumber()
           
 Money getCalculatedExtendedAdditionalShippingCharge()
          Return the calculated extended additional shipping charge for the return line (before any promotion adjustment is applied).
 Money getCalculatedExtendedAdditionalShippingTax()
          Return the calculated extended additional shipping tax for the return line (before any tax accommodation adjustments are applied).
 Money getCalculatedExtendedPrice()
          Return the calculated extended price (merchandise amount) for the return line (before any promotion adjustment is applied).
 Money getCalculatedExtendedTax()
          Return the calculated extended tax (merchandise tax) for the return line (before any tax accommodation adjustments are applied).
 Money getCalculatedGiftServiceCharge()
          Return the calculated gifting charge for the return line (before any promotion adjustment is applied).
 Money getCalculatedGiftServiceTax()
          Return the calculated gift service tax for the return line (before any tax accommodation adjustments are applied).
 Money getCalculatedPersonalizationServiceCharge()
          Return the calculated personalization charge for the return line (before any promotion adjustment is applied).
 Money getCalculatedPersonalizationServiceTax()
          Return the calculated personalization service tax for the return line (before any tax accommodation adjustments are applied).
 Money getCalculatedStandardShippingCharge()
          Return the calculated shipping charge for the return line (before any promotion adjustment is applied).
 Money getCalculatedStandardShippingTax()
          Return the calculated extended standard shipping tax for the return line (before any tax accommodation adjustments are applied).
 Money getCalculatedTotalLineTax()
          Return the calculated total tax for the return line.
 Money getCalculatedValueAddedServiceTax()
          Return the calculated value added service tax (personalization tax plus gifting tax) for the return line (before any tax accommodation adjustments are applied).
 RDate getCancelledDate()
           
 OrderCancelReason getCancelReason()
           
 java.lang.String getComment()
          Return comment for the return line.
 RDate getCreateDate()
           
 User getCreatedByUser()
           
 Quantity getExpectedReturnQty()
          Return the item quantity which is expected to be returned for the return line.
 CustomerAddress getGiftRefundRecipientAddress()
          Return the refund recipient address for the return line, returns null if a gift refund recipient is not applicable for the return.
 TenderType getGiftRefundTenderType()
          Return the refund tender type for the gift return line, returns null a gift refund recipient is not applicable for the return.
 User getLastUpdatedByUser()
           
 int getLineNumber()
          Return the order line number for the return line.
 CustomerOrder getOrder()
          Return the parent CustomerOrder for the return line.
 CustomerOrderLine getParentOrderLine()
          Return the original sale order line for the return line.
 CustomerOrderPayment getRefundCustomerOrderPayment()
           
 Money getRefundExtendedAdditionalShippingCharge()
          Return the refunded extended additional shipping charge for the return line (after any promotion adjustment is applied).
 Money getRefundExtendedAdditionalShippingTax()
          Return the refunded extended additional shipping tax for the return line.
 Money getRefundExtendedPrice()
          Return the refunded extended price (merchandise amount) for the return line (after any promotion and/or accommodation adjustment is applied).
 Money getRefundExtendedTax()
          Return the refunded extended tax (merchandise tax) for the return line.
 Money getRefundGiftServiceCharge()
          Return the refund gifting charge for the return line (after any promotion adjustment is applied).
 Money getRefundGiftServiceTax()
          Return the refunded gift service tax for the return line.
 Money getRefundPersonalizationServiceCharge()
          Return the calculated personalization charge for the return line (after any promotion adjustment is applied).
 Money getRefundPersonalizationServiceTax()
          Return the refunded personalization service tax for the return line.
 Money getRefundReturnPostage()
           
 Money getRefundStandardShippingCharge()
          Return the calculated shipping charge for the return line (after any promotion adjustment is applied).
 Money getRefundStandardShippingTax()
          Return the refunded standard shipping tax for the return line.
 Money getRefundTotalShippingTax()
          Return the refunded total shipping tax (additional shipping tax plus standard shipping tax) for the return line.
 Money getRefundTotalTax()
          Return the refunded total tax for the return line.
 Money getRefundValueAddedServiceTax()
          Return the refunded value added service tax (personalization tax plus gifting tax) for the return line.
 java.lang.String getRegistryNumber()
           
 java.lang.String getRegistryType()
           
 CustomerOrderLine getReplacementSaleLine()
          Return sibling replacement sale line for the return line (if the return line is a replacement return).
 Quantity getReturnableQuantity()
          Return the quantity that can be returned for a given order line (parent) considering the shipped quantity less any returned quantity for other return lines.
 SupplierReturnDisposition getReturnDisposition()
           
 RDate getReturnedDate()
          Return the date the item was returned (if return required is true) or the date the return was entered into the system (if return NOT required).
 java.util.Collection getReturnLineAccommodationAdjustments()
          Return any accommodation adjustments which were applied when calculating the refund amounts for the return line.
 java.util.Collection getReturnLinePromotionAdjustments()
          Return any promotion adjustments which were applied when calculating the refund amounts for the return line.
 ReturnLineType getReturnLineType()
          Return the type of return line (ex.
 Money getReturnPostage()
           
 ReturnReason getReturnReason()
          Return the reason for the item being returned.
 Warehouse getReturnToWarehouse()
           
 ExportState getSalesAuditExportState()
           
 RDate getSalesAuditTransactionDate()
           
 SellingSku getSellingSku()
           
 ShipTo getShipTo()
          Return the parent ship-to for the return line (ship-to for the original sale order line).
 NoCustomerInformationReturn getSourceNoCustomerInformationReturn()
          Return no customer information return source detail for the return line.
 com.retek.fsm.State getState()
           
 Money getTotalGeneralAccommodationAdjustmentAmount()
          Return the total amount of the accommodation adjustments for the return line.
 Money getTotalPromotionAdjustmentAmount()
          Return the total amount of the promotion adjustments for the return line.
 Money getTotalRefundAmount()
          Return the total refund amount for the return line.
 Money getTotalRefundValueAddedServiceCharge()
          Return the total refunded value added service charge (personalization charge plus gifting charge) for the return line.
 Money getTotalTaxAccomodationAdjustmentAmount()
          Return the total amount of the accommodation tax adjustments for the return line.
 Money getTotalValueAddedServiceCharge()
          Return the total refunded value added service charge (personalization charge plus gifting charge) for the return line.
 boolean hasReplacementSaleThatIsNotCancellable()
          A Replacement Return is associated to a Replacement Sale order line.
 boolean isCancellable()
           
 boolean isCancelled()
           
 boolean isGiftReturn()
          GiftReturn ONLY pertains to Zero Sale Return Lines.
 boolean isModifiable()
           
 boolean isNew()
           
 boolean isPendingReturn()
           
 boolean isPreReturned()
           
 boolean isReleaseImmediately()
          A sale associated with a Return is normally not allowed to be released to the warehouse for fullment until the Return is received from the customer.
 boolean isReturned()
           
 boolean isReturnRequired()
          Return boolean indicating whether it is required for the item to be returned by the customer for the return line.
 boolean isSalesAuditPaidInExported()
           
 void setActualReturnedQty(Quantity qty)
          The actual quanitity returned by the customer can be different than the expected quantity for various reasons (the customer may have returned the items in two or more shipping packages, the customer may have changed their mind and returned less or more than he/she indicated).
 void setComment(java.lang.String returnComment)
           
 void setExpectedReturnQty(Quantity qty)
          The expected return quanitity is the number of items that the customer indicates he/she is planning on returning.
 void setGiftRefundRecipientAddress(CustomerAddress recipientAddress)
          Set the refund recipient for the return line refund (applicable if the return is for a gift return).
 void setGiftRefundTenderType(TenderType refundTenderType)
          Set the refund tender type return line refund (applicable if the return is for a gift return).
 void setGiftReturn(boolean giftReturn)
          GiftReturn ONLY pertains to Zero Sale Return Lines.
 void setRefundReturnPostage(Money refundReturnPostage)
           
 void setReleaseImmediately(boolean immediateRelease)
          A sale associated with a Return is normally not allowed to be released to the warehouse for fullment until the Return is received from the customer.
 void setReturnPostage(Money returnPostage)
           
 void setReturnReason(ReturnReason returnReason)
           
 void setReturnRequired(boolean returnRequired)
          Return shipping charges may be more that the cost of an item.
 void setSalesAuditExportState(ExportState state)
           
 void setSalesAuditPaidInExported(boolean exportedSalesAuditPaidIn)
           
 
Methods inherited from interface com.retek.commons.component.DistributedObject
debugToString, discardChanges, getContext, getId, getReference, isDeleted, isDirty, isDirtyDeep, isDirtyIgnoreFields, isPersisted, refresh
 
Methods inherited from interface com.retek.commons.component.BusinessObject
getBusinessInterface
 
Methods inherited from interface com.retek.component.customerorder.CustomerOrderTransactionItem
getTransactionGroup, getTransactionItemAmount, isCreditForTransactionGroupBalance, isDebitForTransactionGroupBalance, isExchangeSaleLine, isInClosedTransactionGroup, isReplacementSaleLine, notifyTransactionGroupClosed, setTransactionGroup
 

Field Detail

RETURN_REASON

public static final java.lang.String RETURN_REASON
See Also:
Constant Field Values

EXPECTED_RETURN_QTY

public static final java.lang.String EXPECTED_RETURN_QTY
See Also:
Constant Field Values

ACTUAL_RETURNED_QTY

public static final java.lang.String ACTUAL_RETURNED_QTY
See Also:
Constant Field Values

SHIPPED_CONTAINER

public static final java.lang.String SHIPPED_CONTAINER
See Also:
Constant Field Values

CREATE_DATE

public static final java.lang.String CREATE_DATE
See Also:
Constant Field Values

ORDER_LINE_TYPE

public static final java.lang.String ORDER_LINE_TYPE
See Also:
Constant Field Values

RETURN_REQUIRED

public static final java.lang.String RETURN_REQUIRED
See Also:
Constant Field Values

CAN_RELEASE_IMMEDIATELY

public static final java.lang.String CAN_RELEASE_IMMEDIATELY
See Also:
Constant Field Values

REFUND_RECIPIENT_ADDRESS

public static final java.lang.String REFUND_RECIPIENT_ADDRESS
See Also:
Constant Field Values

REFUND_TENDER_TYPE

public static final java.lang.String REFUND_TENDER_TYPE
See Also:
Constant Field Values

RETURN_DISPOSITION

public static final java.lang.String RETURN_DISPOSITION
See Also:
Constant Field Values

STATE

public static final java.lang.String STATE
See Also:
Constant Field Values

RETURN_WAREHOUSE

public static final java.lang.String RETURN_WAREHOUSE
See Also:
Constant Field Values
Method Detail

getExpectedReturnQty

public Quantity getExpectedReturnQty()
                              throws SystemException
Return the item quantity which is expected to be returned for the return line.

Returns:
Quantity expected item qty to be returned
Throws:
SystemException

getActualReturnedQty

public Quantity getActualReturnedQty()
                              throws SystemException
Return the item quantity which was actually returned for the return line.

Returns:
Quantity actual item qty that was returned
Throws:
SystemException

getReturnReason

public ReturnReason getReturnReason()
                             throws SystemException
Return the reason for the item being returned. The return reason will determine which portions of charges/taxes will be refunded to the customer.

Returns:
ReturnReason reason item was returned
Throws:
SystemException

isReturnRequired

public boolean isReturnRequired()
                         throws SystemException
Return boolean indicating whether it is required for the item to be returned by the customer for the return line. If return is required the item must be received and confirmed through the WMS before the return line is marked in 'returned' status and before the associative refund will be released to the customer.

Returns:
boolean true item return is required by customer
Throws:
SystemException

getReturnedDate

public RDate getReturnedDate()
                      throws SystemException
Return the date the item was returned (if return required is true) or the date the return was entered into the system (if return NOT required).

Returns:
RDate date that return line was marked as 'returned'
Throws:
SystemException

getComment

public java.lang.String getComment()
                            throws SystemException
Return comment for the return line. Comment is entered by the CSR when creating the return line instance.

Returns:
String return line comment
Throws:
SystemException

getSourceNoCustomerInformationReturn

public NoCustomerInformationReturn getSourceNoCustomerInformationReturn()
                                                                 throws SystemException
Return no customer information return source detail for the return line. Will only return a non-null value if the return was originated through the no customer information return process. Will return null for most return lines.

Returns:
NoCustomerInformationReturn source no customer info. return detail
Throws:
SystemException

getReturnableQuantity

public Quantity getReturnableQuantity()
                               throws SystemException
Return the quantity that can be returned for a given order line (parent) considering the shipped quantity less any returned quantity for other return lines.

Returns:
Quantity available returnable quantity for parent order line
Throws:
SystemException

getOrder

public CustomerOrder getOrder()
                       throws SystemException
Return the parent CustomerOrder for the return line.

Returns:
CustomerOrder order which contains the return line
Throws:
SystemException

getReplacementSaleLine

public CustomerOrderLine getReplacementSaleLine()
                                         throws SystemException
Return sibling replacement sale line for the return line (if the return line is a replacement return). Will return null for non-replacement returns (ex. normal, exchange return).

Returns:
CustomerOrderLine sibling replacement sale line
Throws:
SystemException

getParentOrderLine

public CustomerOrderLine getParentOrderLine()
                                     throws SystemException
Return the original sale order line for the return line. This is the original order line which captured the sale for the item being returned.

Returns:
CustomerOrderLine original sale order line (parent)
Throws:
SystemException

getShipTo

public ShipTo getShipTo()
                 throws SystemException
Return the parent ship-to for the return line (ship-to for the original sale order line).

Returns:
ShipTo parent ship-to
Throws:
SystemException

getLineNumber

public int getLineNumber()
                  throws SystemException
Return the order line number for the return line. This is the sequential line number used during display in RCOM.

Returns:
int line number
Throws:
SystemException

getReturnLineType

public ReturnLineType getReturnLineType()
                                 throws SystemException
Return the type of return line (ex. normal, exchange return, replacement return, etc.).

Returns:
ReturnLineType return line type
Throws:
SystemException

getCalculatedExtendedPrice

public Money getCalculatedExtendedPrice()
                                 throws SystemException
Return the calculated extended price (merchandise amount) for the return line (before any promotion adjustment is applied).

Returns:
Money unit price * return qty
Throws:
SystemException

getCalculatedExtendedAdditionalShippingCharge

public Money getCalculatedExtendedAdditionalShippingCharge()
                                                    throws SystemException
Return the calculated extended additional shipping charge for the return line (before any promotion adjustment is applied).

Returns:
Money additional shipping * return qty
Throws:
SystemException

getCalculatedExtendedTax

public Money getCalculatedExtendedTax()
                               throws SystemException
Return the calculated extended tax (merchandise tax) for the return line (before any tax accommodation adjustments are applied).

Returns:
Money calculated extended tax (merchandise tax)
Throws:
SystemException

getCalculatedTotalLineTax

public Money getCalculatedTotalLineTax()
                                throws SystemException
Return the calculated total tax for the return line.

Returns:
Money calculated total tax
Throws:
SystemException

getRefundExtendedTax

public Money getRefundExtendedTax()
                           throws SystemException
Return the refunded extended tax (merchandise tax) for the return line.

Returns:
Money refunded extended tax (merchandise tax)
Throws:
SystemException

getCalculatedExtendedAdditionalShippingTax

public Money getCalculatedExtendedAdditionalShippingTax()
                                                 throws SystemException
Return the calculated extended additional shipping tax for the return line (before any tax accommodation adjustments are applied).

Returns:
Money calculated extended additional shipping tax
Throws:
SystemException

getRefundExtendedAdditionalShippingTax

public Money getRefundExtendedAdditionalShippingTax()
                                             throws SystemException
Return the refunded extended additional shipping tax for the return line.

Returns:
Money refunded extended additional shipping tax
Throws:
SystemException

getCalculatedPersonalizationServiceCharge

public Money getCalculatedPersonalizationServiceCharge()
                                                throws SystemException
Return the calculated personalization charge for the return line (before any promotion adjustment is applied).

Returns:
Money calculated personalization charge
Throws:
SystemException

getCalculatedGiftServiceCharge

public Money getCalculatedGiftServiceCharge()
                                     throws SystemException
Return the calculated gifting charge for the return line (before any promotion adjustment is applied).

Returns:
Money calculated gifting charge
Throws:
SystemException

getTotalValueAddedServiceCharge

public Money getTotalValueAddedServiceCharge()
                                      throws SystemException
Return the total refunded value added service charge (personalization charge plus gifting charge) for the return line.

Returns:
Money refunded vas charge
Throws:
SystemException

getCalculatedValueAddedServiceTax

public Money getCalculatedValueAddedServiceTax()
                                        throws SystemException
Return the calculated value added service tax (personalization tax plus gifting tax) for the return line (before any tax accommodation adjustments are applied).

Returns:
Money calculated value added service tax
Throws:
SystemException

getCalculatedPersonalizationServiceTax

public Money getCalculatedPersonalizationServiceTax()
                                             throws SystemException
Return the calculated personalization service tax for the return line (before any tax accommodation adjustments are applied).

Returns:
Money calculated personalization service tax
Throws:
SystemException

getCalculatedGiftServiceTax

public Money getCalculatedGiftServiceTax()
                                  throws SystemException
Return the calculated gift service tax for the return line (before any tax accommodation adjustments are applied).

Returns:
Money calculated gift service tax
Throws:
SystemException

getRefundValueAddedServiceTax

public Money getRefundValueAddedServiceTax()
                                    throws SystemException
Return the refunded value added service tax (personalization tax plus gifting tax) for the return line.

Returns:
Money refunded value added service tax
Throws:
SystemException

getRefundPersonalizationServiceTax

public Money getRefundPersonalizationServiceTax()
                                         throws SystemException
Return the refunded personalization service tax for the return line.

Returns:
Money refunded personalization service tax
Throws:
SystemException

getRefundGiftServiceTax

public Money getRefundGiftServiceTax()
                              throws SystemException
Return the refunded gift service tax for the return line.

Returns:
Money refunded gift service tax
Throws:
SystemException

getCalculatedStandardShippingCharge

public Money getCalculatedStandardShippingCharge()
                                          throws SystemException
Return the calculated shipping charge for the return line (before any promotion adjustment is applied).

Returns:
Money calculated shipping charge
Throws:
SystemException

getCalculatedStandardShippingTax

public Money getCalculatedStandardShippingTax()
                                       throws SystemException
Return the calculated extended standard shipping tax for the return line (before any tax accommodation adjustments are applied).

Returns:
Money calculated standard shipping tax
Throws:
SystemException

getRefundStandardShippingTax

public Money getRefundStandardShippingTax()
                                   throws SystemException
Return the refunded standard shipping tax for the return line.

Returns:
Money refunded standard shipping tax
Throws:
SystemException

getRefundTotalShippingTax

public Money getRefundTotalShippingTax()
                                throws SystemException
Return the refunded total shipping tax (additional shipping tax plus standard shipping tax) for the return line.

Returns:
Money refunded total shipping tax
Throws:
SystemException

getRefundTotalTax

public Money getRefundTotalTax()
                        throws SystemException
Return the refunded total tax for the return line.

Returns:
Money refunded total tax
Throws:
SystemException

getRefundExtendedPrice

public Money getRefundExtendedPrice()
                             throws SystemException
Return the refunded extended price (merchandise amount) for the return line (after any promotion and/or accommodation adjustment is applied).

Returns:
Money unit price * return qty - promotion adjustment
Throws:
SystemException

getTotalRefundValueAddedServiceCharge

public Money getTotalRefundValueAddedServiceCharge()
                                            throws SystemException
Return the total refunded value added service charge (personalization charge plus gifting charge) for the return line.

Returns:
Money refunded vas charge
Throws:
SystemException

getRefundStandardShippingCharge

public Money getRefundStandardShippingCharge()
                                      throws SystemException
Return the calculated shipping charge for the return line (after any promotion adjustment is applied).

Returns:
Money calculated shipping charge - promotion adjustment
Throws:
SystemException

getRefundExtendedAdditionalShippingCharge

public Money getRefundExtendedAdditionalShippingCharge()
                                                throws SystemException
Return the refunded extended additional shipping charge for the return line (after any promotion adjustment is applied).

Returns:
Money additional shipping * return qty - promotion adjustment
Throws:
SystemException

getRefundPersonalizationServiceCharge

public Money getRefundPersonalizationServiceCharge()
                                            throws SystemException
Return the calculated personalization charge for the return line (after any promotion adjustment is applied).

Returns:
Money calculated personalization charge - promotion adjustment
Throws:
SystemException

getRefundGiftServiceCharge

public Money getRefundGiftServiceCharge()
                                 throws SystemException
Return the refund gifting charge for the return line (after any promotion adjustment is applied).

Returns:
Money calculated gifting charge - promotion adjustment
Throws:
SystemException

getTotalPromotionAdjustmentAmount

public Money getTotalPromotionAdjustmentAmount()
                                        throws SystemException
Return the total amount of the promotion adjustments for the return line. This is the amount that the total refund amount was adjusted down due to promotions on the original (parent) order line.

Returns:
Money total promotion adjustment amount
Throws:
SystemException

getTotalRefundAmount

public Money getTotalRefundAmount()
                           throws SystemException
Return the total refund amount for the return line. Computed total refund for all the refund charges and taxes.

Returns:
Money total refund amount and tax
Throws:
SystemException

getReturnLinePromotionAdjustments

public java.util.Collection getReturnLinePromotionAdjustments()
                                                       throws SystemException
Return any promotion adjustments which were applied when calculating the refund amounts for the return line.

Returns:
Collection of return line promotion adjustments
Throws:
SystemException

getSellingSku

public SellingSku getSellingSku()
                         throws SystemException
Throws:
SystemException

getReturnDisposition

public SupplierReturnDisposition getReturnDisposition()
                                               throws SystemException
Throws:
SystemException

getReturnToWarehouse

public Warehouse getReturnToWarehouse()
                               throws SystemException
Throws:
SystemException

getAuthorizationNumber

public java.lang.String getAuthorizationNumber()
                                        throws SystemException
Throws:
SystemException

getState

public com.retek.fsm.State getState()
                             throws SystemException
Throws:
SystemException

getCreateDate

public RDate getCreateDate()
                    throws SystemException
Throws:
SystemException

getCancelledDate

public RDate getCancelledDate()
                       throws SystemException
Throws:
SystemException

getCancelReason

public OrderCancelReason getCancelReason()
                                  throws SystemException
Throws:
SystemException

getGiftRefundRecipientAddress

public CustomerAddress getGiftRefundRecipientAddress()
                                              throws SystemException
Return the refund recipient address for the return line, returns null if a gift refund recipient is not applicable for the return.

Returns:
CustomerAddress gift refund recipient address
Throws:
SystemException

getGiftRefundTenderType

public TenderType getGiftRefundTenderType()
                                   throws SystemException
Return the refund tender type for the gift return line, returns null a gift refund recipient is not applicable for the return.

Returns:
TenderType gift refund tender type
Throws:
SystemException

isReleaseImmediately

public boolean isReleaseImmediately()
                             throws SystemException
A sale associated with a Return is normally not allowed to be released to the warehouse for fullment until the Return is received from the customer. This can be overridden in certain circumstances.

Returns:
boolean indicator whether the sale can be released before the Return line is returned.
Throws:
SystemException

isGiftReturn

public boolean isGiftReturn()
                     throws SystemException
GiftReturn ONLY pertains to Zero Sale Return Lines. GiftReturn does NOT indicate whether the shipTo customer is a gift recipient on the parent order line.

Throws:
SystemException

isNew

public boolean isNew()
              throws SystemException
Throws:
SystemException

isPendingReturn

public boolean isPendingReturn()
                        throws SystemException
Throws:
SystemException

isPreReturned

public boolean isPreReturned()
                      throws SystemException
Throws:
SystemException

isReturned

public boolean isReturned()
                   throws SystemException
Throws:
SystemException

isCancelled

public boolean isCancelled()
                    throws SystemException
Throws:
SystemException

isModifiable

public boolean isModifiable()
                     throws SystemException
Throws:
SystemException

isCancellable

public boolean isCancellable()
                      throws SystemException
Throws:
SystemException

hasReplacementSaleThatIsNotCancellable

public boolean hasReplacementSaleThatIsNotCancellable()
                                               throws SystemException
A Replacement Return is associated to a Replacement Sale order line. The Replacement Sale cannot be cancelled if any part of it has been shipped or sent to the warehouse for fullfillment.

Returns:
boolean indicator whether the Replacement Sale can be cancelled
Throws:
SystemException

cancel

public void cancel(OrderCancelReason reason,
                   User user)
            throws SystemException,
                   BusinessException
Throws:
SystemException
BusinessException

setExpectedReturnQty

public void setExpectedReturnQty(Quantity qty)
                          throws SystemException,
                                 BusinessException
The expected return quanitity is the number of items that the customer indicates he/she is planning on returning.

Parameters:
qty - the number of items expected to be returned to the warehouse
Throws:
SystemException
BusinessException

setActualReturnedQty

public void setActualReturnedQty(Quantity qty)
                          throws SystemException,
                                 BusinessException
The actual quanitity returned by the customer can be different than the expected quantity for various reasons (the customer may have returned the items in two or more shipping packages, the customer may have changed their mind and returned less or more than he/she indicated). Whenever a return is processed in RCOM, the return is moved into a final state of closed. If the warehouse receives any subsequent returns, they create a new return line for the additional returns.

Parameters:
qty - the number of items actually returned to the warehouse
Throws:
SystemException
BusinessException

setReturnReason

public void setReturnReason(ReturnReason returnReason)
                     throws SystemException,
                            BusinessException
Throws:
SystemException
BusinessException

setReturnRequired

public void setReturnRequired(boolean returnRequired)
                       throws SystemException,
                              BusinessException
Return shipping charges may be more that the cost of an item. In this case, we indicate that the customer does not have to return the item (the customer gets credited for the return immediately rather than having to wait until the return in received by the warehouse).

Parameters:
returnRequired - indicates if the return must be returned by the customer
Throws:
SystemException
BusinessException

setGiftReturn

public void setGiftReturn(boolean giftReturn)
                   throws SystemException
GiftReturn ONLY pertains to Zero Sale Return Lines. GiftReturn does NOT indicate whether the shipTo customer is a gift recipient on the parent order line.

Throws:
SystemException

setComment

public void setComment(java.lang.String returnComment)
                throws SystemException
Throws:
SystemException

setReleaseImmediately

public void setReleaseImmediately(boolean immediateRelease)
                           throws SystemException,
                                  BusinessException
A sale associated with a Return is normally not allowed to be released to the warehouse for fullment until the Return is received from the customer. This method allows this rule to be overridden.

Throws:
SystemException
BusinessException

setGiftRefundRecipientAddress

public void setGiftRefundRecipientAddress(CustomerAddress recipientAddress)
                                   throws SystemException,
                                          BusinessException
Set the refund recipient for the return line refund (applicable if the return is for a gift return).

Parameters:
recipientAddress - gift recipient customer address
Throws:
SystemException
BusinessException

setGiftRefundTenderType

public void setGiftRefundTenderType(TenderType refundTenderType)
                             throws SystemException,
                                    BusinessException
Set the refund tender type return line refund (applicable if the return is for a gift return).

Parameters:
refundTenderType - gift refund tender type
Throws:
SystemException
BusinessException

getRegistryType

public java.lang.String getRegistryType()
                                 throws SystemException
Throws:
SystemException

getRegistryNumber

public java.lang.String getRegistryNumber()
                                   throws SystemException
Throws:
SystemException

setReturnPostage

public void setReturnPostage(Money returnPostage)
                      throws SystemException
Throws:
SystemException

getReturnPostage

public Money getReturnPostage()
                       throws SystemException
Throws:
SystemException

setRefundReturnPostage

public void setRefundReturnPostage(Money refundReturnPostage)
                            throws SystemException
Throws:
SystemException

getRefundReturnPostage

public Money getRefundReturnPostage()
                             throws SystemException
Throws:
SystemException

getTotalGeneralAccommodationAdjustmentAmount

public Money getTotalGeneralAccommodationAdjustmentAmount()
                                                   throws SystemException
Return the total amount of the accommodation adjustments for the return line. This is the amount that the total refund amount was adjusted down due to order line (merch) accommodations on the original (parent) order line.

Returns:
Money total accommodation adjustment amount
Throws:
SystemException

getTotalTaxAccomodationAdjustmentAmount

public Money getTotalTaxAccomodationAdjustmentAmount()
                                              throws SystemException
Return the total amount of the accommodation tax adjustments for the return line. This is the amount that the total refund tax amount was adjusted down due to previous tax credits for accommodations and for line tax accommodations on the original (parent) order line.

Returns:
Money total tax adjustment amount
Throws:
SystemException

getReturnLineAccommodationAdjustments

public java.util.Collection getReturnLineAccommodationAdjustments()
                                                           throws SystemException
Return any accommodation adjustments which were applied when calculating the refund amounts for the return line.

Returns:
Set return line promotion adjustments
Throws:
SystemException

getCreatedByUser

public User getCreatedByUser()
                      throws SystemException
Throws:
SystemException

getLastUpdatedByUser

public User getLastUpdatedByUser()
                          throws SystemException
Throws:
SystemException

getSalesAuditExportState

public ExportState getSalesAuditExportState()
                                     throws SystemException
Throws:
SystemException

setSalesAuditExportState

public void setSalesAuditExportState(ExportState state)
                              throws SystemException
Throws:
SystemException

getSalesAuditTransactionDate

public RDate getSalesAuditTransactionDate()
                                   throws SystemException
Throws:
SystemException

setSalesAuditPaidInExported

public void setSalesAuditPaidInExported(boolean exportedSalesAuditPaidIn)
                                 throws SystemException
Throws:
SystemException

isSalesAuditPaidInExported

public boolean isSalesAuditPaidInExported()
                                   throws SystemException
Throws:
SystemException

getRefundCustomerOrderPayment

public CustomerOrderPayment getRefundCustomerOrderPayment()
                                                   throws SystemException
Throws:
SystemException


Copyright © 2004 Retek Inc. All Rights Reserved. - Generated at Fri, 10/22/2004 07:28