Source for file Variant.interface.php

Documentation is available at Variant.interface.php

  1. <?php
  2. /**
  3. * @package org.phptmapi.core
  4. */
  5. require_once('ScopedObject.interface.php');
  6. /**
  7. * Interface VariantInterface: Represents the topic map variant name construct. A variant name is qualified by zero or more parameters, each of which is a topic. This class uses the ScopedObjectInterface to manage the parameters. When implementing the VariantInterface remember that VARIANT is a native PHP class.
  8. *
  9. * @author Johannes Schmidt - t8d <kontakt@t8d.de>
  10. */
  11. interface VariantInterface extends ScopedObjectInterface{
  12. /**
  13. * getReifier: Returns the topic that reifies this variant name.
  14. * @access public
  15. * @return object TopicInterface
  16. */
  17. public function getReifier();
  18. /**
  19. * setReifier: Sets the reifiying topic of this variant name.
  20. * @param object TopicInterface $reifier or null if the reifier should be set to null.
  21. * @access public
  22. * @return void
  23. * @throws ModelConstraintException if the topic already reifies another object.
  24. * <code>
  25. * public function setReifier($reifier){
  26. * throw new ModelConstraintException('Exception in '.__method__);
  27. * }
  28. * </code>
  29. */
  30. public function setReifier($reifier);
  31. /**
  32. * getTopicName: Returns the topic name to which this variant belongs.
  33. * @access public
  34. * @return object TopicNameInterface
  35. */
  36. public function getTopicName();
  37. /**
  38. * getValue: Returns the data string associated with this variant.
  39. * @access public
  40. * @return string
  41. */
  42. public function getValue();
  43. /**
  44. * setValue: Sets the resource data string for this variant. This method will overwrite any existing value data string and will set the value of the resource property to null.
  45. * @param string $value
  46. * @param string $datatype An XML Schema Datatype.
  47. * @access public
  48. * @return void
  49. */
  50. public function setValue($value, $datatype);
  51. /**
  52. * getDatatype: Returns the datatype of the variant's resource data.
  53. * @access public
  54. * @return string
  55. */
  56. public function getDatatype();
  57. }
  58. ?>

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