com.ibm.commerce.fulfillment.commands

Class ShippingHelper

java.lang.Object

com.ibm.commerce.fulfillment.commands.ShippingHelper

public class ShippingHelper
extends java.lang.Object

This is a helper class used for shipping.

Constructor Summary

Constructors

Constructor and Description
ShippingHelper() ShippingHelper constructor comment.

Method Summary

Modifier and Type	Method and Description
void	checkShippingAddress(OrderItemAccessBean aabOrderItem)
void	checkShippingMode(OrderItemAccessBean aabOrderItem)
AddressAccessBean[]	getAllowableShippingAddresses(java.lang.Long anMemberId)
AddressAccessBean[]	getAllowableShippingAddresses(java.lang.Long anMemberId, java.lang.Long anTradingId) Deprecated. replaced by getAllowableShippingAddresses(Long anMemberId, Long anTradingId, Integer aStoreId)
AddressAccessBean[]	getAllowableShippingAddresses(java.lang.Long anMemberId, java.lang.Long anTradingId, java.lang.Integer aStoreId) Gets allowable shipping address for a specified member, a contract and a store.
AddressAccessBean[]	getAllowableShippingAddresses(OrderItemAccessBean aabOrderItem)
AddressAccessBean[]	getAllowableShippingAddressesByContract(java.lang.Long anMemberId, java.lang.Long anTradingId, java.lang.Integer aStoreId) Get an array of allowable shipping addresses by a contract for an order item.
ShippingModeAccessBean[]	getAllowableShippingModes(java.lang.Integer anStoreId)
ShippingModeAccessBean[]	getAllowableShippingModes(java.lang.Integer anStoreId, java.lang.Long anTradingId, java.lang.Long anMemberId)
ShippingModeAccessBean[]	getAllowableShippingModes(OrderItemAccessBean aabOrderItem)
AddressAccessBean	getDefaultShippingAddress(java.lang.Long anMemberId)
AddressAccessBean	getDefaultShippingAddress(java.lang.Long anMemberId, java.lang.Long anTradingId) Deprecated. Replaced by getDefaultShippingAddress(Long anMemberId, Long anTradingId, Integer aStoreId)
AddressAccessBean	getDefaultShippingAddress(java.lang.Long anMemberId, java.lang.Long anTradingId, java.lang.Integer aStoreId) Gets the default shipping address for a specified member, a contract and a store.
AddressAccessBean	getDefaultShippingAddress(OrderItemAccessBean aabOrderItem)
ShippingModeAccessBean	getDefaultShippingMode(java.lang.Integer anStoreId)
ShippingModeAccessBean	getDefaultShippingMode(java.lang.Integer anStoreId, java.lang.Long anTradingId, java.lang.Long anMemberId)
ShippingModeAccessBean	getDefaultShippingMode(OrderItemAccessBean aabOrderItem)
static ShippingHelper	getInstance()
boolean	isPersonalAddressesAllowedForShipping(java.lang.Long aMemberId, java.lang.Long aTradingId, java.lang.Integer aStoreId) Checks if the personal addresses of a shopper could be used for a shipping address
boolean	isPersonalAddressesAllowedForShipping(OrderItemAccessBean aabOrderItem) Checks if the personal addresses of a shopper could be used for a shipping address
boolean	isShippingAddressAllowed(OrderItemAccessBean aabOrderItem, java.lang.Long anAddressId)
boolean	isShippingModeAllowed(OrderItemAccessBean aabOrderItem, java.lang.Integer anShippingModeId)

Methods inherited from class java.lang.Object

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

Constructor Detail

ShippingHelper

public ShippingHelper()

ShippingHelper constructor comment.

Method Detail

checkShippingAddress

public void checkShippingAddress(OrderItemAccessBean aabOrderItem)
                          throws ECException

Throws:

ECException

checkShippingMode

public void checkShippingMode(OrderItemAccessBean aabOrderItem)
                       throws ECException

Throws:

ECException

isShippingAddressAllowed

public boolean isShippingAddressAllowed(OrderItemAccessBean aabOrderItem,
                                        java.lang.Long anAddressId)
                                 throws ECException

Throws:

ECException

isShippingModeAllowed

public boolean isShippingModeAllowed(OrderItemAccessBean aabOrderItem,
                                     java.lang.Integer anShippingModeId)
                              throws ECException

Throws:

ECException

getAllowableShippingAddresses

public AddressAccessBean[] getAllowableShippingAddresses(OrderItemAccessBean aabOrderItem)
                                                  throws ECException

Throws:

ECException

getAllowableShippingAddresses

public AddressAccessBean[] getAllowableShippingAddresses(java.lang.Long anMemberId)
                                                  throws ECException

Throws:

ECException

getAllowableShippingAddresses

public AddressAccessBean[] getAllowableShippingAddresses(java.lang.Long anMemberId,
                                                         java.lang.Long anTradingId)
                                                  throws ECException

Deprecated. replaced by getAllowableShippingAddresses(Long anMemberId, Long anTradingId, Integer aStoreId)

