Docs For Class OutputHandler

Description

The OutputHander abstract class defines methods for the interaction between the Harmoni framework object and output handling classes.

version: $Id: OutputHandler.abstract.php,v 1.6 2007/09/04 20:25:30 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/architecture/output/OutputHandler.abstract.php (line 25)

OsidManager
   |
   --OutputHandler

Direct descendents

Class	Description
BasicOutputHandler	The OutputHander abstract class defines methods for the interaction between the Harmoni framework object and output handling classes.
GUIManagerAbstract	This abstract provides methods for theme management: saving/loading of theme state, obtaining information about supported GUI components, etc.

Variable Summary

string $_head

Method Summary

void assignConfiguration (object Properties $configuration)

void assignOsidContext (mixed $context, object OsidContext $context )

void attachToHarmoni ()

string getHead ()

object OsidContext getOsidContext ()

void output (mixed $returnedContent, string $printedContent)

void setHead (string $newHead)

Variables

string $_head (line 38)

var: The head content
since: 7/7/05
access: private

Methods

assignConfiguration (line 64)

Assign the configuration of this Manager. Valid configuration options are as

follows: database_index integer database_name string

access: public
throws: object OsidException An exception with one of the following messages defined in org.osid.OsidException: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT

void assignConfiguration (object Properties $configuration)

object Properties $configuration: (original type: java.util.Properties)

Redefinition of:

OsidManager::assignConfiguration(): Assign the configuration of this OsidManager.

Redefined in descendants as:

GUIManager::assignConfiguration() : Assign the configuration of this Manager. Valid configuration options are as

assignOsidContext (line 92)

Assign the context of this OsidManager.

access: public
throws: object OsidException An exception with one of the following messages defined in org.osid.OsidException: NULL_ARGUMENT

void assignOsidContext (mixed $context, object OsidContext $context )

object OsidContext $context

Redefinition of:

OsidManager::assignOsidContext(): Assign the context of this OsidManager.

Redefined in descendants as:

GUIManager::assignOsidContext() : Assign the context of this OsidManager.

attachToHarmoni (line 105)

Attach this class to the HarmoniObject as the current OutputHandler.

This method and Harmoni::attachOutputHandler() make up a Double-Dispatch design pattern.

since: 4/4/05
access: public

void attachToHarmoni ()

getHead (line 146)

Get the 'head' html element.

since: 4/4/05
access: public

string getHead ()

getOsidContext (line 77)

Return context of this OsidManager.

access: public
throws: object OsidException

object OsidContext getOsidContext ()

Redefinition of:

OsidManager::getOsidContext(): Return context of this OsidManager.

Redefined in descendants as:

GUIManager::getOsidContext() : Return context of this OsidManager.

output (line 123)

Output the content that was returned from an action. This content should have been created such that it is a type that this OutputHandler can deal with.

since: 4/4/05
access: public

void output (mixed $returnedContent, string $printedContent)

mixed $returnedContent: Content returned by the action
string $printedContent: Additional content printed, but not returned.

Redefined in descendants as:

BasicOutputHandler::output() : Output the content that was returned from an action. This content should have been created such that it is a type that this OutputHandler can deal with.
GUIManagerAbstract::output() : Output the content that was returned from an action. This content should have been created such that it is a type that this OutputHandler can deal with.

setHead (line 135)

Set the 'head' html element.

since: 4/4/05
access: public

void setHead (string $newHead)

string $newHead

Inherited Methods

Inherited From OsidManager

OsidManager::assignConfiguration()
OsidManager::assignOsidContext()
OsidManager::getOsidContext()
OsidManager::osidVersion_2_0()