Source for file Id.php

Documentation is available at Id.php

  1. <?php
  2. /**
  3. * Id represents a unique identifier. A String representation of the unique
  4. * identifier is available with getIdString(). To convert from a String
  5. * representation of the identifier to the identifier object,
  6. * org.osid.shared.Id, use getId(String). Id can determine if it is equal to
  7. * another Id.
  8. *
  9. * <p>
  10. * OSID Version: 2.0
  11. * </p>
  12. *
  13. * <p>
  14. * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
  15. * O.K.I&#46; OSID Definition License}.
  16. * </p>
  17. *
  18. * @package org.osid.shared
  19. */
  20. class Id
  21. {
  22. /**
  23. * Return the String representation of this unique Id.
  24. *
  25. * @return string
  26. *
  27. * @throws object SharedException An exception with one of the
  28. * following messages defined in org.osid.shared.SharedException
  29. * may be thrown: {@link }
  30. * org.osid.shared.SharedException#UNKNOWN_TYPE UNKNOWN_TYPE},
  31. * {@link org.osid.shared.SharedException#PERMISSION_DENIED}
  32. * PERMISSION_DENIED}, {@link }
  33. * org.osid.shared.SharedException#CONFIGURATION_ERROR
  34. * CONFIGURATION_ERROR}, {@link }
  35. * org.osid.shared.SharedException#UNIMPLEMENTED UNIMPLEMENTED}
  36. *
  37. * @access public
  38. */
  39. function getIdString () {
  40. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  41. }
  42.  
  43. /**
  44. * Tests if an unique Id equals this unique Id.
  45. *
  46. * @param object Id $id
  47. *
  48. * @return boolean
  49. *
  50. * @throws object SharedException An exception with one of the
  51. * following messages defined in org.osid.shared.SharedException
  52. * may be thrown: {@link }
  53. * org.osid.shared.SharedException#UNKNOWN_TYPE UNKNOWN_TYPE},
  54. * {@link org.osid.shared.SharedException#PERMISSION_DENIED}
  55. * PERMISSION_DENIED}, {@link }
  56. * org.osid.shared.SharedException#CONFIGURATION_ERROR
  57. * CONFIGURATION_ERROR}, {@link }
  58. * org.osid.shared.SharedException#UNIMPLEMENTED UNIMPLEMENTED},
  59. * {@link org.osid.shared.SharedException#NULL_ARGUMENT}
  60. * NULL_ARGUMENT}
  61. *
  62. * @access public
  63. */
  64. function isEqual ( $id ) {
  65. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  66. }
  67. }
  68.  
  69. ?>

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