com.retek.component.customerorder
Interface Accommodation

All Superinterfaces:
BusinessObject, CustomerOrderTransactionItem, DistributedObject
All Known Subinterfaces:
CustomerOrderLineTaxAccommodation, CustomerOrderTaxAccommodation, GeneralAccommodation, TaxAccommodation
All Known Implementing Classes:
AccommodationImpl, CustomerOrderLineTaxAccommodationImpl, CustomerOrderTaxAccommodationImpl, GeneralAccommodationImpl, TaxAccommodationImpl

public interface Accommodation
extends DistributedObject, CustomerOrderTransactionItem

This class represents an adjustment to a CustomerOrder that is in the customer's favor (money back to the customer). Accommodations can be applied at the order or order line level, and can be represented by a flat $ off amount, or % off amount.


Field Summary
static java.lang.String ORDER
           
static java.lang.String ORDER_LINE
           
static java.lang.String REASON
           
static java.lang.String VALUE
           
static java.lang.String ZERO_SALE_LINE
           
 
Method Summary
 void calculateAmount()
           
 Money getAccommodationAmount()
           
 AccommodationScopeEnum getAccommodationScope()
           
 AccommodationTypeEnum getAccommodationType()
           
 User getCreatedByUser()
           
 CustomerOrder getCustomerOrder()
           
 CustomerOrderLine getCustomerOrderLine()
           
 RDate getDate()
           
 java.lang.String getDescription()
           
 java.lang.String getHistoryEventDetail()
           
 User getLastUpdatedByUser()
           
 CustomerOrderPaymentTransactionType getPaymentTransactionType()
           
 AccommodationReason getReason()
           
 ExportState getSalesAuditExportState()
           
 RDate getSalesAuditTransactionDate()
           
 Money getTaxAmount()
           
 boolean isAppliedPreShipment()
           
 boolean isVertexTaxCreditGenerated()
           
 void setAppliedPreShipment(boolean isAppliedPreShipment)
           
 void setReason(AccommodationReason reason)
           
 void setSalesAuditExportState(ExportState exportState)
           
 void setSalesAuditTransactionDate(RDate salesAuditTransactionDate)
           
 void setVertexTaxCreditGenerated(boolean isGenerated)
           
 
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

REASON

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

VALUE

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

ORDER_LINE

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

ZERO_SALE_LINE

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

ORDER

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

getAccommodationType

public AccommodationTypeEnum getAccommodationType()
                                           throws SystemException
Throws:
SystemException

getAccommodationScope

public AccommodationScopeEnum getAccommodationScope()
                                             throws SystemException
Throws:
SystemException

getCustomerOrder

public CustomerOrder getCustomerOrder()
                               throws SystemException
Throws:
SystemException

getCustomerOrderLine

public CustomerOrderLine getCustomerOrderLine()
                                       throws SystemException
Throws:
SystemException

getDate

public RDate getDate()
              throws SystemException
Throws:
SystemException

getReason

public AccommodationReason getReason()
                              throws SystemException
Throws:
SystemException

getDescription

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

getAccommodationAmount

public Money getAccommodationAmount()
                             throws SystemException
Throws:
SystemException

getTaxAmount

public Money getTaxAmount()
                   throws SystemException
Throws:
SystemException

getHistoryEventDetail

public java.lang.String getHistoryEventDetail()
                                       throws SystemException,
                                              BusinessException
Throws:
SystemException
BusinessException

getPaymentTransactionType

public CustomerOrderPaymentTransactionType getPaymentTransactionType()
                                                              throws SystemException
Throws:
SystemException

setReason

public void setReason(AccommodationReason reason)
               throws SystemException
Throws:
SystemException

setVertexTaxCreditGenerated

public void setVertexTaxCreditGenerated(boolean isGenerated)
                                 throws SystemException
Throws:
SystemException

isVertexTaxCreditGenerated

public boolean isVertexTaxCreditGenerated()
                                   throws SystemException
Throws:
SystemException

setAppliedPreShipment

public void setAppliedPreShipment(boolean isAppliedPreShipment)
                           throws SystemException
Throws:
SystemException

isAppliedPreShipment

public boolean isAppliedPreShipment()
                             throws SystemException
Throws:
SystemException

calculateAmount

public void calculateAmount()
                     throws SystemException,
                            BusinessException
Throws:
SystemException
BusinessException

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 exportState)
                              throws SystemException
Throws:
SystemException

getSalesAuditTransactionDate

public RDate getSalesAuditTransactionDate()
                                   throws SystemException
Throws:
SystemException

setSalesAuditTransactionDate

public void setSalesAuditTransactionDate(RDate salesAuditTransactionDate)
                                  throws SystemException
Throws:
SystemException


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