atg.commerce.order.purchase
Interface ShippingGroupMapContainer

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ShippingGroupContainerService

public interface ShippingGroupMapContainer
extends java.io.Serializable

The ShippingGroupMapContainer interface is used to represent a container of a Map of ShippingGroup names [key] to ShippingGroups [value].

Field Summary

static java.lang.String

CLASS_VERSION

Method Summary

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.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() Get a ShippingGroupMap which manages the user's ShippingGroup
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
void	removeAllShippingGroups() Remove all the user's ShippingGroups from the ShippingGroupMap
void	removeShippingGroup(java.lang.String pShippingGroupName) Remove a ShippingGroup from the ShippingGroupMap based on its ShippingGroupName
void	setDefaultShippingGroupName(java.lang.String pDefaultShippingGroupName) Set a default ShippingGroupName for the user's default ShippingGroup

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Method Detail

getShippingGroupMap

java.util.Map getShippingGroupMap()

Get a ShippingGroupMap which manages the user's ShippingGroup

Returns:

a Map value

getShippingGroup

ShippingGroup getShippingGroup(java.lang.String pShippingGroupName)

Get a ShippingGroup based on its ShippingGroupName

Parameters:

pShippingGroupName - a String value

Returns:

a ShippingGroup value

addShippingGroup

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

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

Parameters:

pShippingGroupName - a String value

pShippingGroup - a ShippingGroup value

removeAllShippingGroups

void removeAllShippingGroups()

Remove all the user's ShippingGroups from the ShippingGroupMap

removeShippingGroup

void removeShippingGroup(java.lang.String pShippingGroupName)

Remove a ShippingGroup from the ShippingGroupMap based on its ShippingGroupName

Parameters:

pShippingGroupName - a String value

setDefaultShippingGroupName

void setDefaultShippingGroupName(java.lang.String pDefaultShippingGroupName)

Set a default ShippingGroupName for the user's default ShippingGroup

Parameters:

pDefaultShippingGroupName - a String value

getDefaultShippingGroupName

java.lang.String getDefaultShippingGroupName()

Get the default ShippingGroupName for the user's default ShippingGroup

Returns:

a String value

getShippingGroupNames

java.util.Set getShippingGroupNames()

Get all the user's ShippingGroupNames

Returns:

a Set value

getShippingGroupName

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

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

getNewShippingGroupName

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

Returns a new name for a shipping group

Parameters:

pShippingGroup -

pShippingGroupMatchers -

Returns:

addShippingGroupToMap

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

Adds a shipping group to the map container.

Parameters:

pShippingGroup -

Returns:

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