Source for file IdManager.php

Documentation is available at IdManager.php

  1. <?php
  2. include_once(dirname(__FILE__)."/../OsidManager.php");
  3. /**
  4. * IdManager creates and gets Ids. Ids are used in many different contexts
  5. * throughout the OSIDs. As with other Managers, use the OsidLoader to load
  6. * an implementation of this interface.
  7. *
  8. * <p>
  9. * All implementations of OsidManager (manager) provide methods for accessing
  10. * and manipulating the various objects defined in the OSID package. A manager
  11. * defines an implementation of an OSID. All other OSID objects come either
  12. * directly or indirectly from the manager. New instances of the OSID objects
  13. * are created either directly or indirectly by the manager. Because the OSID
  14. * objects are defined using interfaces, create methods must be used instead
  15. * of the new operator to create instances of the OSID objects. Create methods
  16. * are used both to instantiate and persist OSID objects. Using the
  17. * OsidManager class to define an OSID's implementation allows the application
  18. * to change OSID implementations by changing the OsidManager package name
  19. * used to load an implementation. Applications developed using managers
  20. * permit OSID implementation substitution without changing the application
  21. * source code. As with all managers, use the OsidLoader to load an
  22. * implementation of this interface.
  23. * </p>
  24. *
  25. * <p>
  26. * Unlike most Managers, IdManager does not have methods to return Type
  27. * information.
  28. * </p>
  29. *
  30. * <p>
  31. * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
  32. * O.K.I&#46; OSID Definition License}.
  33. * </p>
  34. *
  35. * <p>
  36. * OSID Version: 2.0
  37. * </p>
  38. *
  39. * @package org.osid.id
  40. */
  41. class IdManager
  42. extends OsidManager
  43. {
  44. /**
  45. * Create a new unique identifier.
  46. *
  47. * @return object Id
  48. *
  49. * @throws object IdException An exception with one of the following
  50. * messages defined in org.osid.id.IdException: {@link }
  51. * org.osid.id.IdException#OPERATION_FAILED OPERATION_FAILED},
  52. * {@link org.osid.id.IdException#PERMISSION_DENIED}
  53. * PERMISSION_DENIED}, {@link }
  54. * org.osid.id.IdException#CONFIGURATION_ERROR
  55. * CONFIGURATION_ERROR}, {@link }
  56. * org.osid.id.IdException#UNIMPLEMENTED UNIMPLEMENTED}
  57. *
  58. * @access public
  59. */
  60. function createId () {
  61. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  62. }
  63.  
  64. /**
  65. * Get the unique Id with this String representation or create a new unique
  66. * Id with this representation.
  67. *
  68. * @param string $idString
  69. *
  70. * @return object Id
  71. *
  72. * @throws object IdException An exception with one of the following
  73. * messages defined in org.osid.id.IdException: {@link }
  74. * org.osid.id.IdException#OPERATION_FAILED OPERATION_FAILED},
  75. * {@link org.osid.id.IdException#PERMISSION_DENIED}
  76. * PERMISSION_DENIED}, {@link }
  77. * org.osid.id.IdException#CONFIGURATION_ERROR
  78. * CONFIGURATION_ERROR}, {@link }
  79. * org.osid.id.IdException#UNIMPLEMENTED UNIMPLEMENTED}, {@link }
  80. * org.osid.id.IdException#NULL_ARGUMENT NULL_ARGUMENT}
  81. *
  82. * @access public
  83. */
  84. function getId ( $idString ) {
  85. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  86. }
  87. }
  88.  
  89. ?>

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