Docs For Class Properties

Description

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.

OSID Version: 2.0

Licensed under the org.osid.SidImplementationLicenseMIT.

Located in /harmoni/oki2/osid/shared/Properties.php (line 20)

Direct descendents

Class	Description
BasicOutputHandlerConfigProperties	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.
HarmoniProperties	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.

Method Summary

object ObjectIterator getKeys ()

object mixed getProperty (object mixed $key)

object Type getType ()

Methods

getKeys (line 84)

Get the Keys associated with these Properties.

access: public
throws: object SharedException An exception with one of the following messages defined in org.osid.shared.SharedException may be thrown: UNKNOWN_TYPE, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object ObjectIterator getKeys ()

Redefined in descendants as:

BasicOutputHandlerConfigProperties::getKeys() : Get the Keys associated with these Properties.
HarmoniProperties::getKeys() : Get the Keys associated with these Properties.

getProperty (line 63)

Get the Property associated with this key.

return: (original type: java.io.Serializable)
access: public
throws: object SharedException An exception with one of the following messages defined in org.osid.shared.SharedException may be thrown: UNKNOWN_TYPE, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, UNKNOWN_KEY

object mixed getProperty (object mixed $key)

object mixed $key: (original type: java.io.Serializable)

Redefined in descendants as:

BasicOutputHandlerConfigProperties::getProperty() : Get the Property associated with this key.
HarmoniProperties::getProperty() : Get the Property associated with this key.

getType (line 39)

Get the Type for this Properties instance.

access: public
throws: object SharedException An exception with one of the following messages defined in org.osid.shared.SharedException may be thrown: UNKNOWN_TYPE, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Type getType ()

Redefined in descendants as:

BasicOutputHandlerConfigProperties::getType() : Get the Type for this Properties instance.
HarmoniProperties::getType() : Get the Type for this Properties instance.