Source for file TopicNamesIndex.interface.php

Documentation is available at TopicNamesIndex.interface.php

  1. <?PHP
  2. /**
  3. * @package org.phptmapi.index.core
  4. */
  5. require_once('../org.phptmapi.index/Index.interface.php');
  6. require_once('../org.phptmapi.core/Topic.interface.php');
  7. /**
  8. * Interface TopicNamesIndexInterface: This Index gives direct access to all topic names. You can get all topic names, or a topic name by value.
  9. *
  10. * @author Johannes Schmidt - t8d <kontakt@t8d.de>
  11. */
  12. interface TopicNamesIndexInterface extends IndexInterface{
  13. /**
  14. * getTopicNamesByType: Retrieves the topic names in the indexed topic map whose type is defined by the specified topic. The return value may be an empty array but must never be null.
  15. * @param object TopicInterface $type The type of the topic names to be retrieved. If $type is null an array containing all untyped topic names will be returned.
  16. * @access public
  17. * @return array An array of TopicNameInterface instances. If the processor does not support the XTM 1.1 model, this method MUST return an empty array.
  18. */
  19. public function getTopicNamesByType($type);
  20. /**
  21. * getTopicNamesByValue: Retrieves the topic names in the topic map which have a value equal to $value. The return value may be an empty array but must never be null.
  22. * @param string $value
  23. * @access public
  24. * @return array An array of TopicNameInterface instances.
  25. */
  26. public function getTopicNamesByValue($value);
  27. /**
  28. * getTopicNameTypes: Retrieves the topics in the topic map which define the type of one or more topic names. The return value may be an empty array but must never be null.
  29. * @access public
  30. * @return array - An array of TopicInterface instances. If the processor does not support the XTM 1.1 model, this method MUST return an empty array.
  31. */
  32. public function getTopicNameTypes();
  33. }
  34. ?>

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