com.retek.component.internet
Interface ExARequestManager


public interface ExARequestManager

This is a high level interface which builds instances of various external API request objects.

Retek Inc. Copyright (c) 2003


Method Summary
 ExABanner buildExABannerRequest(java.lang.String bannerNumber)
          Build a banner request.
 ExACashPaymentRequest buildExACashPaymentRequest()
          Build a cash payment request for an impending order.
 ExACatalogRequest buildExACatalogRequest()
          Build an instance of a catalog request.
 ExACheckPaymentRequest buildExACheckPaymentRequest()
          Build a check payment request for an impending order.
 ExACreditCardPaymentRequest buildExACreditCardPaymentRequest()
          Build a credit card payment request for an impending order.
 ExACustomerRequest buildExACustomerRequest()
          Build a customer request for a create new customer request.
 ExAOrderLineRequest buildExAExchangeLineRequest()
          Build a exchange line request instance.
 ExAGiftCardRequest buildExAGiftCardRequest()
          Build a gift card request for an impending order.
 ExAGiftCertificatePaymentRequest buildExAGiftCertificatePaymentRequest()
          Build a gift certificate payment request for an impending order.
 ExAGiftingSeasonRequest buildExAGiftingSeasonRequest(java.lang.String giftingSeasonNumber)
          Build a gifting season request.
 ExAGiftWrapRequest buildExAGiftWrapRequest()
          Build a gift wrap request for an impending order.
 ExAMedia buildExAMediaRequest(ExABanner banner, java.lang.String mediaNumber)
          Build a media request.
 ExAMerchandiseVoucherPaymentRequest buildExAMerchandiseVoucherPaymentRequest()
          Build a merchandise voucher payment request for an impending order.
 ExAMonogrammingRequest buildExAMonogrammingRequest()
          Build a monogramming request for an impending order.
 ExAOrderLineRequest buildExAOrderLineRequest()
          Build an order line request instance.
 ExAOrderRequest buildExAOrderRequest()
          Build an order request for an impending order.
 ExAPackSellingSku buildExAPackSellingSkuRequest(ExASellingItem sellingItem, java.lang.String sellingSkuNumber)
          Build a pack selling sku request.
 ExAPersonalizationRequest buildExAPersonalizationRequest()
          Build a personalization request for an impending order.
 ExAPersonalizationTextLineRequest buildExAPersonalizationTextLineRequest()
          Build a personalization text line request for an impending order.
 ExAReturnLine buildExAReturnLine(ExAOrderLine orderLine)
          Build a return line request instance.
 ExARewardCertificatePaymentRequest buildExARewardCertificatePaymentRequest()
          Build a reward certificate payment request for an impending order.
 ExASellingItem buildExASellingItemRequest(ExAMedia media, java.lang.String itemNumber)
          Build a selling item request.
 ExASellingSku buildExASellingSku(ExASellingItem sellingItem, java.lang.String sellingSkuNumber)
          Build a selling sku.
 ExAShipToLabelRequest buildExAShipToLabelRequest()
          Build a ship-to label request for an impending order.
 ExAStoredValueCardPaymentRequest buildExAStoredValueCardPaymentRequest()
          Build a stored value card payment request for an impending order.
 

Method Detail

buildExACatalogRequest

public ExACatalogRequest buildExACatalogRequest()
Build an instance of a catalog request. The return object will be needed later to request a catalog via the external API.

Returns:
catalog request instance

buildExAOrderLineRequest

public ExAOrderLineRequest buildExAOrderLineRequest()
Build an order line request instance. The return object will be needed to specify item quantity and to maintain the ship-to relationship for a particular ordered item. The returned object will be used by the ExAOrderRequest.

Returns:
order line request instance

buildExAReturnLine

public ExAReturnLine buildExAReturnLine(ExAOrderLine orderLine)
Build a return line request instance. The return object will be needed to specify return item quantity, return reason, and parent order line.

Returns:
return line instance

buildExAExchangeLineRequest

public ExAOrderLineRequest buildExAExchangeLineRequest()
Build a exchange line request instance. The return object will be needed to specify item, item qty

Returns:
order line request instance

buildExASellingSku

public ExASellingSku buildExASellingSku(ExASellingItem sellingItem,
                                        java.lang.String sellingSkuNumber)
Build a selling sku. The return object will be used to detail item-level information for an order line whenever a non-pack item is requested. The information to build this object is normally found in the RCOM data extract.

Returns:
selling sku instance

buildExACustomerRequest

public ExACustomerRequest buildExACustomerRequest()
Build a customer request for a create new customer request.

Returns:
customer request instance

buildExAShipToLabelRequest

public ExAShipToLabelRequest buildExAShipToLabelRequest()
Build a ship-to label request for an impending order. The return object will be used to group order lines for shipping convenience.

Returns:
ship-to label request instance

buildExAOrderRequest

public ExAOrderRequest buildExAOrderRequest()
Build an order request for an impending order. The return object will be used to manage all other order-oriented objects.

Returns:
order request instance

buildExAPersonalizationRequest

public ExAPersonalizationRequest buildExAPersonalizationRequest()
Build a personalization request for an impending order. The returned request object will be applied to an order line to initiate personalization service on a selling sku represented by that order line.

Returns:
personalization request instance

buildExAPersonalizationTextLineRequest

public ExAPersonalizationTextLineRequest buildExAPersonalizationTextLineRequest()
Build a personalization text line request for an impending order. The return object is used to represent detail applied to a personalization request.

Returns:
personalization text line request instance

buildExAMonogrammingRequest

public ExAMonogrammingRequest buildExAMonogrammingRequest()
Build a monogramming request for an impending order. The return request object awill be applied to an order line to initiate monogramming service on a selling sku represented by that order line.

Returns:
monogramming request instance

buildExAGiftWrapRequest

public ExAGiftWrapRequest buildExAGiftWrapRequest()
Build a gift wrap request for an impending order. The returned request object will be applied to an order line to initiate gift wrap service on an item represented by that order line.

Returns:
gift wrap request instance

buildExAGiftCardRequest

public ExAGiftCardRequest buildExAGiftCardRequest()
Build a gift card request for an impending order. The return request object will be applied to an order line to initiate gift wrap service on an item represented by that order line.

Returns:
gift card request instance

buildExACreditCardPaymentRequest

public ExACreditCardPaymentRequest buildExACreditCardPaymentRequest()
Build a credit card payment request for an impending order. The return object manages the application of a credit card payment to the associated order.

Returns:
credit card payment request instance

buildExACheckPaymentRequest

public ExACheckPaymentRequest buildExACheckPaymentRequest()
Build a check payment request for an impending order. The return object manages the application of a check payment to the associated order.

Returns:
check payment request instance

buildExACashPaymentRequest

public ExACashPaymentRequest buildExACashPaymentRequest()
Build a cash payment request for an impending order. The return object manages the application of a cash payment to the associated order.

Returns:
cash payment request instance

buildExAGiftCertificatePaymentRequest

public ExAGiftCertificatePaymentRequest buildExAGiftCertificatePaymentRequest()
Build a gift certificate payment request for an impending order. The return object manages the application of a gift certificate payment to the associated order.

Returns:
voucher payment request instance

buildExAStoredValueCardPaymentRequest

public ExAStoredValueCardPaymentRequest buildExAStoredValueCardPaymentRequest()
Build a stored value card payment request for an impending order. This object manages the application of a stored value card payment to the associated order.

Returns:
stored value card payment request instance

buildExARewardCertificatePaymentRequest

public ExARewardCertificatePaymentRequest buildExARewardCertificatePaymentRequest()
Build a reward certificate payment request for an impending order. This object manages the application of a reward certificate payment to the associated order.

Returns:
reward certificate payment request instance

buildExAMerchandiseVoucherPaymentRequest

public ExAMerchandiseVoucherPaymentRequest buildExAMerchandiseVoucherPaymentRequest()
Build a merchandise voucher payment request for an impending order. This object manages the application of a merchandise voucher payment to the associated order.

Returns:
merchandise voucher payment request instance

buildExABannerRequest

public ExABanner buildExABannerRequest(java.lang.String bannerNumber)
Build a banner request. The return object will be used in various capacities to represent concept-level responsibilities in maintaining media information, catalog and order requests. The information to build this object is normally found in the RCOM data extract.

Returns:
banner request instance

buildExAMediaRequest

public ExAMedia buildExAMediaRequest(ExABanner banner,
                                     java.lang.String mediaNumber)
Build a media request. The return object will be used in various capacities to represent catalog-level responsibilities in maintaining item information, catalog and order requests. The information to build the return object is normally found in the RCOM data extract.

Returns:
media request instance

buildExASellingItemRequest

public ExASellingItem buildExASellingItemRequest(ExAMedia media,
                                                 java.lang.String itemNumber)
Build a selling item request. The return object will be used to represent catalog-entry-level responsibilities in maintaining item information. The information to build the return object is normally found in the RCOM data extract.

Returns:
selling item request instance

buildExAGiftingSeasonRequest

public ExAGiftingSeasonRequest buildExAGiftingSeasonRequest(java.lang.String giftingSeasonNumber)
Build a gifting season request. The return object will be used to represent designated calendar relationships for gift wrap and gift card application. The information to build the return object is normally found in the RCOM data extract.

Returns:
gifting season request instance

buildExAPackSellingSkuRequest

public ExAPackSellingSku buildExAPackSellingSkuRequest(ExASellingItem sellingItem,
                                                       java.lang.String sellingSkuNumber)
Build a pack selling sku request. The return object will be used to detail item-level information for an order line whenever a pack item is requested. The information to build the return object is normally found in the RCOM data extract.

Returns:
pack selling sku request instance


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