org.broadleafcommerce.profile.core.service

Class AddressServiceImpl

java.lang.Object

org.broadleafcommerce.profile.core.service.AddressServiceImpl

All Implemented Interfaces:

AddressService

@Service(value="blAddressService")
public class AddressServiceImpl
extends Object
implements AddressService

Field Summary

Fields

Modifier and Type	Field and Description
protected AddressDao	addressDao
protected CountrySubdivisionService	countrySubdivisionService
protected ModuleConfigurationService	moduleConfigService
protected boolean	mustValidateAddresses
protected PhoneService	phoneService
protected List<AddressVerificationProvider>	providers

Constructor Summary

Constructors

Constructor and Description
AddressServiceImpl()

Method Summary

Modifier and Type	Method and Description
Address	copyAddress(Address orig) Returns a new address instance with the given properties on the originating address minus any default or active values set
Address	copyAddress(Address dest, Address orig) Copies properties from the originating address to the destination address minus any default or active values
Address	create()
void	delete(Address address)
void	populateAddressISOCountrySub(Address address) Convenience method that attempts to pre-populate the ISO Country Subdivision on an address.
Address	readAddressById(Long addressId)
Address	saveAddress(Address address)
void	setMustValidateAddresses(boolean mustValidateAddresses) Default is false.
List<Address>	verifyAddress(Address address) Verifies the address and returns a collection of addresses.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mustValidateAddresses

protected boolean mustValidateAddresses

addressDao

protected AddressDao addressDao

moduleConfigService

protected ModuleConfigurationService moduleConfigService

providers

protected List<AddressVerificationProvider> providers

phoneService

protected PhoneService phoneService

countrySubdivisionService

protected CountrySubdivisionService countrySubdivisionService

Constructor Detail

AddressServiceImpl

public AddressServiceImpl()

Method Detail

saveAddress

@Transactional(value="blTransactionManager")
public Address saveAddress(Address address)

Specified by:

saveAddress in interface AddressService

readAddressById

public Address readAddressById(Long addressId)

Specified by:

readAddressById in interface AddressService

create

@Transactional(value="blTransactionManager")
public Address create()

Specified by:

create in interface AddressService

delete

@Transactional(value="blTransactionManager")
public void delete(Address address)

Specified by:

delete in interface AddressService

verifyAddress

public List<Address> verifyAddress(Address address)
                            throws AddressVerificationException

Description copied from interface: AddressService

Verifies the address and returns a collection of addresses. If the address was invalid but close to a match, this method should return a list of one or more addresses that may be valid. If the address is valid, implementations should return the valid address in the list. Implementations may set the tokenized address, zip four, and verification level. If the address could not be validated, implementors should throw an AddressValidationException. For example, an address may be close, but missing zip four. This service should return the address in question with zip four populated.

Specified by:

verifyAddress in interface AddressService

Returns:

Throws:

AddressVerificationException

copyAddress

public Address copyAddress(Address orig)

Description copied from interface: AddressService

Returns a new address instance with the given properties on the originating address minus any default or active values set

Specified by:

copyAddress in interface AddressService

Returns:

copyAddress

public Address copyAddress(Address dest,
                           Address orig)

Description copied from interface: AddressService

Copies properties from the originating address to the destination address minus any default or active values

Specified by:

copyAddress in interface AddressService

Returns:

populateAddressISOCountrySub

public void populateAddressISOCountrySub(Address address)

Description copied from interface: AddressService

Convenience method that attempts to pre-populate the ISO Country Subdivision on an address. Strategy attempts to identify the ISO subdivision based on the contents of the "friendly" state/province/region attribute and the ISO alpha-2 country code already populated on the passed in address. It will attempt to look for the "alternate abbreviation" first, and if not found will check the "name" next.

Specified by:

populateAddressISOCountrySub in interface AddressService

setMustValidateAddresses

public void setMustValidateAddresses(boolean mustValidateAddresses)

Default is false. If set to true, the verifyAddress method will throw an exception if there are no providers to handle the request.

Parameters:

mustValidateAddresses -