Source for file OccurrencesIndex.interface.php

<?PHP
/**
 * @package org.phptmapi.index.core
*/
require_once('../org.phptmapi.index/Index.interface.php');
/**
 * Interface OccurrencesIndexInterface: An index of all OccurrenceInterface instances in the topic map by their type and resource reference or resource data.
 *
 * @author Johannes Schmidt - t8d <kontakt@t8d.de>
*/
interface OccurrencesIndexInterface extends IndexInterface{
    /**
    * getOccurrences: Returns the occurrences in the topic map whose data matches $value and XML Schema datatype matches $datatype. The return value may be an empty array but must never be null.
    * @param string $value The occurrence data.
    * @param string $datatype An XML Schema Datatype.
    * @access public
    * @return array An array of OccurrenceInterface instances.
    */
    public function getOccurrences($value, $datatype);
    
    /**
    * getOccurrencesByType: Returns the occurrences typed by the topic type.
    * @param object TopicInterface $type The type of occurrences to be returned. If $type is null an array containing all untyped occurrences will be returned. The return value may be an empty array but must never be null.
    * @access public
    * @return array An array of OccurrenceInterface instances.
    */
    public function getOccurrencesByType($type);
    
    /**
    * getOccurrenceTypes: Returns the topics which are used to type occurrences 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 OccurrenceInterface instances.
    */
    public function getOccurrenceTypes();
}
?>