atg.commerce.csr.order
Class CurrentShippingGroupSelectionDroplet

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.nucleus.TimedOperationService
              atg.nucleus.servlet.ServletService
                  atg.nucleus.servlet.HttpServletService
                      atg.servlet.DynamoServlet
                          atg.commerce.csr.order.CurrentShippingGroupSelectionDroplet

All Implemented Interfaces:

atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.logging.ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, atg.servlet.ParameterServlet, java.util.EventListener, javax.servlet.Servlet

Deprecated. -- This droplet is deprecated infavor of ApplicableShippingGroups

public class CurrentShippingGroupSelectionDroplet
extends atg.servlet.DynamoServlet

The CurrentShippingGroupSelectionDroplet is a DynamoServlet that is used to identify and select a default shipping group. The shipping groups are available from Profile, Order and ShippingGroupMapConatainer. This droplet first looks for a shipping group from the current order. If there is shipping group in the order, the shipping group that is valid for all commerce items is selected as default. If there are more than one shipping groups in the order, first valid and all commerce item supported shipping group type is seleced as the default shipping group in a random manner. If there is no shipping groups is available from the order, then the user's default shipping address is used to initialize as default. If there is no default found from the order and profile, then the shipping groups is selected randomly from the ShippingGroupMapConatainer. This servlet renders the following output parameters.

output

If there is any shipping groups found in the profile or order, those shipping groups are rendered in the in the output parameter.

newAddress

This parameter is not used anymore and it is deprecated. This parameter provides various parameter to add a new address. For example, if no other address is selected by default the new address is selected as default address and available shipping methods also available in the parameter list.

error

If there is any error, the error parameter is served. This servlet provides following parameters.

shippingGroups

This parameter contains list of all shipping groups.

selectedShippingGroup

This parameter is the default selected shipping group.

selectedShippingGroupNickname

This parameter is the default selected shipping group nickname.

shippingGroupTypeForAllItems

This parameter is the supported shipping group types for all commerce items in the order.

shippingGroupTypeForAnyItem

This parameter is the supported shipping group types for any commerce item in the order.

See Also:

-- This FormHandler resets USER_SELECTED_SHIP_TO_NICKNAME based on the result of add address operation., This droplet initializes ShippingGroupMapContainer, ApplicableShippingGroups

Field Summary

static java.lang.String	CLASS_VERSION Deprecated.
static atg.nucleus.naming.ParameterName	ERROR Deprecated.
static atg.nucleus.naming.ParameterName	LOCALE_PARAM Deprecated.
static atg.nucleus.naming.ParameterName	NEW_ADDRESS Deprecated.
static atg.nucleus.naming.ParameterName	NEW_SHIPPING_GROUP Deprecated.
static java.lang.String	ORDER Deprecated.
static atg.nucleus.naming.ParameterName	OUTPUT Deprecated.
static atg.nucleus.naming.ParameterName	SELECT_DEFAULT_FROM_ORDER Deprecated.
static java.lang.String	SELECTED_SHIPPING_GROUP Deprecated.
static java.lang.String	SELECTED_SHIPPING_GROUP_NICKNAME Deprecated.
static java.lang.String	SHIPPING_GROUP_TYPE_FOR_ALL_ITEMS Deprecated.
static java.lang.String	SHIPPING_GROUP_TYPE_FOR_ANY_ITEM Deprecated.
static java.lang.String	SHIPPING_GROUPS Deprecated.
static java.lang.String	SHIPPING_METHODS Deprecated.
static atg.nucleus.naming.ParameterName	USER_SELECTED_SHIP_TO_NICKNAME Deprecated.
static int	ZERO Deprecated.

Fields inherited from class atg.servlet.DynamoServlet

mAllowCleanupRequest, mParameters

Fields inherited from class atg.nucleus.servlet.ServletService

SERVLET_INFO_KEY

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

CurrentShippingGroupSelectionDroplet()
Deprecated.

Method Summary