Gets the allowable shipping addresses for a specified member and a contract.

Parameters:

anMemberId - the member identifier

anTradingId - the contract identifier

Returns:

an array of AddressAccessBean

Throws:

ECException - thrown when there is an error occurred.

getAllowableShippingModes

public ShippingModeAccessBean[] getAllowableShippingModes(OrderItemAccessBean aabOrderItem)
                                                   throws ECException

Throws:

ECException

getAllowableShippingModes

public ShippingModeAccessBean[] getAllowableShippingModes(java.lang.Integer anStoreId)
                                                   throws ECException

Throws:

ECException

getAllowableShippingModes

public ShippingModeAccessBean[] getAllowableShippingModes(java.lang.Integer anStoreId,
                                                          java.lang.Long anTradingId,
                                                          java.lang.Long anMemberId)
                                                   throws ECException

Throws:

ECException

getDefaultShippingAddress

public AddressAccessBean getDefaultShippingAddress(OrderItemAccessBean aabOrderItem)
                                            throws ECException

Throws:

ECException

getDefaultShippingAddress

public AddressAccessBean getDefaultShippingAddress(java.lang.Long anMemberId)
                                            throws ECException

Throws:

ECException

getDefaultShippingAddress

public AddressAccessBean getDefaultShippingAddress(java.lang.Long anMemberId,
                                                   java.lang.Long anTradingId)
                                            throws ECException

Deprecated. Replaced by getDefaultShippingAddress(Long anMemberId, Long anTradingId, Integer aStoreId)

Gets the default shipping address for a specified member and contract.

Parameters:

anMemberId - the member identifier

anTradingId - the contract identifier

Returns:

the AddressAccessBean

Throws:

ECException

getDefaultShippingMode

public ShippingModeAccessBean getDefaultShippingMode(OrderItemAccessBean aabOrderItem)
                                              throws ECException

Throws:

ECException

getDefaultShippingMode

public ShippingModeAccessBean getDefaultShippingMode(java.lang.Integer anStoreId)
                                              throws ECException

Throws:

ECException

getDefaultShippingMode

public ShippingModeAccessBean getDefaultShippingMode(java.lang.Integer anStoreId,
                                                     java.lang.Long anTradingId,
                                                     java.lang.Long anMemberId)
                                              throws ECException

Throws:

ECException

getInstance

public static ShippingHelper getInstance()

getAllowableShippingAddressesByContract

public AddressAccessBean[] getAllowableShippingAddressesByContract(java.lang.Long anMemberId,
                                                                   java.lang.Long anTradingId,
                                                                   java.lang.Integer aStoreId)
                                                            throws ECException

Get an array of allowable shipping addresses by a contract for an order item.

Parameters:

anMemberId - the member identifier

anTradingId - the contract identifier

aStoreId - the store identifier

Returns:

an array of AddressAccessBean

Throws:

ECException - thrown when there is an error occurred.

getAllowableShippingAddresses

public AddressAccessBean[] getAllowableShippingAddresses(java.lang.Long anMemberId,
                                                         java.lang.Long anTradingId,
                                                         java.lang.Integer aStoreId)
                                                  throws ECException

Gets allowable shipping address for a specified member, a contract and a store. If there is not an address specified by contract, the addresses owned by the specified member will be returned.

Parameters:

anMemberId - the specified member identifier

anTradingId - the specified contract identifier

aStoreId - the specified store identifier

Returns:

an array of AddressAccessBean

Throws:

ECException - thrown when there is an error occurs

getDefaultShippingAddress

public AddressAccessBean getDefaultShippingAddress(java.lang.Long anMemberId,
                                                   java.lang.Long anTradingId,
                                                   java.lang.Integer aStoreId)
                                            throws ECException

Gets the default shipping address for a specified member, a contract and a store. The default address for a specified member will be used. Once it could not qualify the contract definition for a shipping address, the first of allowable shipping address will be used.

Parameters:

anMemberId - the member identifier

anTradingId - the contract identifier

aStoreId - the store identifier

Returns:

an AddresssAccessBean

Throws:

ECException - thrown when there is an error occurred.

isPersonalAddressesAllowedForShipping

public boolean isPersonalAddressesAllowedForShipping(OrderItemAccessBean aabOrderItem)
                                              throws ECException

Checks if the personal addresses of a shopper could be used for a shipping address

Parameters:

aabOrderItem -

Returns:

true the personal addresses are allowed. false the personal addresses are not allowed.

Throws:

ECException - thrown when there is an error occurred.

isPersonalAddressesAllowedForShipping

public boolean isPersonalAddressesAllowedForShipping(java.lang.Long aMemberId,
                                                     java.lang.Long aTradingId,
                                                     java.lang.Integer aStoreId)
                                              throws ECException

Checks if the personal addresses of a shopper could be used for a shipping address

Parameters:

aMemberId - the member identifier.

aTradingId - the trading agreement identifier.

aStoreId - the store identifier.

Returns:

true the personal addresses are allowed. false the personal addresses are not allowed.

Throws:

ECException