Plugins.Application.Arena.ArenaMediators.AnArenaMediator Class Reference

A content mediator customized for the default arena setup. More...

Inheritance diagram for Plugins.Application.Arena.ArenaMediators.AnArenaMediator:

Public Member Functions
def	__init__
	Constructor.
def	init
	Initializer.
def	__del__
	Destructor.
def	openLog
	Construct a log file for the mediator. More...
def	displayError
	Display an error.
def	loadPlugin
	Load the specified plugin. More...
def	connectToDataSource
	Connect to the site data source. More...
def	openChannel
	Open the channel that specifies the content which will be displayed to the user. More...
def	fetchContent
	Fetch content from the content provider specified by the current channel. More...
def	renderView
	Render the view.
def	run
	Run the application.
def	DataSource
	Retrieve or set the data source used by the mediator. More...
def	Channel
	Retrieve the channel displayed by the mediator. More...
Public Member Functions inherited from Plugins.Application.Mediators.AContentMediator
def	__init__
	Constructor.
def	init
	Initializer.
def	__del__
	Destructor.
def	openLog
	Construct or open a log file suitable for error and debugging output. More...
def	generate
	Generate the named event.
def	error
	Generate an error event. More...
def	log
	Log the specified item. More...
def	displayError
	Display an error that may occur while running the mediator.
def	loadPlugin
	Load the specified plugin. More...
def	fetchContent
	Fetch content from the content provider. More...
def	renderView
	Render content using the view provider. More...
def	on
	Set the handler for the specified event. More...
def	onMultiple
	Set handlers for multiple events. More...
def	handlerFor
	Retrieve the handler for the specified event. More...
def	generates
	Determine whether or not the object generates the named event. More...
def	ContentProvider
	Set or retrieve the content provider for the class. More...
def	ViewProvider
	Set or retrieve the view provider for the class. More...

Detailed Description

A content mediator customized for the default arena setup.

This content mediator loads content provider information from a data source specified in the local configuration file. This information is then used to present content to the end user.

Member Function Documentation

def Plugins.Application.Arena.ArenaMediators.AnArenaMediator.Channel

(

Self

)

Retrieve the channel displayed by the mediator.

def Plugins.Application.Arena.ArenaMediators.AnArenaMediator.connectToDataSource

(

Self

)

Connect to the site data source.

def Plugins.Application.Arena.ArenaMediators.AnArenaMediator.DataSource	(		Self,
			params,
			keywordParams
	)

Retrieve or set the data source used by the mediator.

If params is empty, this method simply returns the current data source. Alternatively, params may contain one of the following:

• A single class instance, which should either be a reference to an instance of ADataSource (or its descendants);
• Two strings: the first should be the name of a plugin to load, and the second should indicate the name of the class within that plugin to use as the data source. The class will be instantiated and passed any keyword parameters specified by keywordParams.

def Plugins.Application.Arena.ArenaMediators.AnArenaMediator.fetchContent	(		Self,
			params
	)

Fetch content from the content provider specified by the current channel.

This method constructs a content provider based on the information provided in the current channel record. Any parameters specified in params are passed to the content provider.

def Plugins.Application.Arena.ArenaMediators.AnArenaMediator.loadPlugin	(		Self,
			pluginName,
			identifier = None
	)

Load the specified plugin.

The plugin MUST be located within the plugins directory specified by the site configuration, or the attempt will fail.

def Plugins.Application.Arena.ArenaMediators.AnArenaMediator.openChannel

(

Self

)

Open the channel that specifies the content which will be displayed to the user.

def Plugins.Application.Arena.ArenaMediators.AnArenaMediator.openLog	(		Self,
			logFileName = None
	)

Construct a log file for the mediator.

---

The documentation for this class was generated from the following file:

• Plugins/Application/Arena/ArenaMediators.py