Class Mage_Sales_Model_Api2_Order

API2 class for orders

Mage_Sales_Model_Api2_Order

Direct known subclasses

Indirect known subclasses

Mage_Sales_Model_Api2_Order_Rest_Admin_V1, Mage_Sales_Model_Api2_Order_Rest_Customer_V1

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

Methods summary
`protected Mage_Sales_Model_Api2_Order`	# `_addGiftMessageInfo( Mage_Sales_Model_Resource_Order_Collection $collection )` Add gift message info to select Add gift message info to select Parameters `$collection` `Mage_Sales_Model_Resource_Order_Collection` $collection Returns `Mage_Sales_Model_Api2_Order`
`protected Mage_Sales_Model_Api2_Order`	# `_addPaymentMethodInfo( Mage_Sales_Model_Resource_Order_Collection $collection )` Add order payment method field to select Add order payment method field to select Parameters `$collection` `Mage_Sales_Model_Resource_Order_Collection` $collection Returns `Mage_Sales_Model_Api2_Order`
`protected Mage_Sales_Model_Api2_Order`	# `_addTaxInfo( Mage_Sales_Model_Resource_Order_Collection $collection )` Add order tax information to select Add order tax information to select Parameters `$collection` `Mage_Sales_Model_Resource_Order_Collection` $collection Returns `Mage_Sales_Model_Api2_Order`
`protected array`	# `_getAddresses( array $orderIds )` Retrieve a list or orders' addresses in a form of [order ID => array of addresses, ...] Retrieve a list or orders' addresses in a form of [order ID => array of addresses, ...] Parameters `$orderIds` `array` $orderIds Orders identifiers Returns `array`
`protected Mage_Sales_Model_Resource_Order_Collection`	# `_getCollectionForRetrieve( )` Retrieve collection instance for orders list Retrieve collection instance for orders list Returns `Mage_Sales_Model_Resource_Order_Collection`
`protected Mage_Sales_Model_Resource_Order_Collection`	# `_getCollectionForSingleRetrieve( integer $orderId )` Retrieve collection instance for single order Retrieve collection instance for single order Parameters `$orderId` `integer` $orderId Order identifier Returns `Mage_Sales_Model_Resource_Order_Collection`
`protected array`	# `_getComments( array $orderIds )` Retrieve a list or orders' comments in a form of [order ID => array of comments, ...] Retrieve a list or orders' comments in a form of [order ID => array of comments, ...] Parameters `$orderIds` `array` $orderIds Orders' identifiers Returns `array`
`protected Mage_Sales_Model_Resource_Order_Status_History_Collection\|Object`	# `_getCommentsCollection( array $orderIds )` Prepare and return order comments collection Prepare and return order comments collection Parameters `$orderIds` `array` $orderIds Orders' identifiers Returns `Mage_Sales_Model_Resource_Order_Status_History_Collection\|Object`
`protected array`	# `_getItems( array $orderIds )` Retrieve a list or orders' items in a form of [order ID => array of items, ...] Retrieve a list or orders' items in a form of [order ID => array of items, ...] Parameters `$orderIds` `array` $orderIds Orders identifiers Returns `array`
`public boolean`	# `_isGiftMessageAllowed( )` Check gift messages information is allowed Check gift messages information is allowed Returns `boolean`
`public boolean`	# `_isOrderCommentsAllowed( )` Check order comments information is allowed Check order comments information is allowed Returns `boolean`
`public boolean`	# `_isPaymentMethodAllowed( )` Check payment method information is allowed Check payment method information is allowed Returns `boolean`
`public boolean`	# `_isTaxNameAllowed( )` Check tax name information is allowed Check tax name information is allowed Returns `boolean`
`public boolean`	# `_isTaxRateAllowed( )` Check tax rate information is allowed Check tax rate information is allowed Returns `boolean`
`protected array`	# `_retrieveCollection( )` Get orders list Get orders list Returns `array`

Methods inherited from Mage_Api2_Model_Resource
_applyCollectionModifiers(), _applyFilter(), _checkMethodExist(), _critical(), _error(), _errorIfMethodNotExist(), _errorMessage(), _getCriticalErrors(), _getLocation(), _getResourceAttributes(), _getStore(), _getSubModel(), _isSubCallAllowed(), _multicall(), _render(), _successMessage(), dispatch(), getActionType(), getApiType(), getApiUser(), getAvailableAttributes(), getAvailableAttributesFromConfig(), getConfig(), getDbAttributes(), getEavAttributes(), getEntityOnlyAttributes(), getExcludedAttributes(), getFilter(), getForcedAttributes(), getIncludedAttributes(), getOperation(), getRenderer(), getRequest(), getResourceType(), getResponse(), getUserType(), getVersion(), getWorkingModel(), setActionType(), setApiType(), setApiUser(), setFilter(), setOperation(), setRenderer(), setRequest(), setResourceType(), setResponse(), setReturnData(), setUserType(), setVersion()

Constants summary
`string`	`PARAM_GIFT_MESSAGE`	`'_gift_message'`	# Parameters' names in config with special ACL meaning Parameters' names in config with special ACL meaning
`string`	`PARAM_ORDER_COMMENTS`	`'_order_comments'`	#
`string`	`PARAM_PAYMENT_METHOD`	`'_payment_method'`	#
`string`	`PARAM_TAX_NAME`	`'_tax_name'`	#
`string`	`PARAM_TAX_RATE`	`'_tax_rate'`	#

Constants inherited from Mage_Api2_Model_Resource
ACTION_TYPE_COLLECTION, ACTION_TYPE_ENTITY, OPERATION_ATTRIBUTE_READ, OPERATION_ATTRIBUTE_WRITE, OPERATION_CREATE, OPERATION_DELETE, OPERATION_RETRIEVE, OPERATION_UPDATE, PAGE_SIZE_DEFAULT, PAGE_SIZE_MAX, RESOURCE_COLLECTION_ATTRIBUTES_ERROR, RESOURCE_COLLECTION_FILTERING_ERROR, RESOURCE_COLLECTION_ORDERING_ERROR, RESOURCE_COLLECTION_PAGING_ERROR, RESOURCE_COLLECTION_PAGING_LIMIT_ERROR, RESOURCE_DATA_INVALID, RESOURCE_DATA_PRE_VALIDATION_ERROR, RESOURCE_INTERNAL_ERROR, RESOURCE_METHOD_NOT_ALLOWED, RESOURCE_METHOD_NOT_IMPLEMENTED, RESOURCE_NOT_FOUND, RESOURCE_REQUEST_DATA_INVALID, RESOURCE_UNKNOWN_ERROR, RESOURCE_UPDATED_SUCCESSFUL

Properties inherited from Mage_Api2_Model_Resource
`$_actionType, $_apiType, $_apiUser, $_filter, $_multicall, $_operation, $_renderer, $_request, $_resourceType, $_response, $_returnData, $_userType, $_version`

Packages

Classes

Interfaces

Class Mage_Sales_Model_Api2_Order

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns