AddressRepositoryInterface.php 2.19 KB
Newer Older
Ketan's avatar
Ketan committed
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 65 66 67
<?php
/**
 * Refer to LICENSE.txt distributed with the Temando Shipping module for notice of license
 */
namespace Temando\Shipping\Model\ResourceModel\Repository;

/**
 * Temando Checkout Address Repository Interface.
 *
 * A checkout address entity is an extension to the quote shipping address. It
 * holds additional data needed for rates processing and order manifestation.
 *
 * This public interface can be used to retrieve and write additional address
 * data as collected during checkout.
 *
 * @package  Temando\Shipping\Model
 * @author   Christoph Aßmann <christoph.assmann@netresearch.de>
 * @license  http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link     http://www.temando.com/
 */
interface AddressRepositoryInterface
{
    /**
     * Load address by entity id.
     *
     * @param string $addressId
     * @return \Temando\Shipping\Api\Data\Checkout\AddressInterface
     * @throws \Magento\Framework\Exception\NoSuchEntityException
     */
    public function getById($addressId);

    /**
     * Load address by quote address id.
     *
     * @param string $quoteAddressId
     * @return \Temando\Shipping\Api\Data\Checkout\AddressInterface
     * @throws \Magento\Framework\Exception\NoSuchEntityException
     */
    public function getByQuoteAddressId($quoteAddressId);

    /**
     * Save address.
     *
     * @param \Temando\Shipping\Api\Data\Checkout\AddressInterface $address
     * @return \Temando\Shipping\Api\Data\Checkout\AddressInterface
     * @throws \Magento\Framework\Exception\CouldNotSaveException
     */
    public function save(\Temando\Shipping\Api\Data\Checkout\AddressInterface $address);

    /**
     * Delete by quote address id.
     *
     * @param string $addressId
     * @return bool true on success
     * @throws \Magento\Framework\Exception\CouldNotDeleteException
     */
    public function deleteByShippingAddressId($addressId);

    /**
     * Delete entity.
     *
     * @param \Temando\Shipping\Api\Data\Checkout\AddressInterface $address
     * @return bool true on success
     * @throws \Magento\Framework\Exception\CouldNotDeleteException
     */
    public function delete(\Temando\Shipping\Api\Data\Checkout\AddressInterface $address);
}