Source for file Index.interface.php

<?PHP
/**
 * @package org.phptmapi.index
*/
require_once('../org.phptmapi.core/TopicMapSystem.ConfigurableHelperObject.interface.php');
/**
 * Interface IndexInterface: Abstract representation of a topic map index. This is the base interface that must be implemented by all indexes.
 *
 * @author Johannes Schmidt - t8d <kontakt@t8d.de>
*/
interface IndexInterface extends TopicMapSystemConfigurableHelperObjectInterface{
    /**
    * close: Close the index.
    * @access public
    * @return void 
    * @throws TMAPIIndexException()
    *  <code>
    *      public function close(){
    *         throw new TMAPIIndexException('Exception in '.__method__);
    *      }
    *  </code>
    */
    public function close();
    
    /**
    * getFlags: Retrieve the IndexInterface instance that represents the static meta data for this index.
    * @access public
    * @return object IndexInterface 
    * @throws TMAPIIndexException()
    *  <code>
    *      public function getFlags(){
    *          throw new TMAPIIndexException('Exception in '.__method__);
    *      }
    *  </code>
    */
    public function getFlags();
    
    /**
    * isOpen: Return the state of this index. True if the index is currently open, false otherwise.
    * @access public
    * @return boolean 
    * @throws TMAPIIndexException()
    *  <code>
    *      public function isOpen(){
    *          throw new TMAPIIndexException('Exception in '.__method__);
    *      }
    *  </code>
    */
    public function isOpen();
    
    /**
    * open: Open the index. This method must be invoked before using any other method exported by this interface or derived interfaces.
    * @access public
    * @return void 
    * @throws TMAPIIndexException()
    *  <code>
    *      public function open(){
    *          throw new TMAPIIndexException('Exception in '.__method__);
    *      }
    *  </code>
    */
    public function open();
    
    /**
    * reindex: Resynchronize this index with the data in the topic map.
    * @access public
    * @return void 
    * @throws TMAPIIndexException()
    *  <code>
    *      public function reindex(){
    *          throw new TMAPIIndexException('Exception in '.__method__);
    *      }
    *  </code>
    */
    public function reindex();
    
    /**
    * isAutoUpdated: Returns the auto-update flag for the index. If the value of this flag is true, then the index is automatically kept synchronized with the topic map as values are changed. If the value is false, then the Index->reindex() method must be called to resynchronize the index with the topic map after values are changed.
    * @access public
    * @return boolean 
    */
    public function isAutoUpdated();
}
?>