void	addNewAddressShippingMethod(java.util.Map pShippingMethods, atg.commerce.order.ShippingGroup pShippingGroup) Deprecated.
protected void	copyConfiguration() Deprecated. Copy property settings from the optional PurchaseProcessConfiguration component.
void	doStartService() Deprecated. Perform one-time startup operations, including copying property settings from the optional PurchaseProcessConfiguration component.
java.lang.String	firstValidAddressNickname(java.util.Map pShippingGroupMap) Deprecated. This method returns first valid shipping group that is supported by all commerce items.
java.util.HashMap	generateShippingMethods(java.util.Map pShippingGroups, atg.servlet.DynamoHttpServletRequest pRequest) Deprecated.
java.util.List	getAvailableMethods(atg.commerce.order.ShippingGroup pShippingGroup) Deprecated.
atg.commerce.order.purchase.PurchaseProcessConfiguration	getConfiguration() Deprecated. Returns property Configuration
java.lang.Object	getInputParameter(atg.servlet.DynamoHttpServletRequest pReq, atg.nucleus.naming.ParameterName pInputParamter) Deprecated. Gets the input parameter values.
java.lang.String	getNewAddressNickname() Deprecated.
atg.commerce.order.ShippingGroup	getNewShippingGroup() Deprecated.
atg.commerce.order.Order	getOrder() Deprecated. Return the Order property.
atg.userprofiling.Profile	getProfile() Deprecated. Return the Profile property.
atg.nucleus.ServiceMap	getShippingGroupInitializers() Deprecated.
atg.commerce.order.ShippingGroupManager	getShippingGroupManager() Deprecated.
atg.commerce.order.purchase.ShippingGroupMapContainer	getShippingGroupMapContainer() Deprecated. Return the ShippingGroupMapContainer property.
atg.commerce.pricing.ShippingPricingEngine	getShippingPricingEngine() Deprecated. the shipping pricing engine to consult for available shipping methods
protected java.util.Locale	getUserLocale(atg.servlet.DynamoHttpServletRequest pRequest) Deprecated. Returns the locale associated with the request.
atg.commerce.pricing.PricingModelHolder	getUserPricingModels() Deprecated. Returns property UserPricingModels
java.lang.String	getUserSelectedShipToNickname() Deprecated.
atg.commerce.order.ShippingGroup	getValidHardGoodShippingGroup(atg.commerce.order.HardgoodShippingGroup pShippingGroup) Deprecated.
protected void	initializeRequestParameters(atg.servlet.DynamoHttpServletRequest pRequest) Deprecated. The initializeRequestParameters method gathers the necessary input parameters and uses them to adjust initialization requirements.
boolean	isIncludeShippingMethods() Deprecated. Returns the includeShippingMethods.
boolean	isNullAddress(atg.core.util.Address pAddress) Deprecated.
boolean	isSelectDefaultFromOrder() Deprecated. Returns the selectDefaultFromOrder.
boolean	isServeNewAddressParamter() Deprecated.
boolean	isShippingAddressSupportedByAllItems(atg.commerce.order.ShippingGroup pShippingGroup) Deprecated. This method takes the currently passed in shipping group and checks to see if the shipping group type is supported by all commerce items in the order.
boolean	isValidAddress(atg.commerce.order.ShippingGroup pShippingGroup) Deprecated. This method uses ShippingGroupPropertyContainer.isEmpty to check for the shipping group's emptiness.
protected java.lang.String	obtainApplicationSelectedShippingGroupNickname() Deprecated. This method returns a user's default shipping group nickname or first available shipping group nickname from ShippingGroupMapContainer.
java.lang.String	selectOrderAddress() Deprecated. This method loops through shipping groups in the order and checks to see if the shipping group is supported by all commerce items.
void	serveNewAddressParameter(java.lang.String pSelectedShipToNickname, atg.commerce.order.ShippingGroup pNewShippingGroup, atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Deprecated.
java.lang.String	serveOutputParameter(java.lang.String pSelectedShipToNickname, atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Deprecated. This method serves the output parameter.
void	service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Deprecated. This method serves output/error and newAddress parameter.
void	setConfiguration(atg.commerce.order.purchase.PurchaseProcessConfiguration pConfiguration) Deprecated. Sets property Configuration
void	setIncludeShippingMethods(boolean pIncludeShippingMethods) Deprecated. Sets the includeShippingMethods.
void	setNewAddressNickname(java.lang.String pNewAddressNickname) Deprecated.
void	setNewShippingGroup(atg.commerce.order.ShippingGroup pNewShippingGroup) Deprecated.
void	setOrder(atg.commerce.order.Order pOrder) Deprecated. Set the Order property.
void	setProfile(atg.userprofiling.Profile pProfile) Deprecated. Set the Profile property.
void	setSelectDefaultFromOrder(boolean pSelectDefaultFromOrder) Deprecated. Sets the selectDefaultFromOrder.
void	setServeNewAddressParamter(boolean pServeNewAddressParamter) Deprecated.
void	setShippingGroupInitializers(atg.nucleus.ServiceMap pShippingGroupInitializers) Deprecated.
void	setShippingGroupManager(atg.commerce.order.ShippingGroupManager pShippingGroupManager) Deprecated.
void	setShippingGroupMapContainer(atg.commerce.order.purchase.ShippingGroupMapContainer pShippingGroupMapContainer) Deprecated. Set the ShippingGroupMapContainer property.
void	setShippingPricingEngine(atg.commerce.pricing.ShippingPricingEngine pShippingPricingEngine) Deprecated. the shipping pricing engine to consult for available shipping methods
void	setUserPricingModels(atg.commerce.pricing.PricingModelHolder pUserPricingModels) Deprecated. Sets property UserPricingModels
void	setUserSelectedShipToNickname(java.lang.String pUserSelectedShipToNickname) Deprecated.
java.util.Map	supplyValidAddresses(java.util.Map pAddressMap) Deprecated. This method creates a temporary map and adds only non null addresses to the temporary map.

Methods inherited from class atg.servlet.DynamoServlet

doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, service, service, setParameter

Methods inherited from class atg.nucleus.servlet.ServletService

destroy, getServletConfig, getServletInfo, init, setServletInfo

Methods inherited from class atg.nucleus.TimedOperationService

getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Deprecated.

ZERO

public static final int ZERO

Deprecated.

See Also:

Constant Field Values

ORDER

public static final java.lang.String ORDER

Deprecated.

See Also:

Constant Field Values

USER_SELECTED_SHIP_TO_NICKNAME

public static final atg.nucleus.naming.ParameterName USER_SELECTED_SHIP_TO_NICKNAME

Deprecated.

NEW_SHIPPING_GROUP

public static final atg.nucleus.naming.ParameterName NEW_SHIPPING_GROUP

Deprecated.

LOCALE_PARAM

public static final atg.nucleus.naming.ParameterName LOCALE_PARAM

Deprecated.

SELECT_DEFAULT_FROM_ORDER

public static final atg.nucleus.naming.ParameterName SELECT_DEFAULT_FROM_ORDER

Deprecated.

OUTPUT

public static final atg.nucleus.naming.ParameterName OUTPUT

Deprecated.

ERROR

public static final atg.nucleus.naming.ParameterName ERROR

Deprecated.

NEW_ADDRESS

public static final atg.nucleus.naming.ParameterName NEW_ADDRESS

Deprecated.

SELECTED_SHIPPING_GROUP_NICKNAME

public static final java.lang.String SELECTED_SHIPPING_GROUP_NICKNAME

Deprecated.

See Also:

Constant Field Values

SELECTED_SHIPPING_GROUP

public static final java.lang.String SELECTED_SHIPPING_GROUP

Deprecated.

See Also:

Constant Field Values

SHIPPING_GROUPS

public static final java.lang.String SHIPPING_GROUPS

Deprecated.

See Also:

Constant Field Values

SHIPPING_METHODS

public static final java.lang.String SHIPPING_METHODS

Deprecated.

See Also:

Constant Field Values

SHIPPING_GROUP_TYPE_FOR_ALL_ITEMS

public static final java.lang.String SHIPPING_GROUP_TYPE_FOR_ALL_ITEMS

Deprecated.

See Also:

Constant Field Values

SHIPPING_GROUP_TYPE_FOR_ANY_ITEM

public static final java.lang.String SHIPPING_GROUP_TYPE_FOR_ANY_ITEM

Deprecated.

See Also:

Constant Field Values

Constructor Detail

CurrentShippingGroupSelectionDroplet

public CurrentShippingGroupSelectionDroplet()

Deprecated.

Method Detail

isIncludeShippingMethods

public boolean isIncludeShippingMethods()

Deprecated.

Returns the includeShippingMethods. In 2008.1, there is no need to return shipping methods with the shipping address. If you want to include this parameter in the oparam values, this flag should be turned on.

Returns:

includeShippingMethods

setIncludeShippingMethods

public void setIncludeShippingMethods(boolean pIncludeShippingMethods)

Deprecated.

Sets the includeShippingMethods. In 2008.1, there is no need to return shipping methods with the shipping address. If you want to include this parameter in the oparam values, this flag should be turned on.

Parameters:

pIncludeShippingMethods -

isSelectDefaultFromOrder

public boolean isSelectDefaultFromOrder()

Deprecated.

Returns the selectDefaultFromOrder.

Returns:

selectDefaultFromOrder

setSelectDefaultFromOrder

public void setSelectDefaultFromOrder(boolean pSelectDefaultFromOrder)

Deprecated.

Sets the selectDefaultFromOrder.

Parameters:

pSelectDefaultFromOrder -

getShippingGroupInitializers

public atg.nucleus.ServiceMap getShippingGroupInitializers()

Deprecated.

Returns:

the shippingGroupInitializers

setShippingGroupInitializers

public void setShippingGroupInitializers(atg.nucleus.ServiceMap pShippingGroupInitializers)

Deprecated.

Parameters:

pShippingGroupInitializers - The shippingGroupInitializers to set.

getShippingGroupManager

public atg.commerce.order.ShippingGroupManager getShippingGroupManager()

Deprecated.

Returns:

the shippingGroupManager

setShippingGroupManager

public void setShippingGroupManager(atg.commerce.order.ShippingGroupManager pShippingGroupManager)

Deprecated.

Parameters:

pShippingGroupManager - The shippingGroupManager to set.

getNewShippingGroup

public atg.commerce.order.ShippingGroup getNewShippingGroup()

Deprecated.

Returns:

the newShippingGroup

setNewShippingGroup

public void setNewShippingGroup(atg.commerce.order.ShippingGroup pNewShippingGroup)

Deprecated.

Parameters:

pNewShippingGroup - The newShippingGroup to set.

getUserSelectedShipToNickname

public java.lang.String getUserSelectedShipToNickname()

Deprecated.

Returns:

the userSelectedShipToNickname

setUserSelectedShipToNickname

public void setUserSelectedShipToNickname(java.lang.String pUserSelectedShipToNickname)

Deprecated.

Parameters:

pUserSelectedShipToNickname - The userSelectedShipToNickname to set.

setConfiguration

public void setConfiguration(atg.commerce.order.purchase.PurchaseProcessConfiguration pConfiguration)

Deprecated.

Sets property Configuration

Parameters:

pConfiguration - a PurchaseProcessConfiguration value

getConfiguration

public atg.commerce.order.purchase.PurchaseProcessConfiguration getConfiguration()

Deprecated.

Returns property Configuration

Returns:

a PurchaseProcessConfiguration value

setProfile

public void setProfile(atg.userprofiling.Profile pProfile)

Deprecated.

Set the Profile property.

Parameters:

pProfile - a Profile value

getProfile

public atg.userprofiling.Profile getProfile()

Deprecated.

Return the Profile property.

Returns:

a Profile value

setOrder

public void setOrder(atg.commerce.order.Order pOrder)

Deprecated.

Set the Order property.

Parameters:

pOrder - an Order value

getOrder

public atg.commerce.order.Order getOrder()

Deprecated.

Return the Order property.

Returns:

an Order value

setShippingGroupMapContainer

public void setShippingGroupMapContainer(atg.commerce.order.purchase.ShippingGroupMapContainer pShippingGroupMapContainer)

Deprecated.

Set the ShippingGroupMapContainer property.

Parameters:

pShippingGroupMapContainer - a ShippingGroupMapContainer value

getShippingGroupMapContainer

public atg.commerce.order.purchase.ShippingGroupMapContainer getShippingGroupMapContainer()

Deprecated.

Return the ShippingGroupMapContainer property.

Returns:

a ShippingGroupMapContainer value

setUserPricingModels

public void setUserPricingModels(atg.commerce.pricing.PricingModelHolder pUserPricingModels)

Deprecated.

Sets property UserPricingModels

getUserPricingModels

public atg.commerce.pricing.PricingModelHolder getUserPricingModels()

Deprecated.

Returns property UserPricingModels

setShippingPricingEngine

public void setShippingPricingEngine(atg.commerce.pricing.ShippingPricingEngine pShippingPricingEngine)

Deprecated.

the shipping pricing engine to consult for available shipping methods

Parameters:

pShippingPricingEngine - new value to set

getShippingPricingEngine

public atg.commerce.pricing.ShippingPricingEngine getShippingPricingEngine()

Deprecated.

the shipping pricing engine to consult for available shipping methods

Returns:

property ShippingPricingEngine

getNewAddressNickname

public java.lang.String getNewAddressNickname()

Deprecated.

Returns:

Returns the newAddressNickname.

setNewAddressNickname

public void setNewAddressNickname(java.lang.String pNewAddressNickname)

Deprecated.

Parameters:

pNewAddressNickname - The newAddressNickname to set.

isServeNewAddressParamter

public boolean isServeNewAddressParamter()

Deprecated.

Returns:

Returns the serveNewAddressParamter.

setServeNewAddressParamter

public void setServeNewAddressParamter(boolean pServeNewAddressParamter)

Deprecated.

Parameters:

pServeNewAddressParamter - The serveNewAddressParamter to set.

doStartService

public void doStartService()
                    throws atg.nucleus.ServiceException

Deprecated.

Perform one-time startup operations, including copying property settings from the optional PurchaseProcessConfiguration component.

Overrides:

doStartService in class atg.nucleus.GenericService

Throws:

atg.nucleus.ServiceException

service

public void service(atg.servlet.DynamoHttpServletRequest pRequest,
                    atg.servlet.DynamoHttpServletResponse pResponse)
             throws javax.servlet.ServletException,
                    java.io.IOException

Deprecated.

This method serves output/error and newAddress parameter. 1) If the application could not find any shipping groups for an user, then this method will serve the error parameter. 2) The output parameter is served if the application finds any shipping group in the ShippingGroupMapContainer. The ShippingGroupMapContainer is initialized by the ShippingGroupDroplet. This droplet will be used in conjunction with ShippingGroupDroplet or some application that initializes ShippingGroupMapContainer. 3) Also this method serves newAddress parameter. Using serveNewAddressParamter flag property, customers can decide whether to serve or not to serve newAddress parameter. This parameter is served to add new address with other already available addresses.

