net.sf.basedb.core.plugin
Interface About

All Known Implementing Classes:

AboutBean, AboutImpl, Registry.RegisteredAbout

public interface About

Get information, such as the name, version and authors, about a plugin.

Version:

2.0

Author:

Nicklas

See Also:

Plugin, AboutImpl

Field Summary

static int

MAX_INFORMATION_LENGTH The maximum length of the strings returned by the methods in this interface that can be stored in the database.

Method Summary

String	getContact() Contact information to get more information about the plugin.
String	getCopyright() A copyright notice.
String	getDescription() A description of the plugin and what it does.
String	getEmail() An email adress to get more information about the plugin.
String	getMaxBaseVersion() Get the maximum BASE version were to plug-in no longer is expected to work.
String	getMinBaseVersion() Get the minimum BASE version that the plug-in requires.
String	getName() The name of the plugin.
String	getUrl() An URL to get more information about the plugin.
String	getVersion() The version of the plugin software.

Field Detail

MAX_INFORMATION_LENGTH

static final int MAX_INFORMATION_LENGTH

The maximum length of the strings returned by the methods in this interface that can be stored in the database.

See Also:

Constant Field Values

Method Detail

getName

String getName()

The name of the plugin. Mustn't return null.

getVersion

String getVersion()

The version of the plugin software. May return null.

getMinBaseVersion

String getMinBaseVersion()

Get the minimum BASE version that the plug-in requires. The returned value should be 2 or 3 numbers separated by a dot (eg. 3.0, 3.1.2, etc). A null return value indicates that the plug-in works with all BASE versions.

Returns:

A string or null

Since:

3.0

getMaxBaseVersion

String getMaxBaseVersion()

Get the maximum BASE version were to plug-in no longer is expected to work. The returned value should be 2 or 3 numbers separated by a dot (eg. 3.0, 3.1.2, etc). A null return value indicates that the plug-in works with all BASE versions.

Returns:

A string or null

Since:

3.0

getDescription

String getDescription()

A description of the plugin and what it does. May return null.

getCopyright

String getCopyright()

A copyright notice. May return null.

getContact

String getContact()

Contact information to get more information about the plugin. May return null.

getEmail

String getEmail()

An email adress to get more information about the plugin. May return null.

getUrl

String getUrl()

An URL to get more information about the plugin. May return null.