Source for file AssociationsIndex.interface.php

Documentation is available at AssociationsIndex.interface.php

  1. <?PHP
  2. /**
  3. * @package org.phptmapi.index.core
  4. */
  5. require_once('../org.phptmapi.index/Index.interface.php');
  6. /**
  7. * Interface AssociationsIndexInterface: An index of AssociationInterface instances in a topic map. This index provides an index of associations by their type and a method for retrieving all topics which are used to specify the type of one or more associations.
  8. *
  9. * @author Johannes Schmidt - t8d <kontakt@t8d.de>
  10. */
  11. interface AssociationsIndexInterface extends IndexInterface{
  12. /**
  13. * getAssociationTypes: Retrieve the topics which are used to type associations in this topic map. The return value may be an empty array but must never be null.
  14. * @access public
  15. * @return array An array of TopicInterface instances.
  16. */
  17. public function getAssociationTypes();
  18. /**
  19. * getAssociationsByType: Retrieve the associations which are typed by the topic type. The return value may be an empty array but must never be null.
  20. * @param object TopicInterface $type The type of associations to be returned. If $type is null an array containing all untyped association will be returned.
  21. * @access public
  22. * @return array An array of AssociationInterface instances.
  23. */
  24. public function getAssociationsByType($type);
  25. }
  26. ?>

Documentation generated on Fri, 30 Jun 2006 13:06:49 +0200 by phpDocumentor 1.3.0RC4