net.sf.regain.ui.desktop.config
Interface DesktopConfig

All Known Implementing Classes:

XmlDesktopConfig

public interface DesktopConfig

The configuration of the desktop search.

Author:

Til Schneider, www.murfman.de

Method Summary

String	getBrowser() Gets the executable of the browser that should be used for showing web pages.
boolean	getExternalAccessAllowed() Gets the setting wheter external access to the instance is allowed or not.
int	getInterval() Gets the index update interval from the desktop configuration.
int	getPort() Gets the port of the webserver.
Map<String,String>	getSimpleNamespaces() Gets Tag namespaces that should be registered so they can be used in the JSP-File.

Method Detail

getInterval

int getInterval()
                throws RegainException

Gets the index update interval from the desktop configuration.

Returns:

The index update interval.

Throws:

RegainException - If loading the config failed.

getPort

int getPort()
            throws RegainException

Gets the port of the webserver.

Returns:

The port of the webserver.

Throws:

RegainException - If loading the config failed.

getBrowser

String getBrowser()
                  throws RegainException

Gets the executable of the browser that should be used for showing web pages. Returns null if the browser should be auto-detected.

Returns:

The executable of the browser.

Throws:

RegainException - If loading the config failed.

getExternalAccessAllowed

boolean getExternalAccessAllowed()
                                 throws RegainException

Gets the setting wheter external access to the instance is allowed or not. pages. Returns FALSE if no config entry exists

Returns:

the boolean whether external access is allowed or not

Throws:

RegainException - If loading the config failed.

getSimpleNamespaces

Map<String,String> getSimpleNamespaces()
                                       throws RegainException

Gets Tag namespaces that should be registered so they can be used in the JSP-File.

Returns:

A map of Alias - Package Name

Throws:

RegainException - If loading the config failed.