1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 

<?php
/* --------------------------------------------------------------
   CustomerCountryReaderInterface.inc.php 2017-03-20 gm
   Gambio GmbH
   http://www.gambio.de
   Copyright (c) 2017 Gambio GmbH
   Released under the GNU General Public License (Version 2)
   [http://www.gnu.org/licenses/gpl-2.0.html]
   --------------------------------------------------------------
*/

/**
 * Interface CustomerCountryReaderInterface
 *
 * @category System
 * @package Customer
 * @subpackage Interfaces
 */
interface CustomerCountryReaderInterface 
{
    /**
     * Method to find a country with a given ID if it exists else it will return null
     * 
     * @param IdType $countryId
     *
     * @throws InvalidArgumentException if $p_countryId is not a valid ID
     * @throws Exception if country not found
     * @return CustomerCountry
     */
    public function findById(IdType $countryId);
    
    
    
    /**
     * Method to find a country with a given name if it exists else it will return null
     *
     * @param $countryName
     *
     * @return CustomerCountry|null
     */
    public function findByName(CustomerCountryNameInterface $countryName);
    
    
    
    /**
     * Method to find a country with a given iso2 code if it exists else it will return null
     *
     * @param $countryIso2
     *
     * @return CustomerCountry|null
     */
    public function findByIso2(CustomerCountryIso2Interface $countryIso2);
    
    
    /**
     * This method returns whether the specified country, necessary, needs a state.
     *
     * @param IdType $countryId
     *
     * @return bool
     */
    public function isStateMandatory(IdType $countryId);

}