Class Mage_Sales_Model_Order_Creditmemo

Order creditmemo model

Varien_Object

Mage_Sales_Model_Order_Creditmemo

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/Order/Creditmemo.php

Methods summary
`protected`	# `_construct( )` Initialize creditmemo resource model Initialize creditmemo resource model
`protected Mage_Sales_Model_Order_Creditmemo`	# `_initOldFieldsMap( )` Init mapping array of short fields to its full names Init mapping array of short fields to its full names Returns `Mage_Sales_Model_Order_Creditmemo`
`public Mage_Sales_Model_Order_Creditmemo_Config`	# `getConfig( )` Retrieve Creditmemo configuration model Retrieve Creditmemo configuration model Returns `Mage_Sales_Model_Order_Creditmemo_Config`
`public Mage_Core_Model_Store`	# `getStore( )` Retrieve creditmemo store instance Retrieve creditmemo store instance Returns `Mage_Core_Model_Store`
`public Mage_Sales_Model_Order_Creditmemo`	# `setOrder( Mage_Sales_Model_Order $order )` Declare order for creditmemo Declare order for creditmemo Parameters `$order` `Mage_Sales_Model_Order` $order Returns `Mage_Sales_Model_Order_Creditmemo`
`public Mage_Sales_Model_Order`	# `getOrder( )` Retrieve the order the creditmemo for created for Retrieve the order the creditmemo for created for Returns `Mage_Sales_Model_Order`
`public Mage_Sales_Model_Order_Address`	# `getBillingAddress( )` Retrieve billing address Retrieve billing address Returns `Mage_Sales_Model_Order_Address`
`public Mage_Sales_Model_Order_Address`	# `getShippingAddress( )` Retrieve shipping address Retrieve shipping address Returns `Mage_Sales_Model_Order_Address`
`public`	# `getItemsCollection( )`
`public`	# `getAllItems( )`
`public`	# `getItemById( mixed $itemId )`
`public Mage_Sales_Model_Order_Creditmemo_Item\|boolean`	# `getItemByOrderId( mixed $orderId )` Returns credit memo item by its order id Returns credit memo item by its order id Parameters `$orderId` `mixed` $orderId Returns `Mage_Sales_Model_Order_Creditmemo_Item\|boolean`
`public`	# `addItem( Mage_Sales_Model_Order_Creditmemo_Item $item )`
`public Mage_Sales_Model_Order_Creditmemo`	# `collectTotals( )` Creditmemo totals collecting Creditmemo totals collecting Returns `Mage_Sales_Model_Order_Creditmemo`
`public float`	# `roundPrice( float $price, string $type = 'regular', boolean $negative = false )` Round price considering delta Round price considering delta Parameters `$price` `float` $price `$type` `string` $type `$negative` `boolean` $negative Indicates if we perform addition (true) or subtraction (false) of rounded value Returns `float`
`public`	# `canRefund( )`
`public boolean`	# `canCancel( )` Check creditmemo cancel action availability Check creditmemo cancel action availability Returns `boolean`
`public boolean`	# `canVoid( )` Check invice void action availability Check invice void action availability Returns `boolean`
`public`	# `refund( )`
`public Mage_Sales_Model_Order_Creditmemo`	# `cancel( )` Cancel Creditmemo action Cancel Creditmemo action Returns `Mage_Sales_Model_Order_Creditmemo`
`public Mage_Sales_Model_Order_Creditmemo`	# `register( )` Register creditmemo Register creditmemo Apply to order, order items etc. Returns `Mage_Sales_Model_Order_Creditmemo`
`public static array`	# `getStates( )` Retrieve Creditmemo states array Retrieve Creditmemo states array Returns `array`
`public string`	# `getStateName( integer $stateId = null )` Retrieve Creditmemo state name by state identifier Retrieve Creditmemo state name by state identifier Parameters `$stateId` `integer` $stateId Returns `string`
`public`	# `setShippingAmount( mixed $amount )`
`public`	# `setAdjustmentPositive( mixed $amount )`
`public`	# `setAdjustmentNegative( mixed $amount )`
`public Mage_Sales_Model_Order_Creditmemo`	# `addComment( boolean $comment, boolean $notify = false, mixed $visibleOnFront = false )` Adds comment to credit memo with additional possibility to send it to customer via email and show it in customer account Adds comment to credit memo with additional possibility to send it to customer via email and show it in customer account Parameters `$comment` `boolean` $notify `$notify` `boolean` $visibleOnFront `$visibleOnFront` Returns `Mage_Sales_Model_Order_Creditmemo`
`public`	# `getCommentsCollection( mixed $reload = false )`
`public Mage_Sales_Model_Order_Creditmemo`	# `sendEmail( boolean $notifyCustomer = true, string $comment = '' )` Send email with creditmemo data Send email with creditmemo data Parameters `$notifyCustomer` `boolean` $notifyCustomer `$comment` `string` $comment Returns `Mage_Sales_Model_Order_Creditmemo`
`public Mage_Sales_Model_Order_Creditmemo`	# `sendUpdateEmail( boolean $notifyCustomer = true, string $comment = '' )` Send email with creditmemo update information Send email with creditmemo update information Parameters `$notifyCustomer` `boolean` $notifyCustomer `$comment` `string` $comment Returns `Mage_Sales_Model_Order_Creditmemo`
`protected`	# `_getEmails( mixed $configPath )`
`protected Mage_Core_Model_Abstract`	# `_beforeDelete( )` Processing object before delete data Processing object before delete data Returns `Mage_Core_Model_Abstract` Overrides `Mage_Core_Model_Abstract::_beforeDelete()`
`protected Mage_Sales_Model_Order_Creditmemo`	# `_afterSave( )` After save object manipulations After save object manipulations Returns `Mage_Sales_Model_Order_Creditmemo` Overrides `Mage_Sales_Model_Abstract::_afterSave()`
`protected Mage_Sales_Model_Order_Creditmemo`	# `_beforeSave( )` Before object save manipulations Before object save manipulations Returns `Mage_Sales_Model_Order_Creditmemo` Overrides `Mage_Core_Model_Abstract::_beforeSave()`
`public Mage_Sales_Model_Resource_Order_Creditmemo_Collection`	# `getFilteredCollectionItems( array\|null $filter = null )` Get creditmemos collection filtered by $filter Get creditmemos collection filtered by $filter Parameters `$filter` `array\|null` $filter Returns `Mage_Sales_Model_Resource_Order_Creditmemo_Collection`

