Source for file UsermessagingException.php

Documentation is available at UsermessagingException.php

  1. <?php
  2. include_once(dirname(__FILE__)."/../shared/SharedException.php");
  3. /**
  4. * OsidException or one of its subclasses is thrown by all methods of all
  5. * interfaces of an Open Service Interface Definition (OSID). This requires
  6. * the caller of an OSID package method handle the OsidException. Since the
  7. * application using an OSID can not determine where an implementation method
  8. * will ultimately execute, it must assume a worst case scenerio and protect
  9. * itself. OSID Implementations should throw their own subclasses of
  10. * OsidException and limit exception messages to those predefined by their own
  11. * OsidException or its superclasses. This approach to exception messages
  12. * allows Applications and OSID implementations using an OsidException's
  13. * predefined messages to handle exceptions in an interoperable way.
  14. *
  15. * <p>
  16. * OSID Version: 2.0
  17. * </p>
  18. *
  19. * <p>
  20. * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
  21. * O.K.I&#46; OSID Definition License}.
  22. * </p>
  23. *
  24. * @package org.osid.usermessaging
  25. */
  26. class UsermessagingException
  27. extends SharedException
  28. {
  29. /**
  30. * Unknown or unsupported Topic
  31. * Note: This method is PHP's equivalent of a static field.
  32. *
  33. * @return string
  34. * @access public
  35. * @static
  36. */
  37. function UNKNOWN_TOPIC () {
  38. return "Unknown Topic ";
  39. }
  40.  
  41. /**
  42. * Not currently subscribed to this Topic
  43. * Note: This method is PHP's equivalent of a static field.
  44. *
  45. * @return string
  46. * @access public
  47. * @static
  48. */
  49. function NOT_SUBSCRIBED () {
  50. return "Not currently subscribed to this Topic ";
  51. }
  52.  
  53.  
  54. function UsermessagingException ( $message ) {
  55. die($message);
  56. }
  57.  
  58. }
  59.  
  60. ?>

Documentation generated on Wed, 19 Sep 2007 10:27:39 -0400 by phpDocumentor 1.3.0RC3