com.raritantechnologies.prefs
Class PreferencesManager

java.lang.Object
  com.raritantechnologies.prefs.PreferencesManager

All Implemented Interfaces:

IConfigurable, ICustomTag

public class PreferencesManager

extends java.lang.Object

implements ICustomTag, IConfigurable

Manages a set of IPreferencesHandlers. Each IPreferenceHandler can write a section of html on a preferences page and respond to http requests to maintain a preference state.

XML Configuration Schema:

  <SystemObject type="PreferencesManager" name="[ PreferencesManager name ]"
                   configurableClass="com.raritantechnologies.prefs.PreferencesManager" >

    <!-- contains one or more PreferencesHandler tags -->
    <PreferencesHandler name="[name of handler]"
                           class="[ class of com.raritantechnologies.prefs.IPreferencesHandler]" >
      <!-- configuration parameters for handler -->
    </PreferencesHandler>

  </SystemObject>
 

Developed by Raritan Technologies .

Author:

Glenn Robitaille

Constructor Summary

PreferencesManager()

Method Summary

void	addPreferencesHandler(java.lang.String name, IPreferencesHandler prefHandler)
java.lang.String	getBody(RaritanPageContext rpc) Returns the tag body.
static java.util.Iterator	getPreferenceManagerNames(java.lang.String sessionID)
IPreferencesHandler	getPreferencesHandler(java.lang.String name)
static PreferencesManager	getPreferencesManager(java.lang.String sessionID, java.lang.String name)
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	initialize(java.util.Map initParams)
void	restorePersistentState()
void	savePreferences(HttpServletRequest req)
void	updateSessionData(java.util.Map sessData)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PreferencesManager

public PreferencesManager()

Method Detail

getPreferencesManager

public static PreferencesManager getPreferencesManager(java.lang.String sessionID,
                                                       java.lang.String name)

getPreferenceManagerNames

public static java.util.Iterator getPreferenceManagerNames(java.lang.String sessionID)

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IConfigurable

initialize

public void initialize(java.util.Map initParams)

Specified by:

initialize in interface ICustomTag

restorePersistentState

public void restorePersistentState()

updateSessionData

public void updateSessionData(java.util.Map sessData)

addPreferencesHandler

public void addPreferencesHandler(java.lang.String name,
                                  IPreferencesHandler prefHandler)

getPreferencesHandler

public IPreferencesHandler getPreferencesHandler(java.lang.String name)

getBody

public java.lang.String getBody(RaritanPageContext rpc)

Description copied from interface: ICustomTag

Returns the tag body.

Specified by:

getBody in interface ICustomTag

Parameters:

rpc - Platform-neutral page context ( can be used in non J2EE environments such as ASP).

Returns:

The tag body text string.

savePreferences

public void savePreferences(HttpServletRequest req)