com.elasticpath.domain.shipping
Interface Region

All Superinterfaces:

EpDomain, java.io.Serializable, Transient

All Known Implementing Classes:

RegionImpl

public interface Region
extends Transient

A Region represents a geography definition of an area. For now, it is composed of country and a subcountry, i.e. CA(country) and BC(subcountry).

Method Summary

Region	fromString(java.lang.String regionStr) Return the Region from parsing the given string representation.
java.lang.String	getCountryCode() Get the region's country code (ISO country code).
java.util.List	getSubCountryCodeList() Get the region's subcountry code list.
void	mergeSubCountryCodeList(java.util.List additionalSubCountryCodeList) Merge the given additionalSubCountryCodeList into the existing subCountryCodeList of this Region instance.
void	setCountryCode(java.lang.String countryCode) Set the region's country code (ISO country code).
void	setSubCountryCodeList(java.util.List subCountryCodeList) Set the region's subcountry code list.
java.lang.String	toString() Return the String representation of this Region.

Methods inherited from interface com.elasticpath.domain.EpDomain

getElasticPath, setElasticPath

Method Detail

fromString

Region fromString(java.lang.String regionStr)

Return the Region from parsing the given string representation.

Parameters:

regionStr - - the String representation of the Region

Returns:

Region - the instance of Region

getCountryCode

java.lang.String getCountryCode()

Get the region's country code (ISO country code).

Returns:

the region's country code.

getSubCountryCodeList

java.util.List getSubCountryCodeList()

Get the region's subcountry code list.

Returns:

the region's subcountry code list.

mergeSubCountryCodeList

void mergeSubCountryCodeList(java.util.List additionalSubCountryCodeList)

Merge the given additionalSubCountryCodeList into the existing subCountryCodeList of this Region instance.

Parameters:

additionalSubCountryCodeList - - the additional subCountryCodeList to be merged in.

setCountryCode

void setCountryCode(java.lang.String countryCode)

Set the region's country code (ISO country code).

Parameters:

countryCode - the region's country code.

setSubCountryCodeList

void setSubCountryCodeList(java.util.List subCountryCodeList)

Set the region's subcountry code list.

Parameters:

subCountryCodeList - the region's subcountry code list.

toString

java.lang.String toString()

Return the String representation of this Region.

Overrides:

toString in class java.lang.Object

Returns:

string representation of the region.