org.broadleafcommerce.profile.core.domain

Interface CountrySubdivision

All Superinterfaces:

Serializable

All Known Implementing Classes:

CountrySubdivisionImpl

public interface CountrySubdivision
extends Serializable

Represents a principal subdivision of a Country (e.g. province or state). This entity should be used only for lookup and filtering purposes only. For example, to help populate a drop-down to those States/Provinces/Regions you only wish to ship to. http://www.iso.org/iso/country_codes.htm http://en.wikipedia.org/wiki/ISO_3166-2

Author:

Elbert Bautista (elbertbautista)

Method Summary

Methods

Modifier and Type	Method and Description
String	getAbbreviation() The primary key - Ideally, implementations should use the ISO 3166-2 code of the country subdivision.
String	getAlternateAbbreviation() More friendly abbreviation that can be used for display purposes e.g.
CountrySubdivisionCategory	getCategory() A category that represents the subdivision of this Country.
Country	getCountry() The country where this subdivision resides e.g.
String	getName() Full name for display purposes e.g.
void	setAbbreviation(String abbreviation) Sets the primary key abbreviation
void	setAlternateAbbreviation(String alternateAbbreviation) sets the alternate abbreviation
void	setCategory(CountrySubdivisionCategory category) sets the country subdivision category
void	setCountry(Country country) sets the country in which this subdivision resides
void	setName(String name) sets the name

Method Detail

getAbbreviation

String getAbbreviation()

The primary key - Ideally, implementations should use the ISO 3166-2 code of the country subdivision. e.g. "US-TX" or "GB-WSM" http://en.wikipedia.org/wiki/ISO_3166-2

setAbbreviation

void setAbbreviation(String abbreviation)

Sets the primary key abbreviation

Parameters:

abbreviation - - e.g. "US-TX" or "GB-WSM"

getAlternateAbbreviation

String getAlternateAbbreviation()

More friendly abbreviation that can be used for display purposes e.g. "TX", "CA", "NY"

Returns:

- the alternate abbreviation

setAlternateAbbreviation

void setAlternateAbbreviation(String alternateAbbreviation)

sets the alternate abbreviation

Parameters:

alternateAbbreviation - - e.g. "TX", "CA", "NY"

getName

String getName()

Full name for display purposes e.g. "Texas", "California", "New York"

Returns:

- the alternate abbreviation

setName

void setName(String name)

sets the name

Parameters:

name - - e.g. "Texas", "California", "New York"

getCategory

CountrySubdivisionCategory getCategory()

A category that represents the subdivision of this Country. e.g. "State", "Province", "District"

Returns:

- the country subdivision category

setCategory

void setCategory(CountrySubdivisionCategory category)

sets the country subdivision category

Parameters:

category - - e.g. "State", "Province", "District"

getCountry

Country getCountry()

The country where this subdivision resides e.g. "US", "GB"

Returns:

- the country where this subdivision resides

setCountry

void setCountry(Country country)

sets the country in which this subdivision resides

Parameters:

country - - e.g. "US", "GB"