com.ibm.commerce.order.beans

Class UsableShipChargesAndAccountByShipModeDataBean

java.lang.Object

com.ibm.commerce.beans.InputDataBeanImpl

com.ibm.commerce.beans.SmartDataBeanImpl

com.ibm.commerce.order.beans.UsableShipChargesAndAccountByShipModeDataBean

All Implemented Interfaces:

DataBean, InputDataBean, SmartDataBean, UsableShipChargesAndAccountByShipModeInputDataBean, UsableShipChargesAndAccountByShipModeSmartDataBean, Delegator, Protectable, java.io.Serializable

public class UsableShipChargesAndAccountByShipModeDataBean
extends SmartDataBeanImpl
implements UsableShipChargesAndAccountByShipModeInputDataBean, UsableShipChargesAndAccountByShipModeSmartDataBean, Delegator, Protectable

Stores the unique list of ship modes for the order and for each ship mode the shipping charges that can apply. In the case of shipping charged by carrier also holds the shipping carrier account number if one exists. The shipping charges held for a ship mode are derived by:

• Inspecting all the order items that have that shipmode ID.
• Inspecting their shipping charge types.
• Displaying only the common charge types across those order items.

This process is repeated for each shipping mode.

See Also:

Serialized Form

Field Summary

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

emptyString

Constructor Summary

Constructors

Constructor and Description
UsableShipChargesAndAccountByShipModeDataBean() InstructsPerOrderItemBlockListDataBean default constructor.

Method Summary

Modifier and Type	Method and Description
Protectable	getDelegate() Returns the Protectable object whose access control policies will indirectly control the access control for this object
int	getNumberOfShipModes() This method returns the number of ship modes that exist across all order items for the order.
java.lang.Long	getOwner() Returns the member ID of the owner.
ShipChargesByShipMode[]	getShipChargesByShipMode() This method returns the shipping charges by ship mode.
boolean	isShipChargesExist() Tells the caller if shipping charges were found for this order.
void	populate() This method is used to populate the UsableShipChargesAndAccountByShipModeDataBean.
void	setOrderId(java.lang.String ordersId) This method sets the order ID of the order to collate shipping mode and shipping charge data for.

Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl

fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext

Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl

getRequestProperties, setRequestProperties

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.beans.SmartDataBean

getCommandContext, setCommandContext

Methods inherited from interface com.ibm.commerce.beans.InputDataBean

getRequestProperties, setRequestProperties

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills

Constructor Detail

UsableShipChargesAndAccountByShipModeDataBean

public UsableShipChargesAndAccountByShipModeDataBean()

InstructsPerOrderItemBlockListDataBean default constructor.

Method Detail

populate

public void populate()

This method is used to populate the UsableShipChargesAndAccountByShipModeDataBean. You must set OrderId using the setOrderId method before running the populate() method.

Specified by:

populate in interface SmartDataBean

Overrides:

populate in class SmartDataBeanImpl

See Also:

setOrderId(String)

setOrderId

public void setOrderId(java.lang.String ordersId)

This method sets the order ID of the order to collate shipping mode and shipping charge data for.

Specified by:

setOrderId in interface UsableShipChargesAndAccountByShipModeInputDataBean

Parameters:

ordersId - The order ID of the order to collate shipping mode and shipping charge data for

getNumberOfShipModes

public int getNumberOfShipModes()

This method returns the number of ship modes that exist across all order items for the order.

Returns:

int The number of unique ship modes that exist for this order.

getShipChargesByShipMode

public ShipChargesByShipMode[] getShipChargesByShipMode()

This method returns the shipping charges by ship mode.

Returns:

ShipChargesByShipMode The Shipping Charges for shipModes

isShipChargesExist

public boolean isShipChargesExist()

Tells the caller if shipping charges were found for this order. In all cases shipping charges should be found.

Returns:

boolean true if shipping charges exist for the order false if none were found

getOwner

public java.lang.Long getOwner()
                        throws java.lang.Exception

Description copied from interface: Protectable

Returns the member ID of the owner.

Specified by:

getOwner in interface Protectable

Returns:

The member ID of the owner

Throws:

java.lang.Exception

getDelegate

public Protectable getDelegate()
                        throws java.lang.Exception

Description copied from interface: Delegator

Returns the Protectable object whose access control policies will indirectly control the access control for this object

Specified by:

getDelegate in interface Delegator

Returns:

The Protectable object whose access control policies will indirectly control the access control for this object

Throws:

java.lang.Exception