|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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_TO_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 |
public static final java.lang.String RETURN_REASON
public static final java.lang.String EXPECTED_RETURN_QTY
public static final java.lang.String ACTUAL_RETURNED_QTY
public static final java.lang.String SHIPPED_CONTAINER
public static final java.lang.String CREATE_DATE
public static final java.lang.String ORDER_LINE_TYPE
public static final java.lang.String RETURN_REQUIRED
public static final java.lang.String CAN_RELEASE_IMMEDIATELY
public static final java.lang.String REFUND_RECIPIENT_ADDRESS
public static final java.lang.String REFUND_TENDER_TYPE
public static final java.lang.String RETURN_DISPOSITION
public static final java.lang.String STATE
public static final java.lang.String RETURN_TO_WAREHOUSE
Method Detail |
public Quantity getExpectedReturnQty() throws SystemException
SystemException
public Quantity getActualReturnedQty() throws SystemException
SystemException
public ReturnReason getReturnReason() throws SystemException
SystemException
public boolean isReturnRequired() throws SystemException
SystemException
public RDate getReturnedDate() throws SystemException
SystemException
public java.lang.String getComment() throws SystemException
SystemException
public NoCustomerInformationReturn getSourceNoCustomerInformationReturn() throws SystemException
SystemException
public Quantity getReturnableQuantity() throws SystemException
SystemException
public CustomerOrder getOrder() throws SystemException
SystemException
public CustomerOrderLine getReplacementSaleLine() throws SystemException
SystemException
public CustomerOrderLine getParentOrderLine() throws SystemException
SystemException
public ShipTo getShipTo() throws SystemException
SystemException
public int getLineNumber() throws SystemException
SystemException
public ReturnLineType getReturnLineType() throws SystemException
SystemException
public Money getCalculatedExtendedPrice() throws SystemException
SystemException
public Money getCalculatedExtendedAdditionalShippingCharge() throws SystemException
SystemException
public Money getCalculatedExtendedTax() throws SystemException
SystemException
public Money getCalculatedTotalLineTax() throws SystemException
SystemException
public Money getRefundExtendedTax() throws SystemException
SystemException
public Money getCalculatedExtendedAdditionalShippingTax() throws SystemException
SystemException
public Money getRefundExtendedAdditionalShippingTax() throws SystemException
SystemException
public Money getCalculatedPersonalizationServiceCharge() throws SystemException
SystemException
public Money getCalculatedGiftServiceCharge() throws SystemException
SystemException
public Money getTotalValueAddedServiceCharge() throws SystemException
SystemException
public Money getCalculatedValueAddedServiceTax() throws SystemException
SystemException
public Money getCalculatedPersonalizationServiceTax() throws SystemException
SystemException
public Money getCalculatedGiftServiceTax() throws SystemException
SystemException
public Money getRefundValueAddedServiceTax() throws SystemException
SystemException
public Money getRefundPersonalizationServiceTax() throws SystemException
SystemException
public Money getRefundGiftServiceTax() throws SystemException
SystemException
public Money getCalculatedStandardShippingCharge() throws SystemException
SystemException
public Money getCalculatedStandardShippingTax() throws SystemException
SystemException
public Money getRefundStandardShippingTax() throws SystemException
SystemException
public Money getRefundTotalShippingTax() throws SystemException
SystemException
public Money getRefundTotalTax() throws SystemException
SystemException
public Money getRefundExtendedPrice() throws SystemException
SystemException
public Money getTotalRefundValueAddedServiceCharge() throws SystemException
SystemException
public Money getRefundStandardShippingCharge() throws SystemException
SystemException
public Money getRefundExtendedAdditionalShippingCharge() throws SystemException
SystemException
public Money getRefundPersonalizationServiceCharge() throws SystemException
SystemException
public Money getRefundGiftServiceCharge() throws SystemException
SystemException
public Money getTotalPromotionAdjustmentAmount() throws SystemException
SystemException
public Money getTotalRefundAmount() throws SystemException
SystemException
public java.util.Collection getReturnLinePromotionAdjustments() throws SystemException
SystemException
public SellingSku getSellingSku() throws SystemException
SystemException
public SupplierReturnDisposition getReturnDisposition() throws SystemException
SystemException
public Warehouse getReturnToWarehouse() throws SystemException
SystemException
public java.lang.String getAuthorizationNumber() throws SystemException
SystemException
public com.retek.fsm.State getState() throws SystemException
SystemException
public RDate getCreateDate() throws SystemException
SystemException
public RDate getCancelledDate() throws SystemException
SystemException
public OrderCancelReason getCancelReason() throws SystemException
SystemException
public CustomerAddress getGiftRefundRecipientAddress() throws SystemException
SystemException
public TenderType getGiftRefundTenderType() throws SystemException
SystemException
public boolean isReleaseImmediately() throws SystemException
SystemException
public boolean isGiftReturn() throws SystemException
SystemException
public boolean isNew() throws SystemException
SystemException
public boolean isPendingReturn() throws SystemException
SystemException
public boolean isPreReturned() throws SystemException
SystemException
public boolean isReturned() throws SystemException
SystemException
public boolean isCancelled() throws SystemException
SystemException
public boolean isModifiable() throws SystemException
SystemException
public boolean isCancellable() throws SystemException
SystemException
public boolean hasReplacementSaleThatIsNotCancellable() throws SystemException
SystemException
public void cancel(OrderCancelReason reason, User user) throws SystemException, BusinessException
SystemException
BusinessException
public void setExpectedReturnQty(Quantity qty) throws SystemException, BusinessException
qty
- the number of items expected to be returned to the warehouse
SystemException
BusinessException
public void setActualReturnedQty(Quantity qty) throws SystemException, BusinessException
qty
- the number of items actually returned to the warehouse
SystemException
BusinessException
public void setReturnReason(ReturnReason returnReason) throws SystemException, BusinessException
SystemException
BusinessException
public void setReturnRequired(boolean returnRequired) throws SystemException, BusinessException
returnRequired
- indicates if the return must be returned by the customer
SystemException
BusinessException
public void setGiftReturn(boolean giftReturn) throws SystemException
SystemException
public void setComment(java.lang.String returnComment) throws SystemException
SystemException
public void setReleaseImmediately(boolean immediateRelease) throws SystemException, BusinessException
SystemException
BusinessException
public void setGiftRefundRecipientAddress(CustomerAddress recipientAddress) throws SystemException, BusinessException
recipientAddress
- gift recipient customer address
SystemException
BusinessException
public void setGiftRefundTenderType(TenderType refundTenderType) throws SystemException, BusinessException
refundTenderType
- gift refund tender type
SystemException
BusinessException
public java.lang.String getRegistryType() throws SystemException
SystemException
public java.lang.String getRegistryNumber() throws SystemException
SystemException
public void setReturnPostage(Money returnPostage) throws SystemException
SystemException
public Money getReturnPostage() throws SystemException
SystemException
public void setRefundReturnPostage(Money refundReturnPostage) throws SystemException
SystemException
public Money getRefundReturnPostage() throws SystemException
SystemException
public Money getTotalGeneralAccommodationAdjustmentAmount() throws SystemException
SystemException
public Money getTotalTaxAccomodationAdjustmentAmount() throws SystemException
SystemException
public java.util.Collection getReturnLineAccommodationAdjustments() throws SystemException
SystemException
public User getCreatedByUser() throws SystemException
SystemException
public User getLastUpdatedByUser() throws SystemException
SystemException
public ExportState getSalesAuditExportState() throws SystemException
SystemException
public void setSalesAuditExportState(ExportState state) throws SystemException
SystemException
public RDate getSalesAuditTransactionDate() throws SystemException
SystemException
public void setSalesAuditPaidInExported(boolean exportedSalesAuditPaidIn) throws SystemException
SystemException
public boolean isSalesAuditPaidInExported() throws SystemException
SystemException
public CustomerOrderPayment getRefundCustomerOrderPayment() throws SystemException
SystemException
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |