Source for file Association.interface.php

Documentation is available at Association.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 AssociationInterface: Represents the topic map association construct.
  9. *
  10. * @author Johannes Schmidt, Andreas Stephan - t8d <kontakt@t8d.de>
  11. */
  12. interface AssociationInterface extends ScopedObjectInterface, TypedObjectInterface{
  13. /**
  14. * createAssociationRole: Creates a new AssociationRoleInterface representing a role in this association.
  15. * @param object TopicInterface $player The topic playing the role or null if there is no player of this role.
  16. * @param object TopicInterface $type The topic defining the role of the new association role, or null if the role is untyped.
  17. * @access public
  18. * @return object AssociationRoleInterface The newly created association role.
  19. */
  20. public function createAssociationRole($player, $type);
  21. /**
  22. * getAssociationRoles: Returns the AssociationRoleInterface objects representing all of the roles in this association.
  23. * @access public
  24. * @return array
  25. */
  26. public function getAssociationRoles();
  27.  
  28. /**
  29. * getReifier: Returns the TopicInterface that reifies this association.
  30. * @access public
  31. * @return object TopicInterface A TopicInterface instance or null if the association is not reified.
  32. */
  33. public function getReifier();
  34. /**
  35. * setReifier: Sets the reifiying topic of this association.
  36. * @param object TopicInterface $reifier or null if the reifier should be set to null.
  37. * @access public
  38. * @return void
  39. * @throws ModelConstraintException if the topic already reifies another object.
  40. * <code>
  41. * public function setReifier($reifier){
  42. * throw new ModelConstraintException('Exception in '.__method__);
  43. * }
  44. * </code>
  45. */
  46. public function setReifier($reifier);
  47. }
  48. ?>

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