com.retek.component.internet
Interface ExAManager

All Known Implementing Classes:
ExAManagerImpl

public interface ExAManager

This is a high level interface which directs access to the external API methods.

Retek Inc. Copyright (c) 2003


Method Summary
 ExACatalogRequestResponse createCatalogRequest(ExACatalogRequest catalogRequest)
          Create and submit an online request for a catalog.
 ExACustomer createCustomer(ExACustomerRequest customer)
          Createa a new customer.
 ExAOrder createOrder(ExAOrder order, java.util.Set paymentSet)
          Deprecated. (3/10/2004) Use updateOrder(ExAOrder)
 ExAOrder createPendedOrder(ExAOrder order)
          Create and submit an online request for a pended order with or without payment information.
 ExAOrder createPendedOrder(ExAOrder order, java.util.Set paymentSet)
          Deprecated. (3/10/2004) Use createPendedOrder(ExAOrder order) Create and submit an online request for a pended order with payment information. The request must be an order summary, which represents a new order in the system.
 ExAOrder createSummary(ExAOrderRequest order)
          Create and submit an online request for an order summary, which represents a new order in the system.
 java.util.Set findCustomers(ExACustomerSearchCriteria searchCriteria)
          Find all existing customers that meet the given search criteria.
 java.util.Set findHistoryEvents(ExAHistoryEventSearchCriteria criteria)
          Find all existing history events based on given search criteria.
 java.util.Set findOrderCancelReasons()
          Find all the order cancel reasons in the system.
 java.util.Set findOrders(ExAOrderSearchCriteria searchCriteria)
          Find all existing orders that meet the given search criteria.
 java.util.Set findReturnReasons()
          Find all the return reasons in the system.
 ExASellingItem findSellingItem(ExAMedia media, java.lang.String sellingItemNumber)
          Find the selling item associated with the given media and selling item display code.
 ExASellingSkuStockStatus findStockStatus(java.lang.String sellingSkuNumber, java.math.BigDecimal requestQuantity)
          Determine the general availability of the selling sku associated with the given display code.
 ExACustomer updateCustomer(ExACustomerRequest customer)
          Update an existing customer's information.
 ExAOrder updateOrder(ExAOrder order)
          Create and submit an online request for an open order with full payment information.
 

Method Detail

findOrders

public java.util.Set findOrders(ExAOrderSearchCriteria searchCriteria)
                         throws ExAException
Find all existing orders that meet the given search criteria.

Parameters:
searchCriteria - characteristics of an order that must be matched
Returns:
set of all orders meeting the search criteria
Throws:
ExAException

findCustomers

public java.util.Set findCustomers(ExACustomerSearchCriteria searchCriteria)
                            throws ExAException
Find all existing customers that meet the given search criteria.

Parameters:
searchCriteria - characteristics of a customer that must be matched
Returns:
set of all customers meeting the search criteria
Throws:
ExAException

findHistoryEvents

public java.util.Set findHistoryEvents(ExAHistoryEventSearchCriteria criteria)
                                throws ExAException
Find all existing history events based on given search criteria.

Parameters:
criteria - characteristics of a history event that must be matched
Returns:
Set of all history events meeting the search criteria
Throws:
ExAException

findStockStatus

public ExASellingSkuStockStatus findStockStatus(java.lang.String sellingSkuNumber,
                                                java.math.BigDecimal requestQuantity)
                                         throws ExAException
Determine the general availability of the selling sku associated with the given display code.

Parameters:
sellingSkuNumber - display code of the selling sku
requestQuantity - quantity needed by the caller
Returns:
selling sku availability information
Throws:
ExAException

findSellingItem

public ExASellingItem findSellingItem(ExAMedia media,
                                      java.lang.String sellingItemNumber)
                               throws ExAException
Find the selling item associated with the given media and selling item display code.

Parameters:
media - media to which the selling item is assigned
sellingItemNumber - display code of the selling item
Returns:
selling item
Throws:
ExAException

findOrderCancelReasons

public java.util.Set findOrderCancelReasons()
                                     throws ExASystemException
Find all the order cancel reasons in the system. If you want to cancel an ExAOrder, you need an ExAOrderCancelReason, and you can only get them here.

Returns:
Set of ExAOrderCancelReason objects
Throws:
ExASystemException

findReturnReasons

public java.util.Set findReturnReasons()
                                throws ExASystemException,
                                       ExABusinessException
Find all the return reasons in the system. If you want to return an ExAOrderLine, you need an ExAReturneason, and you can only get them here.

Returns:
Set of ExAReturnReason objects
Throws:
ExASystemException
ExABusinessException

createCatalogRequest

public ExACatalogRequestResponse createCatalogRequest(ExACatalogRequest catalogRequest)
                                               throws ExAException
Create and submit an online request for a catalog.

Parameters:
catalogRequest - object which directs the creation of a catalog request
Returns:
catalog delivery information
Throws:
ExAException

createSummary

public ExAOrder createSummary(ExAOrderRequest order)
                       throws ExAException
Create and submit an online request for an order summary, which represents a new order in the system. This is the intermediate form all orders must achieve prior to final submission.

Parameters:
order - object which directs the creation of an online order
Returns:
order summary
Throws:
ExAException

createPendedOrder

public ExAOrder createPendedOrder(ExAOrder order)
                           throws ExAException
Create and submit an online request for a pended order with or without payment information. The request must be an order summary, which represents a new order in the system.

Parameters:
order - object which directs the creation of an online order
Returns:
pended order
Throws:
ExAException

createPendedOrder

public ExAOrder createPendedOrder(ExAOrder order,
                                  java.util.Set paymentSet)
                           throws ExAException
Deprecated. (3/10/2004) Use createPendedOrder(ExAOrder order) Create and submit an online request for a pended order with payment information. The request must be an order summary, which represents a new order in the system.

Parameters:
order - object which directs the creation of an online order
Returns:
pended order
Throws:
ExAException

createOrder

public ExAOrder createOrder(ExAOrder order,
                            java.util.Set paymentSet)
                     throws ExAException
Deprecated. (3/10/2004) Use updateOrder(ExAOrder)

Parameters:
order - object which directs the creation of an online order
Returns:
final order
Throws:
ExAException

updateOrder

public ExAOrder updateOrder(ExAOrder order)
                     throws ExAException
Create and submit an online request for an open order with full payment information. No further modifications will be needed to complete an open order. System anomalies or insufficient or inaccurate payment information may result in a pended order, which will require additional work.

Parameters:
order - object which directs the creation of an online order
Returns:
final order
Throws:
ExAException

createCustomer

public ExACustomer createCustomer(ExACustomerRequest customer)
                           throws ExAException
Createa a new customer.

Parameters:
customer - object which directs the creation of an online customer
Returns:
final customer
Throws:
ExAException

updateCustomer

public ExACustomer updateCustomer(ExACustomerRequest customer)
                           throws ExAException
Update an existing customer's information.

Parameters:
customer - object which directs the update of an online customer
Returns:
final customer
Throws:
ExAException


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