Docs For Class BasicOutputHandlerConfigProperties

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

version: $Id: BasicOutputHandlerConfigProperties.class.php,v 1.6 2007/09/07 17:25:06 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/architecture/output/BasicOutputHandlerConfigProperties.class.php (line 33)

Properties
   |
   --BasicOutputHandlerConfigProperties

Method Summary

object ConfigurationProperties (object Type $type)

object ObjectIterator getKeys ()

object mixed getProperty (object mixed $key)

object Type getType ()

void setProperty (mixed $key, mixed $value)

Methods

ConfigurationProperties (line 45)

Constructor. Create a new Properties object.

since: 11/18/04
access: public

object ConfigurationProperties (object Type $type)

object Type $type

getKeys (line 119)

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 ()

Redefinition of:

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

getProperty (line 95)

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)

Redefinition of:

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

getType (line 71)

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 ()

Redefinition of:

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

setProperty (line 142)

Set the value of a Property/

WARNING: NOT IN OSID - This method is not in the OSIDs as of version 2.0 Use at your own risk

since: 11/18/04
access: public

void setProperty (mixed $key, mixed $value)

mixed $key
mixed $value

Inherited Methods

Inherited From Properties

Properties::getKeys()
Properties::getProperty()
Properties::getType()