OrderShippingModeListDataBean

java.lang.Object
- com.ibm.commerce.fulfillment.beans.OrderShippingModeListDataBean

All Implemented Interfaces:: DataBean, InputDataBean, SmartDataBean, Delegator, java.io.Serializable

public class OrderShippingModeListDataBean
extends java.lang.Object
implements SmartDataBean, Delegator

This data bean lists the shipping modes available to a given order, and optionally calculates the shipping charge of each shipping mode.

Options:

resolveFulfillmentCenter. If this parameter is set to true, the databean will resolve the fulfillment centers of the given items before calculating the shipping charge. Because some shipping charge configuration is related to the fulfillment center.
calculateShippingCharge. If this parameter is set to true, this databean will return the shipping charge of each shipping mode.
calculateShippingAdjustment. If this parameter is set to true, while calculating the shipping charge, will add the shipping adjustment of the shipping promotion result.
checkAppliedItems. This parameter is set to true in default. When it is true, not-applicable shipping modes will be filtered. And this is the most popular behavior. Only if customer does not want to filter not-applicable shipping modes, they can set this flag to false. In default, this flag needs not to be set.

Usages:

retrieve shipping modes allowed by the contracts.
retrieve shipping modes with shipping charge. In other words, to filtering out the shipping mode with no shipping charge calculated.
calculate shipping charge.
calculate shipping charge with promotion adjustment. Note: as promotion is qualified for whole order, not per order item, the result may be different to the real charge.

Usage and options mapping table:

	retrieve shipping modes allowed by the contracts	retrieve shipping modes with shipping charge	calculate shipping charge	calculate shipping charge with promotion adjustment
resolveFulfillmentCenter		true	true	true
calculateShippingCharge		true	true	true
calculateShippingAdjustment				true

Notes: Flag-checkAppliedItems needs not to be set in default. Only if customer does not want to filter not-applicable shipping modes, they can set it to false.

