Source for file Timespan.php

Documentation is available at Timespan.php

  1. <?php
  2. /**
  3. * Timespan defines a time span in terms of a start and end date and time.
  4. *
  5. * <p>
  6. * OSID Version: 2.0
  7. * </p>
  8. *
  9. * <p>
  10. * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
  11. * O.K.I&#46; OSID Definition License}.
  12. * </p>
  13. *
  14. * @package org.osid.scheduling
  15. */
  16. class Timespan
  17. {
  18. /**
  19. * Get the Start date and time of this Timespan.
  20. *
  21. * @return int
  22. *
  23. * @throws object SchedulingException An exception with one of
  24. * the following messages defined in
  25. * org.osid.scheduling.SchedulingException may be thrown: {@link }
  26. * org.osid.scheduling.SchedulingException#OPERATION_FAILED
  27. * OPERATION_FAILED}, {@link }
  28. * org.osid.scheduling.SchedulingException#PERMISSION_DENIED
  29. * PERMISSION_DENIED}, {@link }
  30. * org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
  31. * CONFIGURATION_ERROR}, {@link }
  32. * org.osid.scheduling.SchedulingException#UNIMPLEMENTED
  33. * UNIMPLEMENTED}
  34. *
  35. * @access public
  36. */
  37. function getStart () {
  38. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  39. }
  40.  
  41. /**
  42. * Get the End date and time of this Timespan.
  43. *
  44. * @return int
  45. *
  46. * @throws object SchedulingException An exception with one of
  47. * the following messages defined in
  48. * org.osid.scheduling.SchedulingException may be thrown: {@link }
  49. * org.osid.scheduling.SchedulingException#OPERATION_FAILED
  50. * OPERATION_FAILED}, {@link }
  51. * org.osid.scheduling.SchedulingException#PERMISSION_DENIED
  52. * PERMISSION_DENIED}, {@link }
  53. * org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
  54. * CONFIGURATION_ERROR}, {@link }
  55. * org.osid.scheduling.SchedulingException#UNIMPLEMENTED
  56. * UNIMPLEMENTED}
  57. *
  58. * @access public
  59. */
  60. function getEnd () {
  61. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  62. }
  63. }
  64.  
  65. ?>

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