Source for file Occurrence.interface.php

Documentation is available at Occurrence.interface.php

  1. <?php
  2. /**
  3. * @package org.phptmapi.core
  4. */
  5. require_once('ScopedObject.interface.php');
  6. require_once('TypedObject.interface.php');
  7. /**
  8. * Interface OccurrenceInterface: Represents the topic map occurrence construct. An occurrence contains a value data string. The XML Schema Datatype specifies the data string for being interpreted as a reference to an external resource for example.
  9. *
  10. * @author Johannes Schmidt, Andreas Stephan - t8d <kontakt@t8d.de>
  11. */
  12. interface OccurrenceInterface extends ScopedObjectInterface, TypedObjectInterface{
  13. /**
  14. * getReifier: Returns the topic that reifies this occurrence.
  15. * @access public
  16. * @return object TopicInterface
  17. */
  18. public function getReifier();
  19. /**
  20. * setReifier: Sets the reifiying topic of this variant name.
  21. * @access public
  22. * @param object TopicInterface $reifier or null if the reifier should be set to null.
  23. * @return void
  24. * @throws ModelConstraintException if the topic already reifies another object.
  25. * <code>
  26. * public function setReifier($reifier){
  27. * throw new ModelConstraintException('Exception in '.__method__);
  28. * }
  29. * </code>
  30. */
  31. public function setReifier($reifier);
  32. /**
  33. * getTopic: Returns the topic to which this occurrence belongs.
  34. * @access public
  35. * @return TopicInterface The TopicInterface object which contains this occurrence.
  36. */
  37. public function getTopic();
  38. /**
  39. * getValue: Returns the data string associated with this occurrence.
  40. * @access public
  41. * @return string
  42. */
  43. public function getValue();
  44. /**
  45. * setValue: Sets the value data string for this occurrence. This method will overwrite any existing value data string.
  46. * @access public
  47. * @param string $value
  48. * @param string $datatype An XML Schema Datatype.
  49. * @return void
  50. */
  51. public function setValue($value, $datatype);
  52. /**
  53. * getDatatype: Returns the datatype of the occurrence's resource data.
  54. * @access public
  55. * @return string
  56. */
  57. public function getDatatype();
  58. }
  59. ?>

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