JSP usage example:

 <wcbase:useBean id="orderShippingModeList" classname="com.ibm.commerce.fulfillment.beans.OrderShippingModeListDataBean">
        <c:set target="${orderShippingModeList}" property="order" value="${orderBean}"/>
        <c:set target="${orderShippingModeList}" property="calculateShippingCharge" value="true"/>
        <c:set target="${orderShippingModeList}" property="calculateShippingAdjustment" value="true"/>
        <c:set target="${orderShippingModeList}" property="resolveFulfillmentCenter" value="true"/>
 </wcbase:useBean>
 
 <table>
        <tr>
                <th>Shipping Mode</th>
                <th>Shipping Charge</th>
        </tr>
        <c:forEach items="${orderShippingModeList.shippingModes}" var="shippingMode" varStatus="status">
                <tr>
                        <td><c:out value="${shippingMode.description.description}"/></td>
                        <td><c:out value="${orderShippingModeList.shippingCharges[status.index]}"/></td>
                </tr>     
        </c:forEach>
 </table>

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
The IBM copyright notice field.
- Fields inherited from interface com.ibm.commerce.beans.DataBean
  emptyString

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` The IBM copyright notice field.

Constructor Summary

Constructors
Constructor and Description

OrderShippingModeListDataBean()
The OrderShippingModeListDataBean constructor.

Constructors
Constructor and Description
`OrderShippingModeListDataBean()` The OrderShippingModeListDataBean constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`protected java.math.BigDecimal`	`calculateShippingAdjustment(Item[] aItems)` This method calculates the shipping adjustment of the given items.
`protected java.math.BigDecimal`	`calculateShippingCharge(Item[] aItems)` This method calculates the shipping charge of the given items.
`protected FormattedMonetaryAmountDataBean`	`constructFormattedMonetaryAmountDataBean(java.math.BigDecimal adValue, java.lang.String astrCurrency)` This method constructs a FormattedMonetaryAmountDataBean from the given value and currency.
`protected Item`	`constructItem(OrderItemDataBean adbOrderItem)` This method constructs an Item given an OrderItemDataBean.
`CommandContext`	`getCommandContext()` This method returns the command context.
`Protectable`	`getDelegate()` This method returns the delegate of this databean.
`protected OrderDataBean`	`getOrder()` This method returns the order.
`protected java.lang.Long`	`getOrderId()` This method returns the order ID.
`TypedProperty`	`getRequestProperties()` This method returns the request properties.
`FormattedMonetaryAmountDataBean[]`	`getShippingCharges()` This method returns the shipping charges corresponding to the available shipping modes.
`ShippingModeDataBean[]`	`getShippingModes()` This method returns the shipping modes available to the order.
`protected void`	`initializeShippingAdjustment(Item[] aItems)` This method initializes the shipping adjustment of the given items.
`protected boolean`	`isCalculateShippingAdjustments()` This method returns whether to calculate the shipping adjustments of the shipping modes.
`protected boolean`	`isCalculateShippingCharge()` This method returns whether to calculate the shipping charges of the shipping modes.
`protected boolean`	`isCheckAppliedItems()` This method returns whether to filter not-applicable shipping modes.
`protected boolean`	`isResolveFulfillmentCenter()` This method returns whether to resolve fulfillment center before calculating shipping charges.
`void`	`populate()` This method is used to populate the XXXpopulateDataBean.
`protected boolean`	`resolveFulfillmentCenters(Item[] aItems)` This method resolves the fulfillment centers of the given items.
`protected ShippingModeAccessBean[]`	`retrieveAllowableShippingModes(Item[] aItems)` This method retrieves the shipping modes allowed by the contracts of the given items.
`protected OrderDataBean`	`retrieveOrder(java.lang.Long anOrderId)` This method retrieves an order given its ID.
`void`	`setCalculateShippingAdjustment(boolean abCalculateShippingAdjustment)` This method sets whether to calculate the shipping adjustments of the shipping modes.
`void`	`setCalculateShippingCharge(boolean abCalculateShippingCharge)` This method sets whether to calculate the shipping charges of the shipping modes.
`void`	`setCheckAppliedItems(boolean abCheckAppliedItems)` This method sets whether to filter shipping modes by checking applied items.
`void`	`setCommandContext(CommandContext aCommandContext)` This method sets the command context.
`void`	`setOrder(OrderDataBean adbOrder)` This method sets the order.
`void`	`setOrderId(java.lang.Long anOrderId)` This method sets the order ID.
`void`	`setRequestProperties(TypedProperty aRequestProperties)` This method sets the request properties.
`void`	`setResolveFulfillmentCenter(boolean abResolveFulfillmentCenter)` This method sets whether to resolve fulfillment center before calculating shipping charges.
`protected void`	`setShippingCharges(FormattedMonetaryAmountDataBean[] adbShippingCharges)` This method sets the shipping charges corresponding to the available shipping modes.
`protected void`	`setShippingModes(ShippingModeDataBean[] adbShippingModes)` This method sets the shipping modes available to the order.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    The IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OrderShippingModeListDataBean
```
public OrderShippingModeListDataBean()
```
    The OrderShippingModeListDataBean constructor.
- Method Detail
  - getCommandContext
```
public CommandContext getCommandContext()
```
    This method returns the command context.
    
    Specified by:
    
    getCommandContext in interface SmartDataBean
    
    Returns:
    
    the command context.
    
    See Also:
    
    SmartDataBean.getCommandContext()
  - setCommandContext
```
public void setCommandContext(CommandContext aCommandContext)
```
    This method sets the command context.
    
    Specified by:
    
    setCommandContext in interface SmartDataBean
    
    Parameters:
    
    aCommandContext - the command context.
    
    See Also:
    
    SmartDataBean.setCommandContext(com.ibm.commerce.command.CommandContext)
  - getRequestProperties
```
public TypedProperty getRequestProperties()
```
    This method returns the request properties.
    
    Specified by:
    
    getRequestProperties in interface InputDataBean
    
    Returns:
    
    the request properties.
    
    See Also:
    
    InputDataBean.getRequestProperties()
  - setRequestProperties
```
public void setRequestProperties(TypedProperty aRequestProperties)
                          throws java.lang.Exception
