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_Api2
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:  * API2 User Abstract Class
29:  *
30:  * @category   Mage
31:  * @package    Mage_Api2
32:  * @author     Magento Core Team <core@magentocommerce.com>
33:  */
34: abstract class Mage_Api2_Model_Auth_User_Abstract
35: {
36:     /**
37:      * Customer/Admin identifier
38:      *
39:      * @var int
40:      */
41:     protected $_userId;
42: 
43:     /**
44:      * User Role
45:      *
46:      * @var int
47:      */
48:     protected $_role;
49: 
50:     /**
51:      * Retrieve user human-readable label
52:      *
53:      * @return string
54:      */
55:     public function getLabel()
56:     {
57:         return $this->getType();
58:     }
59: 
60:     /**
61:      * Retrieve user role
62:      *
63:      * @return int
64:      */
65:     abstract public function getRole();
66: 
67:     /**
68:      * Retrieve user type
69:      *
70:      * @return string
71:      */
72:     abstract public function getType();
73: 
74:     /**
75:      * Retrieve user identifier
76:      *
77:      * @return int
78:      */
79:     public function getUserId()
80:     {
81:         return $this->_userId;
82:     }
83: 
84:     /**
85:      * Set user identifier
86:      *
87:      * @param int $userId User identifier
88:      * @return Mage_Api2_Model_Auth_User_Abstract
89:      */
90:     public function setUserId($userId)
91:     {
92:         $this->_userId = $userId;
93: 
94:         return $this;
95:     }
96: }
97: