Source for file TopicName.interface.php

Documentation is available at TopicName.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 TopicNameInterface: Represents the topic map topicname construct. In XTM 1.0, this construct is represented by the <baseName> element. In XTM 2.0, this construct is represented by the <name> element.
  9. *
  10. * @author Johannes Schmidt - t8d <kontakt@t8d.de>
  11. */
  12. interface TopicNameInterface extends ScopedObjectInterface, TypedObjectInterface{
  13. /**
  14. * createVariant: Creates a variant of this topic name with the specified resource data string and scopes.
  15. * @param string $value The inline data string for the variant. Pass null for no string.
  16. * @param string $datatype An XML Schema Datatype.
  17. * @param array $scope The scope for the variant to be created. Must be an array of TopicInterface objects.
  18. * @access public
  19. * @return object VariantInterface
  20. */
  21. public function createVariant($value, $datatype, $scope);
  22.  
  23. /**
  24. * getReifier: Returns the topic that reifies this topic name.
  25. * @access public
  26. * @return object TopicInterface
  27. */
  28. public function getReifier();
  29. /**
  30. * setReifier: Sets the reifiying topic of this topic name.
  31. * @param object TopicInterface $reifier or null if the reifier should be set to null.
  32. * @access public
  33. * @return void
  34. * @throws ModelConstraintException if the topic already reifies another object.
  35. * <code>
  36. * public function setReifier($reifier){
  37. * throw new ModelConstraintException('Exception in '.__method__);
  38. * }
  39. * </code>
  40. */
  41. public function setReifier($reifier);
  42. /**
  43. * getTopic: Returns the topic which contains this topic name.
  44. * @access public
  45. * @return object TopicInterface
  46. */
  47. public function getTopic();
  48. /**
  49. * getValue: Returns the name string of the topic name.
  50. * @access public
  51. * @return string OR null
  52. */
  53. public function getValue();
  54. /**
  55. * getVariants: Returns the VariantInterface instances defined for this topic name. The return value may be an empty array, but is never null.
  56. * @access public
  57. * @return array
  58. */
  59. public function getVariants();
  60. /**
  61. * setValue: Define the name string for this topic name. A new value will replace any existing value. A null value indicates that there is no name string for this topic name.
  62. * @param string $value
  63. * @access public
  64. * @return void
  65. * @throws MergeException if the processor detects that a merge is required and either automerge is disabled or automerge is enabled but the merge cannot be completed for some other reason.
  66. * <code>
  67. * public function setValue($value){
  68. * throw new MergeException('Exception in '.__method__);
  69. * }
  70. * </code>
  71. */
  72. public function setValue($value);
  73. }
  74. ?>

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