com.retek.component.internet
Interface ExAOrderLine

All Superinterfaces:
ExAOrderLineRequest

public interface ExAOrderLine
extends ExAOrderLineRequest

This is a high level interface which maintains OrderLine information for the external API. This controls all data related to the Lines submitted on an ExAOrder.

Retek Inc. Copyright (c) 2003


Field Summary
static java.lang.String BACKORDERED_STATE
           
static java.lang.String CANCEL_REQUEST
           
static java.lang.String CANCELLED_STATE
           
static java.lang.String FULFILLING_STATE
           
static java.lang.String NEW_STATE
           
static java.lang.String RESERVED_STATE
           
static java.lang.String RESERVING_STATE
           
static java.lang.String SHIPPED_STATE
           
 
Method Summary
 void cancel(ExAOrderCancelReason cancelReason)
          Cancels this order line with the specified ExAOrderCancelReason.
 java.math.BigDecimal getBackorderedQuantity()
          Returns the quantity in Backordered status.
 java.math.BigDecimal getCancelledQuantity()
          Returns the quantity in cancelled status.
 ExAOrderCancelReason getCancelReason()
          Cancel Reason
 java.lang.String getCarrier()
          The carrier display code.
 java.util.Date getEstimatedDeliveryDate()
          Returns the estimate date the orderline will reach the customer.
 java.util.Date getEstimatedShipDate()
          Returns the estimate date the orderline will be shipped
 java.math.BigDecimal getExtendedPrice()
          Returns the unit price multiplied by the quantity.
 java.math.BigDecimal getFulfillingQuantity()
          Returns the quantity in fullfilling status.
 ExAGiftCard getGiftCard()
           
 java.lang.String getGiftCertificateAmount()
          Deprecated. Use getGiftVoucherAmount The amount on the gift certificate.
 ExAGiftCertificateAttributes getGiftCertificateAttribute()
          Deprecated. Use getGiftVoucherAttributes If the SellingSku is a gift certificate, this method will return an ExAGiftCertificateAttributes object.
 java.lang.String getGiftVoucherAmount()
          The amount on the gift voucher.
 ExAGiftVoucherAttributes getGiftVoucherAttributes()
          If the SellingSku is a gift certificate or gift card, this method will return an ExAGiftVoucherAttributes object.
 ExAGiftWrap getGiftWrap()
           
 int getLineNumber()
          The line number.
 ExAMonogramming getMonogramming(java.lang.String sellingSkuDisplayCode)
           
 ExAPersonalization getPersonalization(java.lang.String sellingSkuDisplayCode)
           
 java.lang.String getRegistryNumber()
           
 java.lang.String getRegistryType()
           
 java.math.BigDecimal getRequestedQuantity()
          Returns the requested quantity.
 java.math.BigDecimal getReturnableQuantity()
          The quantity that can be returned.
 ExASellingSku getSellingSku()
          Returns the selling sku
 java.math.BigDecimal getShippedQuantity()
          Returns the quantity in shipped status.
 java.lang.String getShippingMethod()
          The shipping method display code.
 java.lang.String getState()
          Returns the state of the order line.
 java.math.BigDecimal getTotalServiceCharge()
          Returns the total service charge on this orderline.
 java.math.BigDecimal getTotalShippingCharge()
          Returns the total shipping charge on this orderline.
 java.math.BigDecimal getTotalTax()
          Returns the total taxes on this orderline.
 boolean isCancelled()
           
 boolean isReturnable()
          Returns "true" if the orderline can be returned.
 
Methods inherited from interface com.retek.component.internet.ExAOrderLineRequest
addMonogramming, addMonogramming, addPersonalization, addPersonalization, setCarrier, setGiftCardRequest, setGiftCertificateAmount, setGiftCertificateAttribute, setGiftVoucherAmount, setGiftVoucherAttributes, setGiftWrapRequest, setHoldDate, setRegistryNumber, setRegistryType, setRequestedQuantity, setSellingSku, setShippingMethod
 

Field Detail

NEW_STATE

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

RESERVING_STATE

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

RESERVED_STATE

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

CANCELLED_STATE

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

CANCEL_REQUEST

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

FULFILLING_STATE

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

BACKORDERED_STATE

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

SHIPPED_STATE

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

getState

public java.lang.String getState()
Returns the state of the order line.

Returns:
String

