1 <?php
2
3 /* --------------------------------------------------------------
4 AddressFormatProviderInterface.inc.php 2016-01-04
5 Gambio GmbH
6 http://www.gambio.de
7 Copyright (c) 2016 Gambio GmbH
8 Released under the GNU General Public License (Version 2)
9 [http://www.gnu.org/licenses/gpl-2.0.html]
10 --------------------------------------------------------------
11 */
12
13 /**
14 * Class AbstractCollection
15 *
16 * @category System
17 * @package Shared
18 * @subpackage Interfaces
19 */
20 interface AddressFormatProviderInterface
21 {
22 /**
23 * Returns the address format IDs.
24 * @return IdCollection Collection of address format IDs.
25 */
26 public function getIds();
27
28
29 /**
30 * Returns address format IDs based on the country ID provided.
31 *
32 * @param IdType $countryId Country ID.
33 *
34 * @return int Address format ID.
35 */
36 public function getByCountryId(IdType $countryId);
37
38
39 /**
40 * Returns the address format IDs based on the ISO-2 country code provided.
41 *
42 * @param StringType $iso2 ISO-2 country code.
43 *
44 * @return int Address format ID.
45 */
46 public function getByIsoCode2(StringType $iso2);
47
48
49 /**
50 * Returns the address format IDs based on the ISO-3 country code provided.
51 *
52 * @param StringType $iso3 ISO-3 country code.
53 *
54 * @return int Address format ID.
55 */
56 public function getByIsoCode3(StringType $iso3);
57 }