Package com.funnelback.plugin.details

Interface PluginDetails

All Superinterfaces:

PluginDetailsBase

All Known Subinterfaces:

PluginUtilsBase

public interface PluginDetails
extends PluginDetailsBase

Field Summary

Fields inherited from interface com.funnelback.plugin.details.model.PluginDetailsBase

PLUGIN_CONFIG_QUALIFIER, PLUGIN_ENCRYPTED_QUALIFIER, PLUGIN_PREFIX

Method Summary

Modifier and Type	Method	Description
List<PluginConfigFile>	getConfigFiles()	Define a list of all plugin configuration files to display in plugin configuration admin UI and in auto-generated documentation
List<PluginConfigKeyDetails>	getConfigKeys()	Define a list of all plugin configuration keys to display in plugin configuration admin UI and in auto-generated documentation
String	getFilterClass()	Define fully-qualified class name of filter to display in plugin configuration admin UI and in auto-generated documentation
String	getJsoupFilterClass()	Define fully-qualified class name of jsoup filter to display in plugin configuration admin UI and in auto-generated documentation
List<ProductSubtopicCategory>	getMetadataTags()	Define a list of metadata tags describing purpose of plugin See ProductSubtopic
String	getPluginDescription()	Define plugin short description or summary with purpose of usage to display in plugin configuration admin UI and in auto-generated documentation
String	getPluginName()	Define human-readable plugin name to display in plugin configuration admin UI and in auto-generated documentation
List<PluginTarget>	getPluginTarget()	Define target for which plugin is executed and source meta tag "plugin-scope" in auto-generated documentation

Methods inherited from interface com.funnelback.plugin.details.model.PluginDetailsBase

getKeyPrefix, getPluginId

Method Detail

getPluginName

String getPluginName()

Define human-readable plugin name to display in plugin configuration admin UI and in auto-generated documentation

getPluginDescription

String getPluginDescription()

Define plugin short description or summary with purpose of usage to display in plugin configuration admin UI and in auto-generated documentation

getPluginTarget

List<PluginTarget> getPluginTarget()

Define target for which plugin is executed and source meta tag "plugin-scope" in auto-generated documentation

getMetadataTags

List<ProductSubtopicCategory> getMetadataTags()

Define a list of metadata tags describing purpose of plugin See ProductSubtopic

getConfigKeys

List<PluginConfigKeyDetails> getConfigKeys()

Define a list of all plugin configuration keys to display in plugin configuration admin UI and in auto-generated documentation

getConfigFiles

List<PluginConfigFile> getConfigFiles()

Define a list of all plugin configuration files to display in plugin configuration admin UI and in auto-generated documentation

getFilterClass

String getFilterClass()

Define fully-qualified class name of filter to display in plugin configuration admin UI and in auto-generated documentation

getJsoupFilterClass

String getJsoupFilterClass()

Define fully-qualified class name of jsoup filter to display in plugin configuration admin UI and in auto-generated documentation