Raised DBAL version from 1.1.5 to 1.1.6
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Persistence / RepositoryInterface.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
6 * All rights reserved
7 *
8 * This class is a backport of the corresponding class of FLOW3.
9 * All credits go to the v5 team.
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 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27
28 /**
29 * Contract for a repository
30 *
31 * @package Extbase
32 * @subpackage Persistence
33 * @version $ID:$
34 * @api
35 */
36 interface Tx_Extbase_Persistence_RepositoryInterface {
37
38 /**
39 * Adds an object to this repository.
40 *
41 * @param object $object The object to add
42 * @return void
43 * @api
44 */
45 public function add($object);
46
47 /**
48 * Removes an object from this repository.
49 *
50 * @param object $object The object to remove
51 * @return void
52 * @api
53 */
54 public function remove($object);
55
56 /**
57 * Returns all objects of this repository add()ed but not yet persisted to
58 * the storage layer.
59 *
60 * @return array An array of objects
61 */
62 public function getAddedObjects();
63
64 /**
65 * Returns an array with objects remove()d from the repository that
66 * had been persisted to the storage layer before.
67 *
68 * @return array
69 */
70 public function getRemovedObjects();
71
72 /**
73 * Returns all objects of this repository.
74 *
75 * @return array An array of objects, empty if no objects found
76 * @api
77 */
78 public function findAll();
79
80 /**
81 * Finds an object matching the given identifier.
82 *
83 * @param int $uid The identifier of the object to find
84 * @return object The matching object if found, otherwise NULL
85 * @api
86 */
87 public function findByUid($uid);
88
89 }
90 ?>