atg.commerce.order.purchase

Class ShippingGroupContainerService

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.order.purchase.ShippingGroupContainerService

All Implemented Interfaces:

CommerceItemShippingInfoContainer, ShippingGroupMapContainer, atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, atg.servlet.sessionsaver.Restoreable, java.io.Serializable, java.util.EventListener

public class ShippingGroupContainerService
extends GenericService
implements ShippingGroupMapContainer, CommerceItemShippingInfoContainer, atg.servlet.sessionsaver.Restoreable

The ShippingGroupContainerService is a convenient session scoped component which implements both the ShippingGroupMapContainer and the CommerceItemShippingInfoContainer interfaces. This component is responsible for keeping track of both the user's authorized ShippingGroups, as well as the CommerceItemShippingInfo objects for a user's Order. Restoreable is implemented to clear up shipping group references after an session fail over or session migration. In certain situations, shipping groups could be loaded from the order and order and this container may have a reference to the same shipping group instance. On session fail over, if we do not clear the references, the out-dated references will obstruct the check out process.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION
protected java.lang.String	mShoppingCartPath

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

Constructors

Constructor and Description
ShippingGroupContainerService() Creates a new ShippingGroupContainerService instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCommerceItemShippingInfo(java.lang.String pCommerceItemId, CommerceItemShippingInfo pCommerceItemShippingInfo) Add a CommerceItemInfo to the CommerceItemShippingInfoMap.
void	addShippingGroup(java.lang.String pShippingGroupName, ShippingGroup pShippingGroup) Add a ShippingGroup to the ShippingGroupMap, the key will be its ShippingGroupName
java.lang.String	addShippingGroupToMap(ShippingGroup pShippingGroup, java.util.Collection pShippingGroupMatchers) Adds a shipping group to the map container.
java.util.List	getAllCommerceItemShippingInfos() Get the List of all the CommerceItemShippingInfos from the CommerceItemShippingInfoMap
java.util.Map	getCommerceItemShippingInfoMap() Return the CommerceItemShippingInfoMap property.
java.util.List	getCommerceItemShippingInfos(java.lang.String pCommerceItemId) Get the List of CommerceItemShippingInfos based on the CommerceItemId as the key to the CommerceItemShippingInfoMap
java.lang.String	getDefaultShippingGroupName() Get the default ShippingGroupName for the user's default ShippingGroup
java.lang.String	getNewShippingGroupName(ShippingGroup pShippingGroup, java.util.Collection pShippingGroupMatchers) Returns a new name for a shipping group
ShippingGroup	getShippingGroup(java.lang.String pShippingGroupName) Get a ShippingGroup based on its ShippingGroupName
java.util.Map	getShippingGroupMap() Return the ShippingGroupMap property.
java.lang.String	getShippingGroupName(ShippingGroup pShippingGroup, java.util.Collection pShippingGroupMatchers) Returns the name that the shipping group is mapped to in the map.
java.util.Set	getShippingGroupNames() Get all the user's ShippingGroupNames
java.lang.String	getShoppingCartPath() This property is used on session restore and to look up the ShoppingCart on session fail over.
void	removeAllCommerceItemShippingInfos() Remove all the CommerceItemInfos from the CommerceItemShippingInfoMap.
void	removeAllShippingGroups() Remove all the user's ShippingGroups from the ShippingGroupMap
void	removeCommerceItemShippingInfos(java.lang.String pCommerceItemId) Remove all the CommerceItemInfos whose key is the input CommerceItemId from the CommerceItemShippingInfoMap.
void	removeShippingGroup(java.lang.String pShippingGroupName) Remove a ShippingGroup from the ShippingGroupMap based on its ShippingGroupName
void	sessionRestored() This method is called after an object has been recovered from a session's backup server, either as a result of session fail over or session migration.
void	setCommerceItemShippingInfoMap(java.util.Map pCommerceItemShippingInfoMap) Set the CommerceItemShippingInfoMap property.
void	setDefaultShippingGroupName(java.lang.String pDefaultShippingGroupName) Set a default ShippingGroupName for the user's default ShippingGroup
void	setShippingGroupMap(java.util.Map pShippingGroupMap) Set the ShippingGroupMap property.
void	setShoppingCartPath(java.lang.String pShoppingCartPath) This property is used on session restore and to look up the ShoppingCart on session fail over.

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, 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

mShoppingCartPath

protected java.lang.String mShoppingCartPath

Constructor Detail

ShippingGroupContainerService

public ShippingGroupContainerService()

Creates a new ShippingGroupContainerService instance.

Method Detail

getShoppingCartPath

public java.lang.String getShoppingCartPath()

This property is used on session restore and to look up the ShoppingCart on session fail over. Returns the shoppingCartPath.

Returns:

shoppingCartPath

setShoppingCartPath

public void setShoppingCartPath(java.lang.String pShoppingCartPath)

This property is used on session restore and to look up the ShoppingCart on session fail over. Sets the shoppingCartPath.

Parameters:

pShoppingCartPath -

setCommerceItemShippingInfoMap

public void setCommerceItemShippingInfoMap(java.util.Map pCommerceItemShippingInfoMap)

Set the CommerceItemShippingInfoMap property.

Parameters:

pCommerceItemShippingInfoMap - a Map value

getCommerceItemShippingInfoMap

public java.util.Map getCommerceItemShippingInfoMap()

Return the CommerceItemShippingInfoMap property.

Specified by:

getCommerceItemShippingInfoMap in interface CommerceItemShippingInfoContainer

Returns:

a Map value

setShippingGroupMap

public void setShippingGroupMap(java.util.Map pShippingGroupMap)