Overrides:

service in class atg.servlet.DynamoServlet

Parameters:

pRequest -

pResponse -

Throws:

javax.servlet.ServletException

java.io.IOException

getInputParameter

public java.lang.Object getInputParameter(atg.servlet.DynamoHttpServletRequest pReq,
                                          atg.nucleus.naming.ParameterName pInputParamter)

Deprecated.

Gets the input parameter values.

Parameters:

pReq -

pInputParamter -

Returns:

Input parameter value

initializeRequestParameters

protected void initializeRequestParameters(atg.servlet.DynamoHttpServletRequest pRequest)

Deprecated.

The initializeRequestParameters method gathers the necessary input parameters and uses them to adjust initialization requirements.

Parameters:

pRequest - a DynamoHttpServletRequest value

serveOutputParameter

public java.lang.String serveOutputParameter(java.lang.String pSelectedShipToNickname,
                                             atg.servlet.DynamoHttpServletRequest pRequest,
                                             atg.servlet.DynamoHttpServletResponse pResponse)
                                      throws javax.servlet.ServletException,
                                             java.io.IOException

Deprecated.

This method serves the output parameter.

Parameters:

pSelectedShipToNickname -

pRequest -

pResponse -

Throws:

javax.servlet.ServletException

java.io.IOException

serveNewAddressParameter

