Source for file ScopedObject.interface.php

Documentation is available at ScopedObject.interface.php

  1. <?PHP
  2. /**
  3. * @package org.phptmapi.core
  4. */
  5. require_once('TopicMapObject.interface.php');
  6. /**
  7. * Interface ScopedObjectInterface: The base class for all objects which define a scope or parameter property.
  8. *
  9. * @author Johannes Schmidt - t8d <kontakt@t8d.de>
  10. */
  11. interface ScopedObjectInterface extends TopicMapObjectInterface{
  12. /**
  13. * getScope: Returns the topics which define the scope/parameters of this ScopedObjectInterface. The return value may be an empty array, but is never null.
  14. * @access public
  15. * @return array An unmodifiable array of TopicInterface objects.
  16. */
  17. public function getScope();
  18. /**
  19. * addScopingTopic: Adds a topic which defines the scope/parameters for this ScopedObjectInterface.
  20. * @param object TopicInterface $topic The topic to be added.
  21. * @access public
  22. * @return void
  23. */
  24. public function addScopingTopic(TopicInterface $topic);
  25. /**
  26. * removeScopingTopic: Removes a topic which defines the scope/parameters for this ScopedObjectInterface.
  27. * @param object TopicInterface $topic The topic to be removed.
  28. * @access public
  29. * @return void
  30. */
  31. public function removeScopingTopic(TopicInterface $topic);
  32. }
  33. ?>

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