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:  * Interface for payment methods that support billing agreements management
29:  *
30:  * @author Magento Core Team <core@magentocommerce.com>
31:  */
32: interface Mage_Payment_Model_Billing_Agreement_MethodInterface
33: {
34:     /**
35:      * Init billing agreement
36:      *
37:      * @param Mage_Payment_Model_Billing_AgreementAbstract $agreement
38:      */
39:     public function initBillingAgreementToken(Mage_Payment_Model_Billing_AgreementAbstract $agreement);
40: 
41:     /**
42:      * Retrieve billing agreement details
43:      *
44:      * @param Mage_Payment_Model_Billing_AgreementAbstract $agreement
45:      */
46:     public function getBillingAgreementTokenInfo(Mage_Payment_Model_Billing_AgreementAbstract $agreement);
47: 
48:     /**
49:      * Create billing agreement
50:      *
51:      * @param Mage_Payment_Model_Billing_AgreementAbstract $agreement
52:      */
53:     public function placeBillingAgreement(Mage_Payment_Model_Billing_AgreementAbstract $agreement);
54: 
55:     /**
56:      * Update billing agreement status
57:      *
58:      * @param Mage_Payment_Model_Billing_AgreementAbstract $agreement
59:      */
60:     public function updateBillingAgreementStatus(Mage_Payment_Model_Billing_AgreementAbstract $agreement);
61: }
62: