modules/ModuleBuilder/parsers/views/HistoryInterface.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38
  39 interface HistoryInterface
  40 {
  41
  42     /*
  43      * Get the most recent item in the history
  44      * @return Id of the first item
  45      */
  46     function getFirst () ;
  47
  48     /*
  49      * Get the next oldest item in the history
  50      * @return Id of the next item
  51      */
  52     function getNext () ;
  53
  54     /*
  55      * Get the nth item in the history (where the zeroeth record is the most recent)
  56      * @return Id of the nth item
  57      */
  58     function getNth ($n) ;
  59
  60     /*
  61      * Restore the historical layout identified by timestamp
  62      * @return Timestamp if successful, null if failure (if the file could not be copied for some reason)
  63      */
  64     function restoreByTimestamp ($timestamp) ;
  65
  66     /*
  67      * Undo the restore - revert back to the layout before the restore
  68      */
  69     function undoRestore () ;
  70
  71     /*
  72      * Add an item to the history
  73      * @return String   An timestamp for this newly added item
  74      */
  75     function append ($path) ;
  76 }