ca.utoronto.atrc.web4all
Interface PrefsLoaderAPI

public interface PrefsLoaderAPI

Interface that defines the API for the Web4All preferences loader module.

Field Summary

static java.lang.String

preferencesMediaInitializedQueryKey

Method Summary

java.util.Properties	getPrefsLoadedProperties() Allows a client of the preferences loader to retrieve a preferences-loaded property.
void	savePrefs(org.w3c.dom.Document doc) Allows a client of the preferences loader to pass it a XML Document to write the preferences to some storage medium.
void	shutdown() Gracefully clean everything up, and exit the JVM.
void	startup() Allows an instance of a preference loader to initialize itself.

Field Detail

preferencesMediaInitializedQueryKey

public static final java.lang.String preferencesMediaInitializedQueryKey

See Also:

Constant Field Values

Method Detail

startup

public void startup()

Allows an instance of a preference loader to initialize itself.

savePrefs

public void savePrefs(org.w3c.dom.Document doc)

Allows a client of the preferences loader to pass it a XML Document to write the preferences to some storage medium.

Parameters:

doc - The data (XML Document) to write (save).

getPrefsLoadedProperties

public java.util.Properties getPrefsLoadedProperties()

Allows a client of the preferences loader to retrieve a preferences-loaded property.

Returns:

the preferences-loaded Properties object.

shutdown

public void shutdown()

Gracefully clean everything up, and exit the JVM.