org.qedeq.kernel.bo.common
Interface QedeqBo

All Known Subinterfaces:

KernelQedeqBo

All Known Implementing Classes:

DefaultKernelQedeqBo

public interface QedeqBo

Represents a module and its states.

Author:

Michael Meyling

Method Summary

Service	getCurrentlyRunningService() Get currently running service.
AbstractState	getCurrentState() Get the current state of the module.
DependencyState	getDependencyState() Get module dependency state.
SourceFileExceptionList	getErrors() Get error list.
FormallyProvedState	getFormallyProvedState() Get module logical formally proved state.
AbstractState	getLastSuccessfulState() Get the last successful state of the module.
int	getLoadingCompleteness() Set completeness percentage.
LoadingImportsState	getLoadingImportsState() Get module loading imports state.
LoadingState	getLoadingState() Get module loading state.
ModuleAddress	getModuleAddress() Get ModuleAddress of module.
java.lang.String	getName() Get name of module.
java.lang.String	getOriginalLanguage() Get default language for this QEDEQ module.
Qedeq	getQedeq() Get module.
ModuleReferenceList	getRequiredModules() Get labels and URLs of all referenced modules.
java.lang.String	getRuleVersion() Get rule version information.
java.lang.String	getStateDescription() Get module state description.
java.lang.String[]	getSupportedLanguages() Get all supported languages for this QEDEQ module.
java.lang.String	getUrl() Get original URL of module.
SourceFileExceptionList	getWarnings() Get warning list.
WellFormedState	getWellFormedState() Get module logical well formed state.
boolean	hasBasicFailures() Has the module any basic failures? This includes errors during loading the module, during load of imported modules and logical checking.
boolean	hasErrors() Is this a error state the module is in?
boolean	hasLoadedImports() Are all directly imported modules loaded?
boolean	hasLoadedRequiredModules() Are all required modules loaded?
boolean	hasWarnings() Is this a warning state the module is in?
boolean	isFullyFormallyProved() Was the module successfully checked for being fully formal correct proved?
boolean	isLoaded() Is this module already loaded?
boolean	isSupportedLanguage(java.lang.String language) Is the given language supported.
boolean	isWellFormed() Was the module successfully checked for being well formed?

Method Detail

hasBasicFailures

boolean hasBasicFailures()

Has the module any basic failures? This includes errors during loading the module, during load of imported modules and logical checking. This includes no plugin errors.

Returns:

wWre there any basic errors?

hasErrors

boolean hasErrors()

Is this a error state the module is in?

Returns:

Were there any errors?

hasWarnings

boolean hasWarnings()

Is this a warning state the module is in?

Returns:

Were there any warnings?

getModuleAddress

ModuleAddress getModuleAddress()

Get ModuleAddress of module.

Returns:

Address of module.

getLastSuccessfulState

AbstractState getLastSuccessfulState()

Get the last successful state of the module.

Returns:

Last successful module state.

getCurrentState

AbstractState getCurrentState()

Get the current state of the module.

Returns:

Current module state.

getCurrentlyRunningService

Service getCurrentlyRunningService()

Get currently running service.

Returns:

Currently running service. Might be null.

getLoadingState

LoadingState getLoadingState()

Get module loading state.

Returns:

Module state.

getLoadingCompleteness

int getLoadingCompleteness()

Set completeness percentage.

Returns:

completeness Completeness of loading into memory in percent.

getLoadingImportsState

LoadingImportsState getLoadingImportsState()

Get module loading imports state.

Returns:

module state.

getDependencyState

DependencyState getDependencyState()

Get module dependency state.

Returns:

module state.

getWellFormedState

WellFormedState getWellFormedState()

Get module logical well formed state.

Returns:

module state.

getFormallyProvedState

FormallyProvedState getFormallyProvedState()

Get module logical formally proved state.

Returns:

module state.

getErrors

SourceFileExceptionList getErrors()

Get error list.

Returns:

Error list.

getWarnings

SourceFileExceptionList getWarnings()

Get warning list.

Returns:

Warning list.

getStateDescription

java.lang.String getStateDescription()

Get module state description.

Returns:

module state description.

getName

java.lang.String getName()

Get name of module.

Returns:

module name.

getRuleVersion

java.lang.String getRuleVersion()

Get rule version information.

Returns:

rule version.

getUrl

java.lang.String getUrl()

Get original URL of module.

Returns:

URL of module.

isLoaded

boolean isLoaded()

Is this module already loaded?

Returns:

Is this module already loaded?

getQedeq

Qedeq getQedeq()

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

Returns:

QEDEQ module if it is already loaded.

hasLoadedImports

boolean hasLoadedImports()

Are all directly imported modules loaded?

Returns:

Are all directly imported modules loaded?

hasLoadedRequiredModules

boolean hasLoadedRequiredModules()

Are all required modules loaded?

Returns:

Are all required modules loaded?

getRequiredModules

ModuleReferenceList getRequiredModules()

Get labels and URLs of all referenced modules. Only available if module has loaded all required modules. Otherwise a runtime exception is thrown.

Returns:

URLs of all referenced modules.

Throws:

java.lang.IllegalStateException - Module not yet loaded.

isWellFormed

boolean isWellFormed()

Was the module successfully checked for being well formed?

Returns:

Module was checked?

isFullyFormallyProved

boolean isFullyFormallyProved()

Was the module successfully checked for being fully formal correct proved?

Returns:

Module was checked?

getSupportedLanguages

java.lang.String[] getSupportedLanguages()

Get all supported languages for this QEDEQ module.

Returns:

Array of supported languages.

isSupportedLanguage

boolean isSupportedLanguage(java.lang.String language)

Is the given language supported.

Parameters:

language - Language.

Returns:

Is this language supported?

getOriginalLanguage

java.lang.String getOriginalLanguage()

Get default language for this QEDEQ module. This should be the original language of the module before it was translated. This value should be also within getSupportedLanguages().

Returns:

Original language.