ch.tatool.data

Interface Module

All Superinterfaces:

DataContainer

public interface Module
extends DataContainer

Interface for a Module.

Author:

Michael Ruflin

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Module.Info Module information object interface.

Nested classes/interfaces inherited from interface ch.tatool.data.DataContainer

DataContainer.Entry

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_EXECUTION_DEFAULT_PAUSE_DURATION Default pause time between elements.
static String	PROPERTY_MODULE_AUTHOR Property key of the module author property.
static String	PROPERTY_MODULE_DESCRIPTION Property key of the module description property.
static String	PROPERTY_MODULE_EXECUTION_DISPLAY_CLASS Property used to define the execution view class.
static String	PROPERTY_MODULE_EXECUTION_INITIALIZER_CLASS Property used to define the execution configurer class.
static String	PROPERTY_MODULE_INFO_BASE Property used to define the module info base path.
static String	PROPERTY_MODULE_INFO_PAGE Property used to define the module info start page.
static String	PROPERTY_MODULE_INFO_PROVIDER_CLASS Property used to define the module info provider.
static String	PROPERTY_MODULE_NAME Property key of the module name property.
static String	PROPERTY_MODULE_SCHEDULER_CLASS Property used to define the scheduler class for a module.
static String	PROPERTY_MODULE_VERSION Property key of the module version property.
static String	PROPERTY_TATOOL_ONLINE_GROUP_NR
static String	PROPERTY_TATOOL_ONLINE_MODULE_NR
static String	PROPERTY_TATOOL_ONLINE_STUDY_ID
static String	PROPERTY_TATOOL_ONLINE_SUBJECT_CODE Property keys for tatool online.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getBinaryModuleProperty(String propertyName) Get a large value from the module.
ExecutorInitializer	getExecutorInitializer() Get the initializer for this module.
Long	getId() Gets the ID of the module.
Messages	getMessages()
DataExporter	getModuleExporter(String exporterKey)
Map<String,DataExporter>	getModuleExporters()
Map<String,String>	getModuleProperties() Get the module properties.
ModuleScheduler	getModuleScheduler() Get the scheduler for this module.
String	getName() Gets the name of the module.
UserAccount	getUserAccount() Get the account this module is part of
void	putBinaryModuleProperty(String propertyName, byte[] propertyValue) Set a large property value.
void	setExecutorInitializer(ExecutorInitializer configurer)
void	setMessages(Messages messages)
void	setModuleScheduler(ModuleScheduler scheduler)

Methods inherited from interface ch.tatool.data.DataContainer

containsValue, getEntries, getValue, putValue

Field Detail

PROPERTY_MODULE_NAME

static final String PROPERTY_MODULE_NAME

Property key of the module name property.

See Also:

Constant Field Values

PROPERTY_MODULE_DESCRIPTION

static final String PROPERTY_MODULE_DESCRIPTION

Property key of the module description property.

See Also:

Constant Field Values

PROPERTY_MODULE_AUTHOR

static final String PROPERTY_MODULE_AUTHOR

Property key of the module author property.

See Also:

Constant Field Values

PROPERTY_MODULE_VERSION

static final String PROPERTY_MODULE_VERSION

Property key of the module version property.

See Also:

Constant Field Values

PROPERTY_TATOOL_ONLINE_SUBJECT_CODE

static final String PROPERTY_TATOOL_ONLINE_SUBJECT_CODE

Property keys for tatool online.

See Also:

Constant Field Values

PROPERTY_TATOOL_ONLINE_STUDY_ID

static final String PROPERTY_TATOOL_ONLINE_STUDY_ID

See Also:

Constant Field Values

PROPERTY_TATOOL_ONLINE_MODULE_NR

static final String PROPERTY_TATOOL_ONLINE_MODULE_NR

See Also:

Constant Field Values

PROPERTY_TATOOL_ONLINE_GROUP_NR

static final String PROPERTY_TATOOL_ONLINE_GROUP_NR

See Also:

Constant Field Values

PROPERTY_EXECUTION_DEFAULT_PAUSE_DURATION

static final String PROPERTY_EXECUTION_DEFAULT_PAUSE_DURATION

Default pause time between elements.

See Also:

Constant Field Values

PROPERTY_MODULE_SCHEDULER_CLASS

static final String PROPERTY_MODULE_SCHEDULER_CLASS

Property used to define the scheduler class for a module.

See Also:

Constant Field Values

PROPERTY_MODULE_EXECUTION_INITIALIZER_CLASS

static final String PROPERTY_MODULE_EXECUTION_INITIALIZER_CLASS

Property used to define the execution configurer class.

See Also:

Constant Field Values

PROPERTY_MODULE_EXECUTION_DISPLAY_CLASS

static final String PROPERTY_MODULE_EXECUTION_DISPLAY_CLASS

Property used to define the execution view class.

See Also:

Constant Field Values

PROPERTY_MODULE_INFO_PROVIDER_CLASS

static final String PROPERTY_MODULE_INFO_PROVIDER_CLASS

Property used to define the module info provider.

See Also:

Constant Field Values

PROPERTY_MODULE_INFO_BASE

static final String PROPERTY_MODULE_INFO_BASE

Property used to define the module info base path.

See Also:

Constant Field Values

PROPERTY_MODULE_INFO_PAGE

static final String PROPERTY_MODULE_INFO_PAGE

Property used to define the module info start page.

See Also:

Constant Field Values

Method Detail

getId

Long getId()

Gets the ID of the module.

Returns:

the ID of the module

getName

String getName()

Gets the name of the module.

Returns:

the name of the module

getUserAccount

UserAccount getUserAccount()

Get the account this module is part of

getModuleScheduler

ModuleScheduler getModuleScheduler()

Get the scheduler for this module.

setModuleScheduler

void setModuleScheduler(ModuleScheduler scheduler)

getExecutorInitializer

ExecutorInitializer getExecutorInitializer()

Get the initializer for this module.

setExecutorInitializer

void setExecutorInitializer(ExecutorInitializer configurer)

getModuleProperties

Map<String,String> getModuleProperties()

Get the module properties.

getBinaryModuleProperty

byte[] getBinaryModuleProperty(String propertyName)

Get a large value from the module. This is implemented as BLOBs behind the scene, but the implementation might hold all values in memory. Use therefore with consideration...

putBinaryModuleProperty

void putBinaryModuleProperty(String propertyName,
                           byte[] propertyValue)

Set a large property value.

getModuleExporters

Map<String,DataExporter> getModuleExporters()

getModuleExporter

DataExporter getModuleExporter(String exporterKey)

setMessages

void setMessages(Messages messages)

getMessages

Messages getMessages()