getRequestedQuantity

public java.math.BigDecimal getRequestedQuantity()
Returns the requested quantity.

Returns:
BigDecimal

getFulfillingQuantity

public java.math.BigDecimal getFulfillingQuantity()
Returns the quantity in fullfilling status.

Returns:
BigDecimal

getShippedQuantity

public java.math.BigDecimal getShippedQuantity()
Returns the quantity in shipped status.

Returns:
BigDecimal

getBackorderedQuantity

public java.math.BigDecimal getBackorderedQuantity()
Returns the quantity in Backordered status.

Returns:
BigDecimal

getCancelledQuantity

public java.math.BigDecimal getCancelledQuantity()
Returns the quantity in cancelled status.

Returns:
BigDecimal

getEstimatedDeliveryDate

public java.util.Date getEstimatedDeliveryDate()
Returns the estimate date the orderline will reach the customer.

Returns:
Date

getEstimatedShipDate

public java.util.Date getEstimatedShipDate()
Returns the estimate date the orderline will be shipped

Returns:
Date

getExtendedPrice

public java.math.BigDecimal getExtendedPrice()
Returns the unit price multiplied by the quantity.

Returns:
BigDecimal

getLineNumber

public int getLineNumber()
The line number.

Returns:
int

getSellingSku

public ExASellingSku getSellingSku()
Returns the selling sku

Returns:
ExASellingSku

getPersonalization

public ExAPersonalization getPersonalization(java.lang.String sellingSkuDisplayCode)
Parameters:
sellingSkuDisplayCode -
Returns:
ExAPersonalization attribute selected by the customer.

getMonogramming

public ExAMonogramming getMonogramming(java.lang.String sellingSkuDisplayCode)
Parameters:
sellingSkuDisplayCode -
Returns:
ExAMonogramming attribute selected by the customer.

getGiftWrap

public ExAGiftWrap getGiftWrap()
Returns:
ExAGiftWrap

getGiftCard

public ExAGiftCard getGiftCard()
Returns:
ExAGiftCard

getTotalTax

public java.math.BigDecimal getTotalTax()
Returns the total taxes on this orderline.

Returns:
BigDecimal

getTotalServiceCharge

public java.math.BigDecimal getTotalServiceCharge()
Returns the total service charge on this orderline.

Returns:
BigDecimal

getTotalShippingCharge

public java.math.BigDecimal getTotalShippingCharge()
Returns the total shipping charge on this orderline.

Returns:
BigDecimal

getRegistryType

public java.lang.String getRegistryType()

getRegistryNumber

public java.lang.String getRegistryNumber()

isCancelled

public boolean isCancelled()

cancel

public void cancel(ExAOrderCancelReason cancelReason)
Cancels this order line with the specified ExAOrderCancelReason.

Parameters:
cancelReason -

getCancelReason

public ExAOrderCancelReason getCancelReason()
Cancel Reason

Returns:
ExAOrderCancelReason

getShippingMethod

public java.lang.String getShippingMethod()
The shipping method display code.

Returns:
String

getCarrier

public java.lang.String getCarrier()
The carrier display code.

Returns:
String

isReturnable

public boolean isReturnable()
Returns "true" if the orderline can be returned.

Returns:
boolean

getReturnableQuantity

public java.math.BigDecimal getReturnableQuantity()
The quantity that can be returned.

Returns:
BigDecimal

getGiftVoucherAttributes

public ExAGiftVoucherAttributes getGiftVoucherAttributes()
If the SellingSku is a gift certificate or gift card, this method will return an ExAGiftVoucherAttributes object.

Returns:
ExAGiftVoucherAttribute

getGiftCertificateAttribute

public ExAGiftCertificateAttributes getGiftCertificateAttribute()
Deprecated. Use getGiftVoucherAttributes If the SellingSku is a gift certificate, this method will return an ExAGiftCertificateAttributes object.

Returns:
ExAGiftCertificateAttributes

getGiftVoucherAmount

public java.lang.String getGiftVoucherAmount()
The amount on the gift voucher.

Returns:
String

getGiftCertificateAmount

public java.lang.String getGiftCertificateAmount()
Deprecated. Use getGiftVoucherAmount The amount on the gift certificate.

Returns:
String


Copyright © 2005 Retek Inc. All Rights Reserved. - Generated at Fri, 01/21/2005 14:25