Methods inherited from Mage_Sales_Model_Abstract
`getCreatedAtDate(), getCreatedAtStoreDate()`

Methods inherited from Mage_Core_Model_Abstract
`_afterDelete(), _afterDeleteCommit(), _afterLoad(), _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
`integer`	`STATE_OPEN`	`1`	#
`integer`	`STATE_REFUNDED`	`2`	#
`integer`	`STATE_CANCELED`	`3`	#
`string`	`XML_PATH_EMAIL_TEMPLATE`	`'sales_email/creditmemo/template'`	#
`string`	`XML_PATH_EMAIL_GUEST_TEMPLATE`	`'sales_email/creditmemo/guest_template'`	#
`string`	`XML_PATH_EMAIL_IDENTITY`	`'sales_email/creditmemo/identity'`	#
`string`	`XML_PATH_EMAIL_COPY_TO`	`'sales_email/creditmemo/copy_to'`	#
`string`	`XML_PATH_EMAIL_COPY_METHOD`	`'sales_email/creditmemo/copy_method'`	#
`string`	`XML_PATH_EMAIL_ENABLED`	`'sales_email/creditmemo/enabled'`	#
`string`	`XML_PATH_UPDATE_EMAIL_TEMPLATE`	`'sales_email/creditmemo_comment/template'`	#
`string`	`XML_PATH_UPDATE_EMAIL_GUEST_TEMPLATE`	`'sales_email/creditmemo_comment/guest_template'`	#
`string`	`XML_PATH_UPDATE_EMAIL_IDENTITY`	`'sales_email/creditmemo_comment/identity'`	#
`string`	`XML_PATH_UPDATE_EMAIL_COPY_TO`	`'sales_email/creditmemo_comment/copy_to'`	#
`string`	`XML_PATH_UPDATE_EMAIL_COPY_METHOD`	`'sales_email/creditmemo_comment/copy_method'`	#
`string`	`XML_PATH_UPDATE_EMAIL_ENABLED`	`'sales_email/creditmemo_comment/enabled'`	#
`string`	`REPORT_DATE_TYPE_ORDER_CREATED`	`'order_created'`	#
`string`	`REPORT_DATE_TYPE_REFUND_CREATED`	`'refund_created'`	#
`string`	`HISTORY_ENTITY_NAME`	`'creditmemo'`	#

Properties summary
`protected static mixed`	`$_states`		#
`protected mixed`	`$_items`		#
`protected mixed`	`$_order`		#
`protected mixed`	`$_comments`		#
`protected array`	`$_calculators`	`array()`	# Calculator instances for delta rounding of prices Calculator instances for delta rounding of prices
`protected string`	`$_eventPrefix`	`'sales_order_creditmemo'`	# Prefix of model events names Prefix of model events names
`protected string`	`$_eventObject`	`'creditmemo'`	# Parameter name in event Parameter name in event In observe method you can use $observer->getEvent()->getObject() in this case

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

Packages

Classes

Interfaces

Class Mage_Sales_Model_Order_Creditmemo

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Overrides

Returns

Overrides

Returns

Overrides

Parameters

Returns