Source for file TopicsMustMergeException.exception.php

Documentation is available at TopicsMustMergeException.exception.php

  1. <?php
  2. /**
  3. * @package org.phptmapi.core
  4. */
  5. require_once('MergeException.exception.php');
  6. /**
  7. * public class TopicsMustMergeException: Exception raised when a topic is changed in such a way that it would have to be merged with another topic in the same topic map. This exception should only be thrown if the "Automatic Merging" feature (http://tmapi.org/features/automerge) is disabled. If automatic merging is enabled, then the merge should take place transparently to the API user. If an implementation throws this exception, then the property change which caused the exception to be raised MUST NOT be completed.
  8. *
  9. * @author Johannes Schmidt - t8d <kontakt@t8d.de>
  10. */
  11. class TopicsMustMergeException extends MergeException {
  12. /**
  13. * Constructor
  14. * @param object TopicInterface $modified
  15. * @param object TopicInterface $unmodified
  16. * @param string $msg
  17. * @access public
  18. */
  19. public function __construct(TopicInterface $modified, TopicInterface $unmodified, $msg){
  20. $this->mtopic = $modified;
  21. $this->umtopic = $unmodified;
  22. parent::__construct($msg);
  23. }
  24. /**
  25. * getModifiedTopic: Returns the topic which was changed in the operation that raised this exception.
  26. * @access public
  27. * @return object TopicInterface
  28. */
  29. public function getModifiedTopic(){
  30. return $this->mtopic;
  31. }
  32. /**
  33. * getUnmodifiedTopic: Returns the topic which was unchanged in the operation that raised this exception.
  34. * @access public
  35. * @return object TopicInterface
  36. */
  37. public function getUnmodifiedTopic(){
  38. return $this->umtopic;
  39. }
  40. }
  41. ?>

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