Source for file Clob.php

Documentation is available at Clob.php

  1. <?php
  2. /**
  3. * A Clob is a variable length representation of character values. (Clob
  4. * stands for <u>C</u>haracter <u>L</u>arge <u>Ob</u>ject.) The contents of a
  5. * Clob are returned in a CharValueIterator by the getChars() method. Its
  6. * length is returned by the method length().
  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.sql
  18. */
  19. class Clob
  20. {
  21. /**
  22. * return this Clobs's chars.
  23. *
  24. * @return object CharValueIterator
  25. *
  26. * @throws object SqlException An exception with one of the following
  27. * messages defined in org.osid.sql.SqlException may be thrown:
  28. * {@link org.osid.sql.SqlException#CLOB_GETCHARS_FAILED}, {@link }
  29. * org.osid.sql.SqlException#OPERATION_FAILED OPERATION_FAILED},
  30. * {@link org.osid.sql.SqlException#PERMISSION_DENIED}
  31. * PERMISSION_DENIED}, {@link }
  32. * org.osid.sql.SqlException#CONFIGURATION_ERROR
  33. * CONFIGURATION_ERROR}, {@link }
  34. * org.osid.sql.SqlException#UNIMPLEMENTED UNIMPLEMENTED}
  35. *
  36. * @access public
  37. */
  38. function getChars () {
  39. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  40. }
  41.  
  42. /**
  43. * return the length of the object
  44. *
  45. * @return int
  46. *
  47. * @throws object SqlException An exception with one of the following
  48. * messages defined in org.osid.sql.SqlException may be thrown:
  49. * {@link org.osid.sql.SqlException#OPERATION_FAILED}
  50. * OPERATION_FAILED}, {@link }
  51. * org.osid.sql.SqlException#PERMISSION_DENIED PERMISSION_DENIED},
  52. * {@link org.osid.sql.SqlException#CONFIGURATION_ERROR}
  53. * CONFIGURATION_ERROR}, {@link }
  54. * org.osid.sql.SqlException#UNIMPLEMENTED UNIMPLEMENTED}
  55. *
  56. * @access public
  57. */
  58. function length () {
  59. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  60. }
  61. }
  62.  
  63. ?>

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