rocks.coffeenet.frontpage.plugin.api

Interface FrontpagePlugin

All Superinterfaces:

org.springframework.plugin.core.Plugin<FrontpagePluginQualifier>

public interface FrontpagePlugin
extends org.springframework.plugin.core.Plugin<FrontpagePluginQualifier>

Plugin Interface for CoffeeNet Frontpage.

All CoffeeNet Frontpage plugins have to implement following interface for rendering a view for their plugin.

Method Summary

Modifier and Type	Method and Description
String	content(ConfigurationInstance configurationInstance) This methods provides all content information for the view of the plugin.
Optional<ConfigurationDescription>	getConfigurationDescription() Provides the configuration description to render the plugin configuration.
String	id() This methods provides a unique plugin id
default boolean	supports(FrontpagePluginQualifier delimiter)
String	title(ConfigurationInstance configurationInstance) This methods provides title of the view of the plugin.

Method Detail

title

String title(ConfigurationInstance configurationInstance)

This methods provides title of the view of the plugin.

Parameters:

configurationInstance - provides the personalised configuration

Returns:

title as String

content

String content(ConfigurationInstance configurationInstance)

This methods provides all content information for the view of the plugin.

Parameters:

configurationInstance - provides the personalised configuration

Returns:

Plugin Content Information

id

String id()

This methods provides a unique plugin id

Returns:

a unique plugin id

getConfigurationDescription

Optional<ConfigurationDescription> getConfigurationDescription()

Provides the configuration description to render the plugin configuration.

Returns:

the configuration description

supports

default boolean supports(FrontpagePluginQualifier delimiter)

Specified by:

supports in interface org.springframework.plugin.core.Plugin<FrontpagePluginQualifier>