fd624d7f8eb45f075f04ac239519e6cf113dbc74
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / DomainObject / DomainObjectInterface.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 *
17 * This script is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * This copyright notice MUST APPEAR in all copies of the script!
23 ***************************************************************/
24
25 /**
26 * A Domain Object Interface
27 *
28 * @package Extbase
29 * @subpackage DomainObject
30 * @version $ID:$
31 */
32 interface Tx_Extbase_DomainObject_DomainObjectInterface {
33
34 /**
35 * Register an object's clean state, e.g. after it has been reconstituted
36 * from the database
37 *
38 * @return void
39 * @internal
40 */
41 public function _memorizeCleanState();
42
43 /**
44 * Returns TRUE if the object is new (the uid was not set, yet). Only for internal use
45 *
46 * @return boolean
47 * @internal
48 */
49 public function _isNew();
50
51 /**
52 * Returns TRUE if the properties were modified after reconstitution
53 *
54 * @return boolean
55 * @internal
56 */
57 public function _isDirty();
58
59 /**
60 * Reconstitutes a property. Only for internal use.
61 *
62 * @param string $propertyName
63 * @param string $value
64 * @return void
65 * @internal
66 */
67 public function _setProperty($propertyName, $value);
68
69 /**
70 * Returns the property value of the given property name. Only for internal use.
71 *
72 * @return mixed The propertyValue
73 * @internal
74 */
75 public function _getProperty($propertyName);
76
77 /**
78 * Returns a hash map of property names and property values
79 *
80 * @return array The properties
81 * @internal
82 */
83 public function _getProperties();
84
85 /**
86 * Returns a hash map of dirty properties and $values
87 *
88 * @return boolean
89 * @internal
90 */
91 public function _getDirtyProperties();
92
93 }
94 ?>