[7589] | 1 | <?php |
---|
| 2 | /*********************************************** |
---|
| 3 | * File : iexportchanges.php |
---|
| 4 | * Project : Z-Push |
---|
| 5 | * Descr : IExportChanges interface. It's responsible for |
---|
| 6 | * exporting (sending) data, content and hierarchy changes. |
---|
| 7 | * This interface extends the IChanges interface. |
---|
| 8 | * |
---|
| 9 | * Created : 02.01.2012 |
---|
| 10 | * |
---|
| 11 | * Copyright 2007 - 2012 Zarafa Deutschland GmbH |
---|
| 12 | * |
---|
| 13 | * This program is free software: you can redistribute it and/or modify |
---|
| 14 | * it under the terms of the GNU Affero General Public License, version 3, |
---|
| 15 | * as published by the Free Software Foundation with the following additional |
---|
| 16 | * term according to sec. 7: |
---|
| 17 | * |
---|
| 18 | * According to sec. 7 of the GNU Affero General Public License, version 3, |
---|
| 19 | * the terms of the AGPL are supplemented with the following terms: |
---|
| 20 | * |
---|
| 21 | * "Zarafa" is a registered trademark of Zarafa B.V. |
---|
| 22 | * "Z-Push" is a registered trademark of Zarafa Deutschland GmbH |
---|
| 23 | * The licensing of the Program under the AGPL does not imply a trademark license. |
---|
| 24 | * Therefore any rights, title and interest in our trademarks remain entirely with us. |
---|
| 25 | * |
---|
| 26 | * However, if you propagate an unmodified version of the Program you are |
---|
| 27 | * allowed to use the term "Z-Push" to indicate that you distribute the Program. |
---|
| 28 | * Furthermore you may use our trademarks where it is necessary to indicate |
---|
| 29 | * the intended purpose of a product or service provided you use it in accordance |
---|
| 30 | * with honest practices in industrial or commercial matters. |
---|
| 31 | * If you want to propagate modified versions of the Program under the name "Z-Push", |
---|
| 32 | * you may only do so if you have a written permission by Zarafa Deutschland GmbH |
---|
| 33 | * (to acquire a permission please contact Zarafa at trademark@zarafa.com). |
---|
| 34 | * |
---|
| 35 | * This program is distributed in the hope that it will be useful, |
---|
| 36 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 37 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 38 | * GNU Affero General Public License for more details. |
---|
| 39 | * |
---|
| 40 | * You should have received a copy of the GNU Affero General Public License |
---|
| 41 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
---|
| 42 | * |
---|
| 43 | * Consult LICENSE file for details |
---|
| 44 | ************************************************/ |
---|
| 45 | |
---|
| 46 | interface IExportChanges extends IChanges { |
---|
| 47 | /** |
---|
| 48 | * Configures additional parameters used for content synchronization |
---|
| 49 | * |
---|
| 50 | * @param ContentParameters $contentparameters |
---|
| 51 | * |
---|
| 52 | * @access public |
---|
| 53 | * @return boolean |
---|
| 54 | * @throws StatusException |
---|
| 55 | */ |
---|
| 56 | public function ConfigContentParameters($contentparameters); |
---|
| 57 | |
---|
| 58 | /** |
---|
| 59 | * Sets the importer where the exporter will sent its changes to |
---|
| 60 | * This exporter should also be ready to accept calls after this |
---|
| 61 | * |
---|
| 62 | * @param object &$importer Implementation of IImportChanges |
---|
| 63 | * |
---|
| 64 | * @access public |
---|
| 65 | * @return boolean |
---|
| 66 | * @throws StatusException |
---|
| 67 | */ |
---|
| 68 | public function InitializeExporter(&$importer); |
---|
| 69 | |
---|
| 70 | /** |
---|
| 71 | * Returns the amount of changes to be exported |
---|
| 72 | * |
---|
| 73 | * @access public |
---|
| 74 | * @return int |
---|
| 75 | */ |
---|
| 76 | public function GetChangeCount(); |
---|
| 77 | |
---|
| 78 | /** |
---|
| 79 | * Synchronizes a change to the configured importer |
---|
| 80 | * |
---|
| 81 | * @access public |
---|
| 82 | * @return array with status information |
---|
| 83 | */ |
---|
| 84 | public function Synchronize(); |
---|
| 85 | } |
---|
| 86 | |
---|
| 87 | ?> |
---|