public void serveNewAddressParameter(java.lang.String pSelectedShipToNickname,
                                     atg.commerce.order.ShippingGroup pNewShippingGroup,
                                     atg.servlet.DynamoHttpServletRequest pRequest,
                                     atg.servlet.DynamoHttpServletResponse pResponse)
                              throws javax.servlet.ServletException,
                                     java.io.IOException

Deprecated.

This method serves the newAddress parameter. There are three variations of newAddress parameter is served. 1) If the user did not select anything or the page is served for the very first time. This time newAddress parameter is served and available shippingMethods for that ShippingGroup is added to the shippingMethods map 2) If the user already tried to add new address and it is unsuccessful. At this time, the user may have entered some invalid information or selected proper shipping methods. Thus use the shipping group created by the user to fetch its available methods 3) If the user did not enter any information on the Add address section and for some reason, they came to same page and they already selected a valid shipping group.

Parameters:

pSelectedShipToNickname -

pNewShippingGroup -

pRequest -

pResponse -

Throws:

javax.servlet.ServletException

java.io.IOException

copyConfiguration

protected void copyConfiguration()

Deprecated.

Copy property settings from the optional PurchaseProcessConfiguration component. Property values that were configured locally are preserved. Configures the following properties (if not already set):

• profile
• shippingGroupMapContainer
• shippingGroupManager

