org.qedeq.kernel.bo.module
Interface ModuleProperties

All Known Implementing Classes:

DefaultModuleProperties

public interface ModuleProperties

Represents a module and its states.

Version:

$Revision: 1.1 $

Method Summary

String	getAddress() Get address of module.
Exception	getException() Get exception.
LoadingState	getLoadingState() Get module loading state.
QedeqBo	getModule() Get module.
ModuleAddress	getModuleAddress() Get ModuleAddress of module.
String	getName() Get name of module.
String	getRuleVersion() Get rule version information.
String	getStateDescription() Get module state description.
URL	getUrl() Get original URL of module.
boolean	hasFailures() Is this a failure state the module is in?
boolean	isLoaded() Is this module already loaded?
void	setLoaded(QedeqBo module) Set checked and loaded state and module.
void	setLoadingCompleteness(int completeness) Set completeness percentage.
void	setLoadingFailureState(LoadingState state, Exception e) Set failure module state.
void	setLoadingProgressState(LoadingState state) Set loading progress module state.

Method Detail

hasFailures

public boolean hasFailures()

Is this a failure state the module is in?

Returns:

were there any errors?

getAddress

public String getAddress()

Get address of module.

Returns:

address of module.

getModuleAddress

public ModuleAddress getModuleAddress()

Get ModuleAddress of module. Maybe null.

Returns:

address of module.

setLoadingCompleteness

public void setLoadingCompleteness(int completeness)

Set completeness percentage.

Parameters:

completeness - Completeness of loading into memory.

setLoadingProgressState

public void setLoadingProgressState(LoadingState state)

Set loading progress module state.

Parameters:

state - module state

setLoadingFailureState

public void setLoadingFailureState(LoadingState state,
                                   Exception e)

Set failure module state.

Parameters:

state - module state

e - Exception that occurred during loading.

Throws:

IllegalArgumentException - state is no failure state

getLoadingState

public LoadingState getLoadingState()

Get module loading state.

Returns:

module state.

getException

public Exception getException()

Get exception.

Returns:

exception.

getStateDescription

public String getStateDescription()

Get module state description.

Returns:

module state description.

getName

public String getName()

Get name of module.

Returns:

module name.

getRuleVersion

public String getRuleVersion()

Get rule version information.

Returns:

rule version.

getUrl

public URL getUrl()

Get original URL of module.

Returns:

URL of module.

isLoaded

public boolean isLoaded()

Is this module already loaded?

Returns:

Is this module already loaded?

setLoaded

public void setLoaded(QedeqBo module)

Set checked and loaded state and module.

Parameters:

module - checked and loaded module.

getModule

public QedeqBo getModule()

Get module. Works only if module is already completely loaded.

Returns:

QEDEQ module if it is already loaded.