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_Api
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:  * Web service api server interface
29:  *
30:  * @category   Mage
31:  * @package    Mage_Api
32:  * @author     Magento Core Team <core@magentocommerce.com>
33:  */
34: interface Mage_Api_Model_Server_Adapter_Interface
35: {
36:     /**
37:      * Set handler class name for webservice
38:      *
39:      * @param string $handler
40:      * @return Mage_Api_Model_Server_Adapter_Interface
41:      */
42:     function setHandler($handler);
43: 
44:     /**
45:      * Retrive handler class name for webservice
46:      *
47:      * @return string
48:      */
49:     function getHandler();
50: 
51:     /**
52:      * Set webservice api controller
53:      *
54:      * @param Mage_Api_Controller_Action $controller
55:      * @return Mage_Api_Model_Server_Adapter_Interface
56:      */
57:     function setController(Mage_Api_Controller_Action $controller);
58: 
59:     /**
60:      * Retrive webservice api controller
61:      *
62:      * @return Mage_Api_Controller_Action
63:      */
64:     function getController();
65: 
66:     /**
67:      * Run webservice
68:      *
69:      * @return Mage_Api_Model_Server_Adapter_Interface
70:      */
71:     function run();
72: 
73:     /**
74:      * Dispatch webservice fault
75:      *
76:      * @param int $code
77:      * @param string $message
78:      */
79:     function fault($code, $message);
80: 
81: } // Class Mage_Api_Model_Server_Adapter_Interface End
82: