Extbase:
[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 * Reconstitutes a property. This method should only be called at reconstitution time!
36 *
37 * @param string $propertyName
38 * @param string $value
39 * @return void
40 * @internal
41 */
42 public function _reconstituteProperty($propertyName, $value);
43
44 /**
45 * Register an object's clean state, e.g. after it has been reconstituted
46 * from the database
47 *
48 * @return void
49 * @internal
50 */
51 public function _memorizeCleanState();
52
53 /**
54 * Returns TRUE if the properties were modified after reconstitution
55 *
56 * @return boolean
57 * @internal
58 */
59 public function _isDirty();
60 /**
61 * Returns a hash map of property names and property values
62 *
63 * @return array The properties
64 * @internal
65 */
66 public function _getProperties();
67 /**
68 * Returns a hash map of dirty properties and $values
69 *
70 * @return boolean
71 * @internal
72 */
73 public function _getDirtyProperties();
74
75 }
76 ?>