propel-om
[ class tree: propel-om ] [ index: propel-om ] [ all elements ]
Packages:
propel
propel-adapter
propel-logger
propel-map
propel-om
propel-util
propel-validator

Source for file Persistent.php

Documentation is available at Persistent.php

  1. <?php
  2. /*
  3.  *  $Id: Persistent.php 713 2007-10-24 07:22:40Z dwhittle $
  4.  *
  5.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  6.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  7.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  8.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  9.  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  10.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  11.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  12.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  13.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  14.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  15.  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  16.  *
  17.  * This software consists of voluntary contributions made by many individuals
  18.  * and is licensed under the LGPL. For more information please see
  19.  * <http://propel.phpdb.org>.
  20.  */
  21.  
  22. /**
  23.  * This interface defines methods related to saving an object
  24.  *
  25.  * @author     Hans Lellelid <hans@xmpl.org> (Propel)
  26.  * @author     John D. McNally <jmcnally@collab.net> (Torque)
  27.  * @author     Fedor K. <fedor@apache.org> (Torque)
  28.  * @version    $Revision: 713 $
  29.  * @package    propel.om
  30.  */
  31. interface Persistent {
  32.  
  33.     /**
  34.      * getter for the object primaryKey.
  35.      *
  36.      * @return     ObjectKey the object primaryKey as an Object
  37.      */
  38.     public function getPrimaryKey();
  39.  
  40.     /**
  41.      * Sets the PrimaryKey for the object.
  42.      *
  43.      * @param      mixed $primaryKey The new PrimaryKey object or string (result of PrimaryKey.toString()).
  44.      * @return     void 
  45.      * @throws     Exception, This method might throw an exceptions
  46.      */
  47.     public function setPrimaryKey($primaryKey);
  48.  
  49.  
  50.     /**
  51.      * Returns whether the object has been modified, since it was
  52.      * last retrieved from storage.
  53.      *
  54.      * @return     boolean True if the object has been modified.
  55.      */
  56.     public function isModified();
  57.  
  58.     /**
  59.      * Has specified column been modified?
  60.      *
  61.      * @param      string $col 
  62.      * @return     boolean True if $col has been modified.
  63.      */
  64.     public function isColumnModified($col);
  65.  
  66.     /**
  67.      * Returns whether the object has ever been saved.  This will
  68.      * be false, if the object was retrieved from storage or was created
  69.      * and then saved.
  70.      *
  71.      * @return     boolean True, if the object has never been persisted.
  72.      */
  73.     public function isNew();
  74.  
  75.     /**
  76.      * Setter for the isNew attribute.  This method will be called
  77.      * by Propel-generated children and Peers.
  78.      *
  79.      * @param      boolean $b the state of the object.
  80.      */
  81.     public function setNew($b);
  82.  
  83.     /**
  84.      * Resets (to false) the "modified" state for this object.
  85.      *
  86.      * @return     void 
  87.      */
  88.     public function resetModified();
  89.  
  90.     /**
  91.      * Whether this object has been deleted.
  92.      * @return     boolean The deleted state of this object.
  93.      */
  94.     public function isDeleted();
  95.  
  96.     /**
  97.      * Specify whether this object has been deleted.
  98.      * @param      boolean $b The deleted state of this object.
  99.      * @return     void 
  100.      */
  101.     public function setDeleted($b);
  102.  
  103.     /**
  104.      * Deletes the object.
  105.      * @param      PropelPDO $con 
  106.      * @return     void 
  107.      * @throws     Exception
  108.      */
  109.     public function delete(PropelPDO $con = null);
  110.  
  111.     /**
  112.      * Saves the object.
  113.      * @param      PropelPDO $con 
  114.      * @return     void 
  115.      * @throws     Exception
  116.      */
  117.     public function save(PropelPDO $con = null);
  118. }
Documentation generated on Thu, 22 Nov 2007 03:33:48 +0000 by phpDocumentor 1.4.0