org.proteios.core.data

Class PluginTypeData

java.lang.Object

org.proteios.core.data.BasicData

org.proteios.core.data.PluginTypeData

All Implemented Interfaces:

IdentifiableData, NameableData, RemovableData

public class PluginTypeData
extends BasicData
implements NameableData, RemovableData

This class represent an interface that a plugin can implement.

Version:

2.0

Author:

Nicklas

See Also:

PluginType, Plugins

Last modified

$Date: 2009-04-09 08:48:11 +0200 (Thu, 09 Apr 2009) $

Hibernate: class

table="`PluginTypes`" lazy="false"

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_INTERFACENAME_LENGTH The maximum length of the interface name that can be stored in the database.
static int	MAX_JARPATH_LENGTH

Fields inherited from interface org.proteios.core.data.NameableData

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH

Constructor Summary

Constructors

Constructor and Description
PluginTypeData()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Get the description for the item.
String	getInterfaceName() Get the interface name a plugin must implement to be of this type.
String	getJarPath() Get the path to the JAR file where the interface class is located.
String	getName() Get the name of the item.
boolean	isRemoved() Check if the removed flag is set for this item.
void	setDescription(String description) Set the description for the item.
void	setInterfaceName(String interfaceName)
void	setJarPath(String jarPath)
void	setName(String name) Set the name of the item.
void	setRemoved(boolean removed) Set the removed flag for this item.

Methods inherited from class org.proteios.core.data.BasicData

equals, getId, getVersion, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.proteios.core.data.IdentifiableData

getId, getVersion

Field Detail

MAX_INTERFACENAME_LENGTH

public static final int MAX_INTERFACENAME_LENGTH

The maximum length of the interface name that can be stored in the database.

See Also:

Constant Field Values

MAX_JARPATH_LENGTH

public static final int MAX_JARPATH_LENGTH

See Also:

Constant Field Values

Constructor Detail

PluginTypeData

public PluginTypeData()

Method Detail

getName

public String getName()

Description copied from interface: NameableData

Get the name of the item.

Specified by:

getName in interface NameableData

Returns:

A String with the name of the item

setName

public void setName(String name)

Description copied from interface: NameableData

Set the name of the item. The name cannot be null and mustn't be longer than the value specified by the MAX_NAME_LENGTH constant.

Specified by:

setName in interface NameableData

Parameters:

name - The new name for the item

getDescription

public String getDescription()

Description copied from interface: NameableData

Get the description for the item.

Specified by:

getDescription in interface NameableData

Returns:

A String with a description of the item

setDescription

public void setDescription(String description)

Description copied from interface: NameableData

Set the description for the item. The description can be null but mustn't be longer than the value specified by the MAX_DESCRIPTION_LENGTH constant.

Specified by:

setDescription in interface NameableData

Parameters:

description - The new description for the item

isRemoved

public boolean isRemoved()

Description copied from interface: RemovableData

Check if the removed flag is set for this item.

Specified by:

isRemoved in interface RemovableData

Returns:

TRUE if the item is flagged as removed, FALSE otherwise

setRemoved

public void setRemoved(boolean removed)

Description copied from interface: RemovableData

Set the removed flag for this item.

Specified by:

setRemoved in interface RemovableData

Parameters:

removed - TRUE if the item should be flagged as removed, FALSE otherwise

getInterfaceName

public String getInterfaceName()

Get the interface name a plugin must implement to be of this type. The specified interface must extend the Plugin interface.

Hibernate: property

column="`interface_name`" type="string" length="255" not-null="true" unique="true"

setInterfaceName

public void setInterfaceName(String interfaceName)

getJarPath

public String getJarPath()

Get the path to the JAR file where the interface class is located. If the value is null the interface must be in the classpath.

Hibernate: property

column="`jar_path`" type="text" not-null="false"

setJarPath

public void setJarPath(String jarPath)