Source for file Properties.php

Documentation is available at Properties.php

  1. <?php
  2. /**
  3. * Properties is a mechanism for returning read-only data about an object. An
  4. * object can have data associated with a PropertiesType. For each
  5. * PropertiesType, there are Properties which are Serializable values
  6. * identified by a key.
  7. *
  8. * <p>
  9. * OSID Version: 2.0
  10. * </p>
  11. *
  12. * <p>
  13. * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
  14. * O.K.I&#46; OSID Definition License}.
  15. * </p>
  16. *
  17. * @package org.osid.shared
  18. */
  19. class Properties
  20. {
  21. /**
  22. * Get the Type for this Properties instance.
  23. *
  24. * @return object Type
  25. *
  26. * @throws object SharedException An exception with one of the
  27. * following messages defined in org.osid.shared.SharedException
  28. * may be thrown: {@link }
  29. * org.osid.shared.SharedException#UNKNOWN_TYPE UNKNOWN_TYPE},
  30. * {@link org.osid.shared.SharedException#PERMISSION_DENIED}
  31. * PERMISSION_DENIED}, {@link }
  32. * org.osid.shared.SharedException#CONFIGURATION_ERROR
  33. * CONFIGURATION_ERROR}, {@link }
  34. * org.osid.shared.SharedException#UNIMPLEMENTED UNIMPLEMENTED}
  35. *
  36. * @access public
  37. */
  38. function getType () {
  39. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  40. }
  41.  
  42. /**
  43. * Get the Property associated with this key.
  44. *
  45. * @param object mixed $key (original type: java.io.Serializable)
  46. *
  47. * @return object mixed (original type: java.io.Serializable)
  48. *
  49. * @throws object SharedException An exception with one of the
  50. * following messages defined in org.osid.shared.SharedException
  51. * may be thrown: {@link }
  52. * org.osid.shared.SharedException#UNKNOWN_TYPE UNKNOWN_TYPE},
  53. * {@link org.osid.shared.SharedException#PERMISSION_DENIED}
  54. * PERMISSION_DENIED}, {@link }
  55. * org.osid.shared.SharedException#CONFIGURATION_ERROR
  56. * CONFIGURATION_ERROR}, {@link }
  57. * org.osid.shared.SharedException#UNIMPLEMENTED UNIMPLEMENTED},
  58. * {@link org.osid.shared.SharedException#UNKNOWN_KEY UNKNOWN_KEY}
  59. *
  60. * @access public
  61. */
  62. function getProperty ( $key ) {
  63. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  64. }
  65.  
  66. /**
  67. * Get the Keys associated with these Properties.
  68. *
  69. * @return object ObjectIterator
  70. *
  71. * @throws object SharedException An exception with one of the
  72. * following messages defined in org.osid.shared.SharedException
  73. * may be thrown: {@link }
  74. * org.osid.shared.SharedException#UNKNOWN_TYPE UNKNOWN_TYPE},
  75. * {@link org.osid.shared.SharedException#PERMISSION_DENIED}
  76. * PERMISSION_DENIED}, {@link }
  77. * org.osid.shared.SharedException#CONFIGURATION_ERROR
  78. * CONFIGURATION_ERROR}, {@link }
  79. * org.osid.shared.SharedException#UNIMPLEMENTED UNIMPLEMENTED}
  80. *
  81. * @access public
  82. */
  83. function getKeys () {
  84. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  85. }
  86. }
  87.  
  88. ?>

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