obtainApplicationSelectedShippingGroupNickname

protected java.lang.String obtainApplicationSelectedShippingGroupNickname()

Deprecated.

This method returns a user's default shipping group nickname or first available shipping group nickname from ShippingGroupMapContainer. First this method checks to see if there is any user's desired default address. If there is any default address is available, then it will return the default shipping group nick name. If the user does not have any default shipping address, then this method will return the first shipping group from the shipping group map. Since this is coming from map, always it may not return the same address nickname.

Returns:

String User's default shipping group nickname or first shipping group nickname from ShippingGroupMap

selectOrderAddress

public java.lang.String selectOrderAddress()

Deprecated.

This method loops through shipping groups in the order and checks to see if the shipping group is supported by all commerce items. Then this method finds the nickname of a shipping group in the order. If there is a valid nickname found, then the shipping group is selected as default selection.

generateShippingMethods

public java.util.HashMap generateShippingMethods(java.util.Map pShippingGroups,
                                                 atg.servlet.DynamoHttpServletRequest pRequest)

Deprecated.

This method collects all the available shipping methods for each addresses or shipping groups. This method returns a map which contains ShippingGroupName as the key and available method as value.

Parameters:

pShippingGroups - Shipping Groups

pRequest -

Returns:

HashMap ShippingMethods

