Source for file AssociationRole.interface.php

Documentation is available at AssociationRole.interface.php

  1. <?php
  2. /**
  3. * @package org.phptmapi.core
  4. */
  5. require_once('TopicMapObject.interface.php');
  6. require_once('TypedObject.interface.php');
  7. /**
  8. * Interface AssociationRoleInterface: Represents the topic map member / role construct (known as association role in HyTM). This class represents a normalised association member / role. In normalising the members / roles of an association, one member must be created for each of the role players of the association. For example the following (XTM) association would result in three Member / Role objects.
  9. *
  10. * <code>
  11. * <association>
  12. * <member>
  13. * <instanceOf><topicRef xlink:href="#parent"/></instanceOf>
  14. * <topicRef xlink:href="#homer"/>
  15. * </member>
  16. * <member>
  17. * <instanceOf><topicRef xlink:href="#child"/></instanceOf>
  18. * <topicRef xlink:href="#bart"/>
  19. * <topicRef xlink:href="#lisa"/>
  20. * </member>
  21. * </association>
  22. * </code>
  23. *
  24. * @author Johannes Schmidt, Andreas Stephan - t8d <kontakt@t8d.de>
  25. */
  26. interface AssociationRoleInterface extends TopicMapObjectInterface, TypedObjectInterface{
  27. /**
  28. * getAssociation: Returns the association to which this association role belongs.
  29. * @access public
  30. * @return object AssociationInterface
  31. */
  32. public function getAssociation();
  33. /**
  34. * setPlayer: Sets the player of this association role. $player overwrites any previous value.
  35. * @access public
  36. * @param object TopicInterface $player The topic which plays this role in the association, or null if no topic plays this role.
  37. * @return void
  38. */
  39. public function setPlayer(TopicInterface $player);
  40. /**
  41. * getPlayer: Returns the player of this association role or null if there is no role player.
  42. * @access public
  43. * @return object TopicInterface
  44. */
  45. public function getPlayer();
  46.  
  47. /**
  48. * getReifier: Returns the topic that reifies this association role.
  49. * @access public
  50. * @return object TopicInterface
  51. */
  52. public function getReifier();
  53. /**
  54. * setReifier: Sets the reifiying topic of this association role.
  55. * @access public
  56. * @param object TopicInterface $reifier or null if the reifier should be set to null.
  57. * @return void
  58. * @throws ModelConstraintException if the topic already reifies another object.
  59. * <code>
  60. * public function setReifier($reifier){
  61. * throw new ModelConstraintException('Exception in '.__method__);
  62. * }
  63. * </code>
  64. */
  65. public function setReifier($reifier);
  66. }
  67. ?>

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