f0a2dae15663b4e77f2a75d14ed38c8377fd409b
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / DomainObject / DomainObjectInterface.php
1 <?php
2 namespace TYPO3\CMS\Extbase\DomainObject;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2010-2013 Extbase Team (http://forge.typo3.org/projects/typo3v4-mvc)
8 * Extbase is a backport of TYPO3 Flow. All credits go to the TYPO3 Flow team.
9 * All rights reserved
10 *
11 * This script is part of the TYPO3 project. The TYPO3 project is
12 * free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * The GNU General Public License can be found at
18 * http://www.gnu.org/copyleft/gpl.html.
19 * A copy is found in the textfile GPL.txt and important notices to the license
20 * from the author is found in LICENSE.txt distributed with these scripts.
21 *
22 *
23 * This script is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
27 *
28 * This copyright notice MUST APPEAR in all copies of the script!
29 ***************************************************************/
30 /**
31 * A Domain Object Interface. All domain objects which should be persisted need to implement the below interface.
32 * Usually you will need to subclass \TYPO3\CMS\Extbase\DomainObject\AbstractEntity and \TYPO3\CMS\Extbase\DomainObject\AbstractValueObject
33 * instead.
34 *
35 * @see \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
36 * @see \TYPO3\CMS\Extbase\DomainObject\AbstractValueObject
37 */
38 interface DomainObjectInterface {
39
40 /**
41 * Getter for uid.
42 *
43 * @return int the uid or NULL if none set yet.
44 */
45 public function getUid();
46
47 /**
48 * Setter for the pid.
49 *
50 * @param integer $pid
51 * @return void
52 */
53 public function setPid($pid);
54
55 /**
56 * Getter for the pid.
57 *
58 * @return int The pid or NULL if none set yet.
59 */
60 public function getPid();
61
62 /**
63 * Returns TRUE if the object is new (the uid was not set, yet). Only for internal use
64 *
65 * @return boolean
66 */
67 public function _isNew();
68
69 /**
70 * Reconstitutes a property. Only for internal use.
71 *
72 * @param string $propertyName
73 * @param string $value
74 * @return void
75 */
76 public function _setProperty($propertyName, $value);
77
78 /**
79 * Returns the property value of the given property name. Only for internal use.
80 *
81 * @param string $propertyName
82 * @return mixed The propertyValue
83 */
84 public function _getProperty($propertyName);
85
86 /**
87 * Returns a hash map of property names and property values
88 *
89 * @return array The properties
90 */
91 public function _getProperties();
92 }
93
94 ?>