1: <?php
2: /**
3: * Magento
4: *
5: * NOTICE OF LICENSE
6: *
7: * This source file is subject to the Open Software License (OSL 3.0)
8: * that is bundled with this package in the file LICENSE.txt.
9: * It is also available through the world-wide-web at this URL:
10: * http://opensource.org/licenses/osl-3.0.php
11: * If you did not receive a copy of the license and are unable to
12: * obtain it through the world-wide-web, please send an email
13: * to license@magentocommerce.com so we can send you a copy immediately.
14: *
15: * DISCLAIMER
16: *
17: * Do not edit or add to this file if you wish to upgrade Magento to newer
18: * versions in the future. If you wish to customize Magento for your
19: * needs please refer to http://www.magentocommerce.com for more information.
20: *
21: * @category Mage
22: * @package Mage_Catalog
23: * @copyright Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
24: * @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
25: */
26:
27: /**
28: * Product configurational item interface
29: *
30: * @category Mage
31: * @package Mage_Catalog
32: * @author Magento Core Team <core@magentocommerce.com>
33: */
34: interface Mage_Catalog_Model_Product_Configuration_Item_Interface
35: {
36: /**
37: * Retrieve associated product
38: *
39: * @return Mage_Catalog_Model_Product
40: */
41: function getProduct();
42:
43: /**
44: * Get item option by code
45: *
46: * @param string $code
47: * @return Mage_Catalog_Model_Product_Configuration_Item_Option_Interface
48: */
49: public function getOptionByCode($code);
50:
51: /**
52: * Returns special download params (if needed) for custom option with type = 'file''
53: * Return null, if not special params needed'
54: * Or return Varien_Object with any of the following indexes:
55: * - 'url' - url of controller to give the file
56: * - 'urlParams' - additional parameters for url (custom option id, or item id, for example)
57: *
58: * @return null|Varien_Object
59: */
60: public function getFileDownloadParams();
61: }
62: