API Documentation
Back to top  

CustomerCountryReaderInterface

Extends

Interface CustomerCountryReaderInterface

category

System
package

Customer
subpackage

Interfaces

Methods

Method to find a country with a given ID if it exists else it will return null

findById(\IdType $countryId) : \CustomerCountry
Throws
\Exception

if country not found

\InvalidArgumentException

if $p_countryId is not a valid ID

Arguments

$countryId

\IdType

Response

\CustomerCountry

Method to find a country with a given iso2 code if it exists else it will return null

findByIso2( $countryIso2) : \CustomerCountry|null

Arguments

$countryIso2

Response

\CustomerCountry|null

Method to find a country with a given name if it exists else it will return null

findByName( $countryName) : \CustomerCountry|null

Arguments

$countryName

Response

\CustomerCountry|null

This method returns whether the specified country, necessary, needs a state.

isStateMandatory(\IdType $countryId) : boolean

Arguments

$countryId

\IdType

Response

boolean