getUserLocale

protected java.util.Locale getUserLocale(atg.servlet.DynamoHttpServletRequest pRequest)

Deprecated.

Returns the locale associated with the request. The method first searches for a request parameter named locale. This value can be either a java.util.Locale object or a String which represents the locale. Next if the useRequestLocale property is true, then the locale of the request will be returned. Finally, if the locale cannot be determined, the the defaultLocale property is used.

Parameters:

pRequest - the request to be processed

Returns:

the locale to be associated with this user

Throws:

javax.servlet.ServletException - an application specific error occurred processing this request

java.io.IOException - an error occurred reading data from the request or writing data to the response.

getValidHardGoodShippingGroup

public atg.commerce.order.ShippingGroup getValidHardGoodShippingGroup(atg.commerce.order.HardgoodShippingGroup pShippingGroup)

Deprecated.

This methods checks the instance and if the null instance is passed in, it will return new HardgoodShippingGroup object.

Parameters:

pShippingGroup - This instance may be null or not null

Returns:

HardgoodShippingGroup if the shipping group is null, create new and return

addNewAddressShippingMethod

public void addNewAddressShippingMethod(java.util.Map pShippingMethods,
                                        atg.commerce.order.ShippingGroup pShippingGroup)

Deprecated.

This method adds the shipping method to the ShippingMethods map. This map will be transferred to a Javascript variable. If an agent navigates from one address to other, the UI can display the available shipping methods for that address. If the UI is trying to add new address, the available shipping addresses should be available in the UI to switch. In order to provide the list of available methods, this method adds them to the ShippingMethods map.

Parameters:

pShippingMethods - that contains all shipping address name as the key and its available methods

pShippingGroup - the shipping group that needs to add its available addresses to the map

getAvailableMethods

public java.util.List getAvailableMethods(atg.commerce.order.ShippingGroup pShippingGroup)

Deprecated.

This method provides the list of all available shipping methods by the shipping group.

Parameters:

pShippingGroup - ShippingGroup that needs shipping methods

Returns:

List list of available shipping methods.

isNullAddress

public boolean isNullAddress(atg.core.util.Address pAddress)

Deprecated.

Query whether an Address object is null or empty.

Returns:

true if the address object is null or if every property in the address is null, false otherwise.

firstValidAddressNickname

public java.lang.String firstValidAddressNickname(java.util.Map pShippingGroupMap)

Deprecated.

This method returns first valid shipping group that is supported by all commerce items.

Parameters:

pShippingGroupMap -

Returns:

String

supplyValidAddresses

public java.util.Map supplyValidAddresses(java.util.Map pAddressMap)

Deprecated.

This method creates a temporary map and adds only non null addresses to the temporary map. This method eliminates any null addresses from the map. This method does not remove the null entry from the ShippingGroupMap.

Parameters:

pAddressMap -

Returns:

Map

isShippingAddressSupportedByAllItems

public boolean isShippingAddressSupportedByAllItems(atg.commerce.order.ShippingGroup pShippingGroup)

Deprecated.

This method takes the currently passed in shipping group and checks to see if the shipping group type is supported by all commerce items in the order. If the shipping group passed in one of the list of supported shipping group types, this method returns true. Otherwise returns false.

Parameters:

pShippingGroup - -- The shipping group to be checked against the list of supported shipping group types

Returns:

true/false based on the all supported shipping group types list

isValidAddress

public boolean isValidAddress(atg.commerce.order.ShippingGroup pShippingGroup)

Deprecated.

This method uses ShippingGroupPropertyContainer.isEmpty to check for the shipping group's emptiness. If the shipping group has any information, then the shipping group is valid.

Parameters:

pShippingGroup -

Returns:

if the shipping group has any information returns true, false otherwise.