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_Payment
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:  * Recurring profile gateway management interface
29:  */
30: interface Mage_Payment_Model_Recurring_Profile_MethodInterface
31: {
32:     /**
33:      * Validate data
34:      *
35:      * @param Mage_Payment_Model_Recurring_Profile $profile
36:      * @throws Mage_Core_Exception
37:      */
38:     public function validateRecurringProfile(Mage_Payment_Model_Recurring_Profile $profile);
39: 
40:     /**
41:      * Submit to the gateway
42:      *
43:      * @param Mage_Payment_Model_Recurring_Profile $profile
44:      * @param Mage_Payment_Model_Info $paymentInfo
45:      */
46:     public function submitRecurringProfile(Mage_Payment_Model_Recurring_Profile $profile, Mage_Payment_Model_Info $paymentInfo);
47: 
48:     /**
49:      * Fetch details
50:      *
51:      * @param string $referenceId
52:      * @param Varien_Object $result
53:      */
54:     public function getRecurringProfileDetails($referenceId, Varien_Object $result);
55: 
56:     /**
57:      * Check whether can get recurring profile details
58:      *
59:      * @return bool
60:      */
61:     public function canGetRecurringProfileDetails();
62: 
63:     /**
64:      * Update data
65:      *
66:      * @param Mage_Payment_Model_Recurring_Profile $profile
67:      */
68:     public function updateRecurringProfile(Mage_Payment_Model_Recurring_Profile $profile);
69: 
70:     /**
71:      * Manage status
72:      *
73:      * @param Mage_Payment_Model_Recurring_Profile $profile
74:      */
75:     public function updateRecurringProfileStatus(Mage_Payment_Model_Recurring_Profile $profile);
76: }
77: