Documentation is available at Properties.php
- <?php
- /**
- * Properties is a mechanism for returning read-only data about an object. An
- * object can have data associated with a PropertiesType. For each
- * PropertiesType, there are Properties which are Serializable values
- * identified by a key.
- *
- * <p>
- * OSID Version: 2.0
- * </p>
- *
- * <p>
- * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
- * O.K.I. OSID Definition License}.
- * </p>
- *
- * @package org.osid.shared
- */
- class Properties
- {
- /**
- * Get the Type for this Properties instance.
- *
- * @return object Type
- *
- * @throws object SharedException An exception with one of the
- * following messages defined in org.osid.shared.SharedException
- * may be thrown: {@link }
- * org.osid.shared.SharedException#UNKNOWN_TYPE UNKNOWN_TYPE},
- * {@link org.osid.shared.SharedException#PERMISSION_DENIED}
- * PERMISSION_DENIED}, {@link }
- * org.osid.shared.SharedException#CONFIGURATION_ERROR
- * CONFIGURATION_ERROR}, {@link }
- * org.osid.shared.SharedException#UNIMPLEMENTED UNIMPLEMENTED}
- *
- * @access public
- */
- function getType () {
- die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
- }
- /**
- * Get the Property associated with this key.
- *
- * @param object mixed $key (original type: java.io.Serializable)
- *
- * @return object mixed (original type: java.io.Serializable)
- *
- * @throws object SharedException An exception with one of the
- * following messages defined in org.osid.shared.SharedException
- * may be thrown: {@link }
- * org.osid.shared.SharedException#UNKNOWN_TYPE UNKNOWN_TYPE},
- * {@link org.osid.shared.SharedException#PERMISSION_DENIED}
- * PERMISSION_DENIED}, {@link }
- * org.osid.shared.SharedException#CONFIGURATION_ERROR
- * CONFIGURATION_ERROR}, {@link }
- * org.osid.shared.SharedException#UNIMPLEMENTED UNIMPLEMENTED},
- * {@link org.osid.shared.SharedException#UNKNOWN_KEY UNKNOWN_KEY}
- *
- * @access public
- */
- function getProperty ( $key ) {
- die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
- }
- /**
- * Get the Keys associated with these Properties.
- *
- * @return object ObjectIterator
- *
- * @throws object SharedException An exception with one of the
- * following messages defined in org.osid.shared.SharedException
- * may be thrown: {@link }
- * org.osid.shared.SharedException#UNKNOWN_TYPE UNKNOWN_TYPE},
- * {@link org.osid.shared.SharedException#PERMISSION_DENIED}
- * PERMISSION_DENIED}, {@link }
- * org.osid.shared.SharedException#CONFIGURATION_ERROR
- * CONFIGURATION_ERROR}, {@link }
- * org.osid.shared.SharedException#UNIMPLEMENTED UNIMPLEMENTED}
- *
- * @access public
- */
- function getKeys () {
- die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
- }
- }
- ?>
Documentation generated on Wed, 19 Sep 2007 10:25:43 -0400 by phpDocumentor 1.3.0RC3