Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

WebAdmin.IQueryHandler

The query handler interface. The WebAdmin contains a collection of query handlers with handle most requests assigned to the WebAdmin application. During creating the query handler will receive a couple of set up calls: init(...) and registerMenuItems(...). The webadmin has to register all URLs it will handle (url without the webapp path prefix). It is also allowed to replace an existing menu item. When the WebAdmin is shut down the cleanup() method will be called. Use this to perform some clean up and to set all Actor references to none (in case the query handler extends Object). Copyright 2008 Epic Games, Inc. All Rights Reserved @author Michiel 'elmuerte' Hendriks

WebAdmin.IQueryHandler

Structures Summary
KeyValuePair
key, value
WebAdminQuery
request, response, session, user, cookies

Functions Summary
function cleanup ()
functionbool handleQuery (WebAdminQuery q)
function init (WebAdmin webapp)
function registerMenuItems (WebAdminMenu menu)
functionbool unhandledQuery (WebAdminQuery q)


Structures Detail

KeyValuePair Source code

struct KeyValuePair
{
var string key;
var string value;
};


WebAdminQuery Source code

struct WebAdminQuery
{
var array<KeyValuePair> cookies;
var WebRequest request;
var WebResponse response;
var ISession session;
var IWebAdminUser user;
};
Struct contain current query information. Passed to the QueryHandlers.


Functions Detail

cleanup Source code

function cleanup ( )
Cleanup (prepare for being destroyed). If the implementation extends Object it should set all actor references to none.

handleQuery Source code

function bool handleQuery ( WebAdminQuery q )
Called by the webadmin to request the query handler to handle this query.
@return true when the query was handled.

init Source code

function init ( WebAdmin webapp )
Called when the WebAdmin creates and initializes this query handler.

registerMenuItems Source code

function registerMenuItems ( WebAdminMenu menu )
Called by the webadmin to request the query handler to add its menu items to the web admin menu. The menu is used to determine what query handler will be handle a given path. Paths not registered will be passed to all query handlers until one returns true.

unhandledQuery Source code

function bool unhandledQuery ( WebAdminQuery q )
Called in case of an unhandled path.
@return true when the query was handled.



Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: Sat 17/1/2009 20:56:05.250 - Created with UnCodeX