Set the ShippingGroupMap property.

Parameters:

pShippingGroupMap - a Map value

getShippingGroupMap

public java.util.Map getShippingGroupMap()

Return the ShippingGroupMap property.

Specified by:

getShippingGroupMap in interface ShippingGroupMapContainer

Returns:

a Map value

getCommerceItemShippingInfos

public java.util.List getCommerceItemShippingInfos(java.lang.String pCommerceItemId)

Get the List of CommerceItemShippingInfos based on the CommerceItemId as the key to the CommerceItemShippingInfoMap

Specified by:

getCommerceItemShippingInfos in interface CommerceItemShippingInfoContainer

Parameters:

pCommerceItemId - a String value

Returns:

a List value

getAllCommerceItemShippingInfos

public java.util.List getAllCommerceItemShippingInfos()

Get the List of all the CommerceItemShippingInfos from the CommerceItemShippingInfoMap

Specified by:

getAllCommerceItemShippingInfos in interface CommerceItemShippingInfoContainer

Returns:

a List value

addCommerceItemShippingInfo

public void addCommerceItemShippingInfo(java.lang.String pCommerceItemId,
                               CommerceItemShippingInfo pCommerceItemShippingInfo)

Add a CommerceItemInfo to the CommerceItemShippingInfoMap. The key to this Map will be the CommerceItemId.

Specified by:

addCommerceItemShippingInfo in interface CommerceItemShippingInfoContainer

Parameters:

pCommerceItemId - a String value

pCommerceItemShippingInfo - a CommerceItemShippingInfo value

removeAllCommerceItemShippingInfos

public void removeAllCommerceItemShippingInfos()

Remove all the CommerceItemInfos from the CommerceItemShippingInfoMap.

Specified by:

removeAllCommerceItemShippingInfos in interface CommerceItemShippingInfoContainer

removeCommerceItemShippingInfos

public void removeCommerceItemShippingInfos(java.lang.String pCommerceItemId)

Remove all the CommerceItemInfos whose key is the input CommerceItemId from the CommerceItemShippingInfoMap.

Specified by:

removeCommerceItemShippingInfos in interface CommerceItemShippingInfoContainer

Parameters:

pCommerceItemId - a String value

getShippingGroup

public ShippingGroup getShippingGroup(java.lang.String pShippingGroupName)

Get a ShippingGroup based on its ShippingGroupName

Specified by:

getShippingGroup in interface ShippingGroupMapContainer

Parameters:

pShippingGroupName - a String value

Returns:

a ShippingGroup value

addShippingGroup

public void addShippingGroup(java.lang.String pShippingGroupName,
                    ShippingGroup pShippingGroup)

Add a ShippingGroup to the ShippingGroupMap, the key will be its ShippingGroupName

Specified by:

addShippingGroup in interface ShippingGroupMapContainer

Parameters:

pShippingGroupName - a String value

pShippingGroup - a ShippingGroup value

removeAllShippingGroups

public void removeAllShippingGroups()

Remove all the user's ShippingGroups from the ShippingGroupMap

Specified by:

removeAllShippingGroups in interface ShippingGroupMapContainer

removeShippingGroup

public void removeShippingGroup(java.lang.String pShippingGroupName)

Remove a ShippingGroup from the ShippingGroupMap based on its ShippingGroupName

Specified by:

removeShippingGroup in interface ShippingGroupMapContainer

Parameters:

pShippingGroupName - a String value

setDefaultShippingGroupName

public void setDefaultShippingGroupName(java.lang.String pDefaultShippingGroupName)

Set a default ShippingGroupName for the user's default ShippingGroup

Specified by:

setDefaultShippingGroupName in interface ShippingGroupMapContainer

Parameters:

pDefaultShippingGroupName - a String value

getDefaultShippingGroupName

public java.lang.String getDefaultShippingGroupName()

Get the default ShippingGroupName for the user's default ShippingGroup

Specified by:

getDefaultShippingGroupName in interface ShippingGroupMapContainer

Returns:

a String value

getShippingGroupNames

public java.util.Set getShippingGroupNames()

Get all the user's ShippingGroupNames

Specified by:

getShippingGroupNames in interface ShippingGroupMapContainer

Returns:

a Set value

getShippingGroupName

public java.lang.String getShippingGroupName(ShippingGroup pShippingGroup,
                                    java.util.Collection pShippingGroupMatchers)

Returns the name that the shipping group is mapped to in the map.

Specified by:

getShippingGroupName in interface ShippingGroupMapContainer

getNewShippingGroupName

public java.lang.String getNewShippingGroupName(ShippingGroup pShippingGroup,
                                       java.util.Collection pShippingGroupMatchers)

Returns a new name for a shipping group

Specified by:

getNewShippingGroupName in interface ShippingGroupMapContainer

Parameters:

pShippingGroup -

pShippingGroupMatchers -

Returns:

addShippingGroupToMap

public java.lang.String addShippingGroupToMap(ShippingGroup pShippingGroup,
                                     java.util.Collection pShippingGroupMatchers)

Adds a shipping group to the map container.

Specified by:

addShippingGroupToMap in interface ShippingGroupMapContainer

Parameters:

pShippingGroup -

Returns:

name used as the key in the map. If null then the shipping group is not added to the map.

sessionRestored

public void sessionRestored()

This method is called after an object has been recovered from a session's backup server, either as a result of session fail over or session migration. If this component could be used in the window or session scope. Once the component is recovered from the session fail over, if there is any shipping groups are loaded from the current order, replace those shipping groups from the order.

Specified by:

sessionRestored in interface atg.servlet.sessionsaver.Restoreable