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 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
<?php
/* --------------------------------------------------------------
ProductReadServiceInterface.inc.php 2016-04-19
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 ProductReadServiceInterface
*
* @category System
* @package Product
* @subpackage Interfaces
*/
Interface ProductReadServiceInterface
{
/**
* Get Product by ID.
*
* Returns a specific product, depending on the provided ID.
*
* @param IdType $productId The ID of the product to return.
*
* @return StoredProductInterface The stored product.
*/
public function getProductById(IdType $productId);
/**
* Get Product List
*
* Returns a specific product list.
*
* @param LanguageCode $languageCode The language code.
* @param IdType|null $categoryId The category ID of the product list.
* @param IdType|null $customerStatusLimit The customers status limit.
*
* @return ProductListItemCollection
*/
public function getProductList(LanguageCode $languageCode,
IdType $categoryId = null,
IdType $customerStatusLimit = null);
/**
* Get Active Product List
*
* Returns an active products list.
*
* @param LanguageCode $languageCode The language code.
* @param IdType|null $categoryId The category ID of the product list.
* @param IdType|null $customerStatusLimit The customers status limit.
*
* @return ProductListItemCollection
*/
public function getActiveProductList(LanguageCode $languageCode,
IdType $categoryId = null,
IdType $customerStatusLimit = null);
/**
* Returns the category Ids which are linked to the given product id.
*
* @param IdType $productId
*
* @return IdCollection
*/
public function getProductLinks(IdType $productId);
/**
* Returns an UrlRewriteCollection with UrlRewrite instances for the provided content ID.
*
* @param IdType $productId
*
* @return UrlRewriteCollection
*/
public function getRewriteUrls(IdType $productId);
/**
* Returns a single UrlRewrite instance for the provided content ID and language ID or NULL if no entry was found.
*
* @param IdType $productId
* @param IdType $languageId
*
* @return null|UrlRewrite
*/
public function findRewriteUrl(IdType $productId, IdType $languageId);
/**
* Returns an UrlRewriteCollection with UrlRewrite instances for the provided rewrite url.
*
* @param NonEmptyStringType $rewriteUrl
*
* @return UrlRewriteCollection
*/
public function findUrlRewritesByRewriteUrl(NonEmptyStringType $rewriteUrl);
}