Source for file TopicMapSystem.interface.php

Documentation is available at TopicMapSystem.interface.php

  1. <?php
  2. /**
  3. * @package org.phptmapi.core
  4. */
  5. /**
  6. * Interface TopicMapSystemInterface: A generic interface to a PHPTMAPI system.
  7. *
  8. * @author Johannes Schmidt - t8d <kontakt@t8d.de>
  9. */
  10. interface TopicMapSystemInterface{
  11. /**
  12. * close: Applications SHOULD call this method when the TopicMapSystemInterface instance is no longer required.
  13. * @access public
  14. * @return void
  15. */
  16. public function close();
  17.  
  18. /**
  19. * createTopicMap: Creates a new topic map with a specified base locator.
  20. * @param string $baselocatorref
  21. * @access public
  22. * @return object TopicMapInterface
  23. * @throws TopicMapExistsException if the topic map system already manages a topic map with the specified base locator.
  24. * <code>
  25. * public function createTopicMap($baselocatorref){
  26. * throw new TopicMapExistsException('Exception in '.__method__);
  27. * }
  28. * </code>
  29. */
  30. public function createTopicMap($baselocatorref);
  31. /**
  32. * getTopicMap: Retrieves the topic map managed by the system with the specified base locator.
  33. * @param string $baselocatorref
  34. * @access public
  35. * @return object TopicMapInterface or null
  36. */
  37. public function getTopicMap($baselocatorref);
  38. /**
  39. * getBaseLocators: Returns the base locators of the topic maps managed by the system.
  40. * @access public
  41. * @return array
  42. */
  43. public function getBaseLocators();
  44. /**
  45. * getProperty: Gets a property in the underlying implementation of TopicMapSystemInterface. A list of the core properties defined by TMAPI can be found at http://tmapi.org/properties/. An implementation is free to support properties other than the core ones. The properties supported by the TopicMapSystemInterface and the value for each property is set when the TopicMapSystemInterface is created by a call to TopicMapSystemFactory->newTopicMapSystem() and cannot be modified subsequently.
  46. * @param string $propertyName
  47. * @access public
  48. * @return string or null
  49. */
  50. public function getProperty($propertyName);
  51. /**
  52. * getFeature: Returns the value of the feature specified by $featureName for this TopicMapSystemInterface instance. The features supported by the TopicMapSystemInterface and the value for each feature is set when the TopicMapSystemInterface is created by a call to TopicMapSystemFactory->newTopicMapSystem() and cannot be modified subsequently.
  53. * @param string $featureName
  54. * @access public
  55. * @return boolean
  56. * @throws FeatureNotRecognizedException if the underlying implementation does not recognize the named feature.
  57. * <code>
  58. * public function getFeature($featureName){
  59. * throw new FeatureNotRecognizedException('Exception in '.__method__);
  60. * }
  61. * </code>
  62. */
  63. public function getFeature($featureName);
  64. }
  65. ?>

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