```
    This method sets the request properties. The following request properties will be recognized:
    - orderId - see setOrderId(Long)
    - calculateShippingCharge - see setCalculateShippingCharge(boolean)
    - resolveFulfillmentCenter - see setResolveFulfillmentCenter(boolean)
    Specified by:
    
    setRequestProperties in interface InputDataBean
    
    Parameters:
    
    aRequestProperties - the request properties.
    
    Throws:
    
    java.lang.Exception - Thrown if there is a problem when setting the request properties. This particular method should not throw any exception because it just stores the request properties.
    
    See Also:
    
    InputDataBean.setRequestProperties(com.ibm.commerce.datatype.TypedProperty)
  - setOrderId
```
public void setOrderId(java.lang.Long anOrderId)
```
    This method sets the order ID.
    
    Parameters:
    
    anOrderId - the order ID.
  - getOrderId
```
protected java.lang.Long getOrderId()
```
    This method returns the order ID.
    
    Returns:
    
    the order ID.
  - setOrder
```
public void setOrder(OrderDataBean adbOrder)
```
    This method sets the order.
    
    Parameters:
    
    adbOrder - the order.
  - getOrder
```
protected OrderDataBean getOrder()
```
    This method returns the order.
    
    Returns:
    
    the order.
  - setCalculateShippingCharge
```
public void setCalculateShippingCharge(boolean abCalculateShippingCharge)
```
    This method sets whether to calculate the shipping charges of the shipping modes. False by default.
    
    Parameters:
    
    abCalculateShippingCharge - true if the shipping charges are to be calculated.
  - setCalculateShippingAdjustment
```
public void setCalculateShippingAdjustment(boolean abCalculateShippingAdjustment)
```
    This method sets whether to calculate the shipping adjustments of the shipping modes. False by default.
    
    Parameters:
    
    abCalculateShippingAdjustment - true if the shipping charges are to be calculated.
  - isCalculateShippingCharge
```
protected boolean isCalculateShippingCharge()
```
    This method returns whether to calculate the shipping charges of the shipping modes.
    
    Returns:
    
    true if the shipping charges are to be calculated.
  - isCalculateShippingAdjustments
```
protected boolean isCalculateShippingAdjustments()
```
    This method returns whether to calculate the shipping adjustments of the shipping modes.
    
    Returns:
    
    true if the shipping charges are to be calculated.
  - setCheckAppliedItems
```
public void setCheckAppliedItems(boolean abCheckAppliedItems)
```
    This method sets whether to filter shipping modes by checking applied items. Its default value is true.Not applicable shipping modes will be filtered.
    
    Parameters:
    
    abCheckAppliedItems - true if not-applicable shipping modes are to be filtered.
  - isCheckAppliedItems
```
protected boolean isCheckAppliedItems()
```
    This method returns whether to filter not-applicable shipping modes.
    
    Returns:
    
    true if not-applicable shipping modes are to be filtered.
  - setResolveFulfillmentCenter
```
public void setResolveFulfillmentCenter(boolean abResolveFulfillmentCenter)
```
    This method sets whether to resolve fulfillment center before calculating shipping charges. Either ResolveFulfillmentCenterCmd or GetEligibleFulfillmentCentersCmd is called. Should be set to true if fulfillment center affects shipping mode availability and/or shipping charge. False by default.
    
    Parameters:
    
    abResolveFulfillmentCenter - true if fulfillment center is to be resolved.
  - isResolveFulfillmentCenter
```
protected boolean isResolveFulfillmentCenter()
```
    This method returns whether to resolve fulfillment center before calculating shipping charges.
    
    Returns:
    
    true if fulfillment center is to be resolved.
  - getShippingModes
```
public ShippingModeDataBean[] getShippingModes()
```
    This method returns the shipping modes available to the order.
    
    Returns:
    
    the available shipping modes.
  - setShippingModes
```
protected void setShippingModes(ShippingModeDataBean[] adbShippingModes)
```
    This method sets the shipping modes available to the order.
    
    Parameters:
    
    adbShippingModes - the available shipping modes.
  - getShippingCharges
```
public FormattedMonetaryAmountDataBean[] getShippingCharges()
```
    This method returns the shipping charges corresponding to the available shipping modes.
    
    Returns:
    
    the shipping charges.
    
    See Also:
    
    getShippingModes()
  - setShippingCharges
```
protected void setShippingCharges(FormattedMonetaryAmountDataBean[] adbShippingCharges)
```
    This method sets the shipping charges corresponding to the available shipping modes.
    
    Parameters:
    
    adbShippingCharges -
    
    See Also:
    
    setShippingModes(ShippingModeDataBean[])
  - retrieveOrder
```
protected OrderDataBean retrieveOrder(java.lang.Long anOrderId)
                               throws ECException
