Package de.xima.fc.formstore

Class StoreFormPluginInfo

java.lang.Object

de.xima.fc.formstore.StoreFormPluginInfo

All Implemented Interfaces:

Serializable

public class StoreFormPluginInfo
extends Object
implements Serializable

Model that describes a plugin requires by a form store project file. See StoreFormMeta.getRequiredPlugins().

Since:

7.1.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
StoreFormPluginInfo()

Method Summary

Modifier and Type	Method	Description
String	getFileName()
String	getImplementationTitle()
String	getTechnicalName()
void	setFileName(String fileName)
void	setImplementationTitle(String implementationTitle)
void	setTechnicalName(String technicalName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StoreFormPluginInfo

public StoreFormPluginInfo()

Method Detail

getFileName

public String getFileName()

Returns:

Custom file name of the plugin, without the extension, e.g. plugin-bundle-catalog-client. There are a few plugins that do not have an Implementation-Title defined in their MANIFEST.MF. In these cases, this file name can be used for fuzzy matching when checking whether the plugin is installed. May be an empty string (or null) when an Implementation-Title exists.

setFileName

public void setFileName(String fileName)

Parameters:

fileName - Custom file name of the plugin, without the extension, e.g. plugin-bundle-catalog-client. There are a few plugins that do not have an Implementation-Title defined in their MANIFEST.MF. In these cases, this file name can be used for fuzzy matching when checking whether the plugin is installed. May be an empty string (or null) when an Implementation-Title exists.

getImplementationTitle

public String getImplementationTitle()

Returns:

The Implementation-Title property of the plugin's MANIFEST.MF Note that while usually a plugin should contain an implementation title, this is not required. The file name can be used as a fallback.

setImplementationTitle

public void setImplementationTitle(String implementationTitle)

Parameters:

implementationTitle - The Implementation-Title property of the plugin's MANIFEST.MF Note that while usually a plugin should contain an implementation title, this is not required. The file name can be used as a fallback.

getTechnicalName

public String getTechnicalName()

Returns:

Technical name of the plugin. When a plugin is missing, this name is displayed to the user to inform them about which plugin they should install.

setTechnicalName

public void setTechnicalName(String technicalName)

Parameters:

technicalName - Technical name of the plugin. When a plugin is missing, this name is displayed to the user to inform them about which plugin they should install.