Source for file Entry.php

Documentation is available at Entry.php

  1. <?php
  2. /**
  3. * Contains the logged item, its format type, its priority type, and the time
  4. * the item was logged.
  5. *
  6. * <p>
  7. * OSID Version: 2.0
  8. * </p>
  9. *
  10. * <p>
  11. * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
  12. * O.K.I&#46; OSID Definition License}.
  13. * </p>
  14. *
  15. * @package org.osid.logging
  16. */
  17. class Entry
  18. {
  19. /**
  20. * Return the logged item.
  21. *
  22. * @return object mixed (original type: java.io.Serializable)
  23. *
  24. * @throws object LoggingException An exception with one of the
  25. * following messages defined in org.osid.logging.LoggingException
  26. * may be thrown: {@link }
  27. * org.osid.logging.LoggingException#UNIMPLEMENTED UNIMPLEMENTED},
  28. * {@link org.osid.logging.LoggingException#OPERATION_FAILED}
  29. * OPERATION_FAILED}, {@link }
  30. * org.osid.logging.LoggingException#CONFIGURATION_ERROR
  31. * CONFIGURATION_ERROR}, {@link }
  32. * org.osid.logging.LoggingException#PERMISSION_DENIED
  33. * PERMISSION_DENIED}
  34. *
  35. * @access public
  36. */
  37. function getItem () {
  38. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  39. }
  40.  
  41. /**
  42. * Return the format type of logged item.
  43. *
  44. * @return object Type
  45. *
  46. * @throws object LoggingException An exception with one of the
  47. * following messages defined in org.osid.logging.LoggingException
  48. * may be thrown: {@link }
  49. * org.osid.logging.LoggingException#UNIMPLEMENTED UNIMPLEMENTED},
  50. * {@link org.osid.logging.LoggingException#OPERATION_FAILED}
  51. * OPERATION_FAILED}, {@link }
  52. * org.osid.logging.LoggingException#CONFIGURATION_ERROR
  53. * CONFIGURATION_ERROR}, {@link }
  54. * org.osid.logging.LoggingException#PERMISSION_DENIED
  55. * PERMISSION_DENIED}
  56. *
  57. * @access public
  58. */
  59. function getFormatType () {
  60. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  61. }
  62.  
  63. /**
  64. * Return the format type of logged item.
  65. *
  66. * @return object Type
  67. *
  68. * @throws object LoggingException An exception with one of the
  69. * following messages defined in org.osid.logging.LoggingException
  70. * may be thrown: {@link }
  71. * org.osid.logging.LoggingException#UNIMPLEMENTED UNIMPLEMENTED},
  72. * {@link org.osid.logging.LoggingException#OPERATION_FAILED}
  73. * OPERATION_FAILED}, {@link }
  74. * org.osid.logging.LoggingException#CONFIGURATION_ERROR
  75. * CONFIGURATION_ERROR}, {@link }
  76. * org.osid.logging.LoggingException#PERMISSION_DENIED
  77. * PERMISSION_DENIED}
  78. *
  79. * @access public
  80. */
  81. function getPriorityType () {
  82. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  83. }
  84.  
  85. /**
  86. * Return the time that the item was logged.
  87. *
  88. * @return int
  89. *
  90. * @throws object LoggingException An exception with one of the
  91. * following messages defined in org.osid.logging.LoggingException
  92. * may be thrown: {@link }
  93. * org.osid.logging.LoggingException#UNIMPLEMENTED UNIMPLEMENTED},
  94. * {@link org.osid.logging.LoggingException#OPERATION_FAILED}
  95. * OPERATION_FAILED}, {@link }
  96. * org.osid.logging.LoggingException#CONFIGURATION_ERROR
  97. * CONFIGURATION_ERROR}, {@link }
  98. * org.osid.logging.LoggingException#PERMISSION_DENIED
  99. * PERMISSION_DENIED}
  100. *
  101. * @access public
  102. */
  103. function getTimestamp () {
  104. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  105. }
  106. }
  107.  
  108. ?>

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