```
    This method retrieves an order given its ID.
    
    Parameters:
    
    anOrderId - the order ID.
    
    Returns:
    
    the order.
    
    Throws:
    
    ECException
  - getDelegate
```
public Protectable getDelegate()
                        throws java.lang.Exception
```
    This method returns the delegate of this databean.
    
    Specified by:
    
    getDelegate in interface Delegator
    
    Returns:
    
    the delegate of this databean.
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    Delegator.getDelegate()
  - constructItem
```
protected Item constructItem(OrderItemDataBean adbOrderItem)
                      throws ECException
```
    This method constructs an Item given an OrderItemDataBean.
    
    Parameters:
    
    adbOrderItem - the OrderItemDataBean.
    
    Returns:
    
    the Item.
    
    Throws:
    
    ECException
  - retrieveAllowableShippingModes
```
protected ShippingModeAccessBean[] retrieveAllowableShippingModes(Item[] aItems)
                                                           throws ECException
```
    This method retrieves the shipping modes allowed by the contracts of the given items.
    
    Parameters:
    
    aItems - the items.
    
    Returns:
    
    the shipping modes.
    
    Throws:
    
    ECException
  - resolveFulfillmentCenters
```
protected boolean resolveFulfillmentCenters(Item[] aItems)
                                     throws ECException
```
    This method resolves the fulfillment centers of the given items.
    
    Parameters:
    
    aItems - the items.
    
    Returns:
    
    true if successful.
    
    Throws:
    
    ECException
  - calculateShippingCharge
```
protected java.math.BigDecimal calculateShippingCharge(Item[] aItems)
                                                throws ECException
```
    This method calculates the shipping charge of the given items.
    
    Parameters:
    
    aItems - the items.
    
    Returns:
    
    the shipping charge.
    
    Throws:
    
    ECException
  - calculateShippingAdjustment
```
protected java.math.BigDecimal calculateShippingAdjustment(Item[] aItems)
                                                    throws ECException
```
    This method calculates the shipping adjustment of the given items.
    
    Parameters:
    
    aItems - the items.
    
    Returns:
    
    the shipping adjustment.
    
    Throws:
    
    ECException
  - initializeShippingAdjustment
```
protected void initializeShippingAdjustment(Item[] aItems)
                                     throws ECException
```
    This method initializes the shipping adjustment of the given items.
    
    Parameters:
    
    aItems - the items.
    
    Throws:
    
    ECException
  - constructFormattedMonetaryAmountDataBean
```
protected FormattedMonetaryAmountDataBean constructFormattedMonetaryAmountDataBean(java.math.BigDecimal adValue,
                                                                       java.lang.String astrCurrency)
                                                                            throws ECException
```
    This method constructs a FormattedMonetaryAmountDataBean from the given value and currency.
    
    Parameters:
    
    adValue - the value.
    
    astrCurrency - the currency.
    
    Returns:
    
    the FormattedMonetaryAmountDataBean.
    
    Throws:
    
    ECException
  - populate
```
public void populate()
              throws java.lang.Exception
```
    This method is used to populate the XXXpopulateDataBean.
    
    Specified by:
    
    populate in interface SmartDataBean
    
    Throws:
    
    java.lang.Exception

Class OrderShippingModeListDataBean

JSP usage example:

Field Summary

Fields inherited from interface com.ibm.commerce.beans.DataBean

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COPYRIGHT

Constructor Detail

OrderShippingModeListDataBean

Method Detail

getCommandContext

setCommandContext

getRequestProperties

setRequestProperties

setOrderId

getOrderId

setOrder

getOrder

setCalculateShippingCharge

setCalculateShippingAdjustment

isCalculateShippingCharge

isCalculateShippingAdjustments

setCheckAppliedItems

isCheckAppliedItems

setResolveFulfillmentCenter

isResolveFulfillmentCenter

getShippingModes

setShippingModes

getShippingCharges

setShippingCharges

retrieveOrder

getDelegate

constructItem

retrieveAllowableShippingModes

resolveFulfillmentCenters

calculateShippingCharge

calculateShippingAdjustment

initializeShippingAdjustment

constructFormattedMonetaryAmountDataBean

populate