Source for file ScopedObjectsIndex.interface.php

<?PHP
/**
 * @package org.phptmapi.index.core
*/
require_once('../org.phptmapi.index/Index.interface.php');
/**
 * Interface ScopedObjectsIndexInterface: An index of all ScopedObjectInterfaces (AssociationInterface, TopicNameInterface, OccurrenceInterface and VariantInterface) instances in the indexed topic map. This index provides methods to retrieve all of the ScopedObjectInterface instances in the topic map with a particular topic or set of topics in their scope, and to retrieve all of the topics used in the scope of one or more scoped objects in the topic map.
 *
 * @author Johannes Schmidt - t8d <kontakt@t8d.de>
*/
interface ScopedObjectsIndexInterface extends IndexInterface{
    /**
    * getScopedObjectsByScopingTopic: Returns all ScopedObjectInterface instances where the specified topic is one of the themes in the scope of the ScopedObjectInterface. The return value may be an empty array but must never be null.
    * @param object TopicInterface $scopingTopic The topic that must be in the scope of each returned ScopedObjectInterface. If $scopingTopic is null an array containing all ScopedObjectInterfaces that have no scope will be returned.
    * @access public
    * @return array - An array of ScopedObjectInterface instances.
    */
    public function getScopedObjectsByScopingTopic($scopingTopic);
    
    /**
    * getScopedObjectsByScopingTopics: Returns all ScopedObjectInterface instances where some or all of the specified topics are in the scope of the scoped object. The return value may be an empty array but must never be null.
    * @param array $scopingTopics 
    * @param boolean $matchAll 
    * @access public
    * @return array An array of ScopedObjectInterface instances.
    */
    public function getScopedObjectsByScopingTopics($scopingTopics, $matchAll);
    
    /**
    * getScopingTopics: Returns all TopicInterface instances which are present in the scope of one or more ScopedObjectInterface instances in the indexed topic map. The return value may be an empty array but must never be null.
    * @access public
    * @return array An array of TopicInterface instances.
    */
    public function getScopingTopics();
}
?>