com.elasticpath.domain.shipping
Interface ShippingRegion

All Superinterfaces:
Entity, EpDomain, Persistence, java.io.Serializable
All Known Implementing Classes:
ShippingRegionImpl

public interface ShippingRegion
extends Entity

A ShippingRegion represents a region that will be associated with one or more shipping services. For now, it is composed of country and a subcountry, i.e. CA(country) and BC(subcountry).


Method Summary
 java.lang.String getName()
          Get the shipping region name.
 java.util.Map getRegionMap()
          Get the Map of regions assoicated with this shippingregion.
 boolean isInShippionRegion(Address shippingAddress)
          Check if the given shippingAdress is in the range of this ShippingRegion.
 void setName(java.lang.String name)
          Set the shipping region name.
 void setRegionMap(java.util.Map regionMap)
          Set the Map of regions assoicated with this shippingregion.
 
Methods inherited from interface com.elasticpath.domain.Entity
getGuid, setGuid
 
Methods inherited from interface com.elasticpath.domain.Persistence
executeBeforePersistAction, getUidPk, isPersistent, setDefaultValues, setUidPk
 
Methods inherited from interface com.elasticpath.domain.EpDomain
getElasticPath, setElasticPath
 

Method Detail

getName

java.lang.String getName()
Get the shipping region name.

Returns:
the parameter name

getRegionMap

java.util.Map getRegionMap()
Get the Map of regions assoicated with this shippingregion. The entry of the regionMap is countryCode -> Region.

Returns:
the map of regions assoicated with this shippingregion.

isInShippionRegion

boolean isInShippionRegion(Address shippingAddress)
Check if the given shippingAdress is in the range of this ShippingRegion.

Parameters:
shippingAddress - the shippingAddress to be evaluated.
Returns:
status of whether the given shippingAdress is in the range of this ShippingRegion.

setName

void setName(java.lang.String name)
Set the shipping region name.

Parameters:
name - the parameter name

setRegionMap

void setRegionMap(java.util.Map regionMap)
Set the Map of regions assoicated with this shippingregion.

Parameters:
regionMap - the map of regions to be assoicated with this shippingregion.