com.retek.component.internet
Interface ExAOrder

All Superinterfaces:
ExAOrderBase

public interface ExAOrder
extends ExAOrderBase

This is a high level interface which controls access to order information for the external API.

Retek Inc. Copyright (c) 2003


Field Summary
 
Fields inherited from interface com.retek.component.internet.ExAOrderBase
CANCELLED_STATE, CLOSED_STATE, EMPLOYEE_ORDER_TYPE, GIFT_REGISTRY_SOURCE, INTERNET_SOURCE, NEW_STATE, OPEN_STATE, PENDING_STATE, STANDARD_ORDER_TYPE
 
Method Summary
 void addPayment(ExAPaymentRequest payment)
          Adds a payment to this order.
 void addReturnLine(ExAReturnLine exaReturnLine)
          Adds the ExAReturnLine to the order.
 void cancel(ExAOrderCancelReason cancelReason)
          Cancels the order with the specified cancelReason.
 java.math.BigDecimal getBalance()
          The balance on the order.
 java.lang.String getBannerNumber()
          The banner number.
 ExAAddress getBillToAddress()
          The ExAAddress of the customer where the invoice will be sent.
 ExAOrderCancelReason getCancelReason()
          The reason why he order was cancelled.
 ExAUser getCreatedBy()
          The user who created the order.
 ExACustomer getCustomer()
          The customer who has placed the order.
 java.lang.String getDefaultMediaNumber()
          The default media number.
 java.math.BigDecimal getGrandTotal()
          The total on the order.
 java.lang.String getMediaSourceCode()
          The default media source code.
 ExAOrderLine getOrderLine(int lineNumber)
          Returns an ExAOrderLine
 java.util.Set getOrderLines()
          A set of ExAOrderLine objects.
 java.lang.String getOrderNumber()
          OrderNumber is the internal RCOM representation of this Order.
 java.lang.String getOrderSourceCode()
          The default order source code.
 java.lang.String getOrderType()
          The Order type
 ExAPayment getPayment(java.lang.String id)
          Returns an ExAPayment object haveing the specified id.
 java.util.Set getPayments()
          A set of ExAPayment objects.
 java.util.Set getReturnLines()
          A set of ExAReturnLine objects.
 java.util.Set getShipContainers()
          A set of ExAShippedContainer objcts.
 java.util.Set getShipToLabels()
          A set of ExAShipToLabel that holds the ship-to information for each ExAOrderLine.
 java.lang.String getState()
          State is the representation of the internal RCOM status of this Order.
 java.math.BigDecimal getTotalServiceCharge()
          Total service charges on the order.
 java.math.BigDecimal getTotalShippingCharge()
          Total shipping charge on the order.
 java.math.BigDecimal getTotalTax()
          Total taxes on the order.
 boolean isCancelled()
          Returns "true" if the order is cancelled.
 boolean isExAPended()
          Returns "true" if the order was pended using the external API.
 void setExAPended(boolean setPended)
          Specifies whether this order should be ExA Pended.
 
Methods inherited from interface com.retek.component.internet.ExAOrderBase
addShipToLabel, clearAllShipToLabels
 

Method Detail

getState

public java.lang.String getState()
State is the representation of the internal RCOM status of this Order. Values correspond to the descriptions from the Customer Order State model and are held on ExAOrderBase.

Returns:
String State code.

getOrderNumber

public java.lang.String getOrderNumber()
OrderNumber is the internal RCOM representation of this Order.

Returns:
String The Order number.

getBannerNumber

public java.lang.String getBannerNumber()
The banner number.

Returns:
String

getDefaultMediaNumber

public java.lang.String getDefaultMediaNumber()
The default media number.

Returns:
String

getOrderSourceCode

public java.lang.String getOrderSourceCode()
The default order source code.

Returns:
String

getOrderType

public java.lang.String getOrderType()
The Order type

Returns:
String

getCustomer

public ExACustomer getCustomer()
The customer who has placed the order.

Returns:
ExACustomer

getShipToLabels

public java.util.Set getShipToLabels()
A set of ExAShipToLabel that holds the ship-to information for each ExAOrderLine.

Returns:
Set

getBillToAddress

public ExAAddress getBillToAddress()
The ExAAddress of the customer where the invoice will be sent.

Returns:
ExAAddress

getOrderLines

public java.util.Set getOrderLines()
A set of ExAOrderLine objects.

Returns:
Set

getPayments

public java.util.Set getPayments()
A set of ExAPayment objects.

Returns:
Set

getShipContainers

public java.util.Set getShipContainers()
A set of ExAShippedContainer objcts.

Returns:
Set

getBalance

public java.math.BigDecimal getBalance()
The balance on the order.

Returns:
BigDecimal

getGrandTotal

public java.math.BigDecimal getGrandTotal()
The total on the order.

Returns:
BigDecimal

getTotalTax

public java.math.BigDecimal getTotalTax()
Total taxes on the order.

Returns:
BigDecimal

getTotalServiceCharge

public java.math.BigDecimal getTotalServiceCharge()
Total service charges on the order.

Returns:
BigDecimal

getTotalShippingCharge

public java.math.BigDecimal getTotalShippingCharge()
Total shipping charge on the order.

Returns:
BigDecimal

getCreatedBy

public ExAUser getCreatedBy()
The user who created the order.

Returns:
ExAUser

getPayment

public ExAPayment getPayment(java.lang.String id)
Returns an ExAPayment object haveing the specified id.

Parameters:
id - The payment Id.
Returns:
ExAPayment The ExAPayment with the specific id.

addPayment

public void addPayment(ExAPaymentRequest payment)
Adds a payment to this order.

Parameters:
payment -

cancel

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

Parameters:
cancelReason -

isCancelled

public boolean isCancelled()
Returns "true" if the order is cancelled.

Returns:
boolean

getCancelReason

public ExAOrderCancelReason getCancelReason()
The reason why he order was cancelled.

Returns:
ExAOrderCancelReason

getOrderLine

public ExAOrderLine getOrderLine(int lineNumber)
Returns an ExAOrderLine

Parameters:
lineNumber - The ExAOrderLine number
Returns:
ExAOrderLine The ExAOrderLine that has the specified line number.

addReturnLine

public void addReturnLine(ExAReturnLine exaReturnLine)
Adds the ExAReturnLine to the order.

Parameters:
exaReturnLine -

getReturnLines

public java.util.Set getReturnLines()
A set of ExAReturnLine objects.

Returns:
Set

getMediaSourceCode

public java.lang.String getMediaSourceCode()
The default media source code.

Returns:
String

isExAPended

public boolean isExAPended()
Returns "true" if the order was pended using the external API.

Returns:
boolean

setExAPended

public void setExAPended(boolean setPended)
Specifies whether this order should be ExA Pended. This must be called to get the system to inactivate its Internet Summary Pend Reason



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