Class Mage_Sales_Model_Billing_Agreement

Billing Agreement abstract model

Varien_Object

Mage_Payment_Model_Billing_AgreementAbstract

Mage_Sales_Model_Billing_Agreement

Package: Mage\Sales
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Sales/Model/Billing/Agreement.php

Methods summary
`protected`	# `_construct( )` Init model Init model
`protected Mage_Core_Model_Abstract`	# `_beforeSave( )` Set created_at parameter Set created_at parameter Returns `Mage_Core_Model_Abstract` Throws `Mage_Core_Exception` Overrides `Mage_Payment_Model_Billing_AgreementAbstract::_beforeSave()`
`protected Mage_Core_Model_Abstract`	# `_afterSave( )` Save agreement order relations Save agreement order relations Returns `Mage_Core_Model_Abstract` Overrides `Mage_Core_Model_Abstract::_afterSave()`
`public string`	# `getStatusLabel( )` Retrieve billing agreement status label Retrieve billing agreement status label Returns `string`
`public string`	# `initToken( )` Initialize token Initialize token Returns `string`
`public Mage_Sales_Model_Billing_Agreement`	# `verifyToken( )` Get billing agreement details Data from response is inside this object Get billing agreement details Data from response is inside this object Returns `Mage_Sales_Model_Billing_Agreement`
`public Mage_Sales_Model_Billing_Agreement`	# `place( )` Create billing agreement Create billing agreement Returns `Mage_Sales_Model_Billing_Agreement`
`public Mage_Sales_Model_Billing_Agreement`	# `cancel( )` Cancel billing agreement Cancel billing agreement Returns `Mage_Sales_Model_Billing_Agreement`
`public boolean`	# `canCancel( )` Check whether can cancel billing agreement Check whether can cancel billing agreement Returns `boolean`
`public array`	# `getStatusesArray( )` Retrieve billing agreement statuses array Retrieve billing agreement statuses array Returns `array`
`public boolean`	# `isValid( )` Validate data Validate data Returns `boolean` Overrides `Mage_Payment_Model_Billing_AgreementAbstract::isValid()`
`public Mage_Sales_Model_Billing_Agreement`	# `importOrderPayment( Mage_Sales_Model_Order_Payment $payment )` Import payment data to billing agreement Import payment data to billing agreement $payment->getBillingAgreementData() contains array with following structure : [billing_agreement_id] => string [method_code] => string Parameters `$payment` `Mage_Sales_Model_Order_Payment` $payment Returns `Mage_Sales_Model_Billing_Agreement`
`public Mage_Paypal_Controller_Express_Abstract`	# `getAvailableCustomerBillingAgreements( integer $customerId )` Retrieve available customer Billing Agreements Retrieve available customer Billing Agreements Parameters `$customerId` `integer` $customer Returns `Mage_Paypal_Controller_Express_Abstract`
`public boolean`	# `needToCreateForCustomer( integer $customerId )` Check whether need to create billing agreement for customer Check whether need to create billing agreement for customer Parameters `$customerId` `integer` $customerId Returns `boolean`
`public Mage_Sales_Model_Billing_Agreement`	# `addOrderRelation( integer\|Mage_Sales_Model_Order $orderId )` Add order relation to current billing agreement Add order relation to current billing agreement Parameters `$orderId` `integer\|Mage_Sales_Model_Order` $orderId Returns `Mage_Sales_Model_Billing_Agreement`
`protected`	# `_saveOrderRelations( )` Save related orders Save related orders

Methods inherited from Mage_Payment_Model_Billing_AgreementAbstract
`getPaymentMethodInstance()`

Methods inherited from Mage_Core_Model_Abstract
`_afterDelete(), _afterDeleteCommit(), _afterLoad(), _beforeDelete(), _beforeLoad(), _clearData(), _clearReferences(), _getEventData(), _getResource(), _hasModelChanged(), _init(), _protectFromNonAdmin(), _setResourceModel(), afterCommitCallback(), afterLoad(), cleanModelCache(), clearInstance(), delete(), getCacheIdTags(), getCacheTags(), getCollection(), getEntityId(), getId(), getIdFieldName(), getResource(), getResourceCollection(), getResourceName(), isObjectNew(), load(), save(), setId()`

Constants summary
`string`	`STATUS_ACTIVE`	`'active'`	#
`string`	`STATUS_CANCELED`	`'canceled'`	#

Properties summary
`protected array`	`$_relatedOrders`	`array()`	# Related agreement orders Related agreement orders

Properties inherited from Mage_Payment_Model_Billing_AgreementAbstract
`$_errors, $_paymentMethodInstance`

Properties inherited from Mage_Core_Model_Abstract
`$_cacheTag, $_dataSaveAllowed, $_eventObject, $_eventPrefix, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName`

Packages

Classes

Interfaces

Class Mage_Sales_Model_Billing_Agreement

Returns

Throws

Overrides

Returns

Overrides

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns