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 68 69 70 71 72 73 74 75 76 77 78 79 80 
<?php
/* --------------------------------------------------------------
   ProductAttributeServiceInterface.inc.php 2016-01-18
   Gambio GmbH
   http://www.gambio.de
   Copyright (c) 2016 Gambio GmbH
   Released under the GNU General Public License (Version 2)
   [http://www.gnu.org/licenses/gpl-2.0.html]
   --------------------------------------------------------------
*/

/**
 * Interface ProductAttributeServiceInterface
 *
 * @category   System
 * @package    ProductModule
 * @subpackage Interfaces
 */
interface ProductAttributeServiceInterface
{
    /**
     * Adds an product attribute to a product by the given id.
     *
     * @param IdType                    $productId Id of product entity that adds the attribute.
     * @param ProductAttributeInterface $attribute Product attribute entity to add.
     *
     * @return int Id of inserted product attribute.
     */
    public function addAttribute(IdType $productId, ProductAttributeInterface $attribute);


    /**
     * Updates the passed product attribute entity.
     *
     * @param StoredProductAttributeInterface $attribute Product attribute entity to update.
     *
     * @return $this|ProductAttributeServiceInterface Same instance for chained method calls.
     */
    public function updateAttribute(StoredProductAttributeInterface $attribute);


    /**
     * Returns a stored product attribute entity by the given product attribute id.
     *
     * @param IdType $productAttributeId Id of expected product attribute entity.
     *
     * @return StoredProductAttributeInterface Expected stored product attribute entity.
     */
    public function getAttributeById(IdType $productAttributeId);


    /**
     * Returns a collection with all attribute entities that belongs to a product entity by the given product id.
     *
     * @param IdType $productId Id of product entity that contain the expected attributes.
     *
     * @return StoredProductAttributeCollection Collection with all attributes that belongs to the product.
     */
    public function getAttributesByProductId(IdType $productId);


    /**
     * Removes a product attribute entity by the given product attribute id.
     *
     * @param IdType $productAttributeId Id of product attribute entity that should be deleted.
     *
     * @return ProductAttributeServiceInterface|$this Same instance for chained method calls.
     */
    public function removeAttributeById(IdType $productAttributeId);


    /**
     * Removes product attributes by the given product id.
     *
     * @param IdType $productId Id of product entity of the attributes that should be deleted.
     *
     * @return ProductAttributeServiceInterface|$this Same instance for chained method calls.
     */
    public function removeAttributesByProductId(IdType $productId);
}