Package de.xima.fc.prompt.plugin

Interface IPluginPromptService

All Superinterfaces:

IFCPlugin, INamedUiElement, INameProviding, ITransferable, Serializable

public interface IPluginPromptService
extends IFCPlugin

A plugin that lets you add a new prompt services to formcycle. This plugin simply requires you to provide the handler implementation that implements the logic for the prompt service, see IPromptServiceHandler for more details.

Since:

8.5.0

Field Summary

Fields inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

CONFIG_FILENAME

Fields inherited from interface de.xima.fc.interfaces.INamedUiElement

ATTR_DISPLAY_NAME

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding

ATTR_NAME, COL_NAME

Method Summary

Modifier and Type	Method	Description
default IPluginGenericCustomGUI<? extends IPluginPromptConnectionBean>	getPromptConnectionCustomGUI()	Gets the custom GUI for managing prompt connections.The default implementation just delegates to the XHTML and main bean class of the IPromptServiceHandler.
default IPluginGenericCustomGUI<? extends IPluginPromptQueryBean>	getPromptQueryCustomGUI()	Gets the custom GUI for managing prompt queries.
IPromptServiceHandler<?,?>	getPromptServiceHandler()	Gets the prompt service implementation that this plugin provides.

Methods inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

getDescription, getDescription, getDisplayName, getName, initialize, initPlugin, install, shutdown, shutdown, uninstall, validateConfigurationData

Method Detail

getPromptConnectionCustomGUI

default IPluginGenericCustomGUI<? extends IPluginPromptConnectionBean> getPromptConnectionCustomGUI()

Gets the custom GUI for managing prompt connections.The default implementation just delegates to the XHTML and main bean class of the IPromptServiceHandler.

If your plugin requires additional GUI beans, you should override this method and declare the additional bean classes. Consider using new DefaultPromptConnectionCustomGUI(plugin, beans).

Returns:

The custom GUI for prompt connections.

See Also:

DefaultPromptConnectionCustomGUI

getPromptQueryCustomGUI

default IPluginGenericCustomGUI<? extends IPluginPromptQueryBean> getPromptQueryCustomGUI()

Gets the custom GUI for managing prompt queries. The default implementation just delegates to the XHTML and main bean class of the IPromptServiceHandler.

If your plugin requires additional GUI beans, you should override this method and declare the additional bean classes. Consider using new DefaultPromptQueryCustomGUI(plugin, beans).

Returns:

The custom GUI for prompt queries.

See Also:

DefaultPromptQueryCustomGUI

getPromptServiceHandler

IPromptServiceHandler<?,?> getPromptServiceHandler()

Gets the prompt service implementation that this plugin provides. See IPromptServiceHandler for more details on how to implement a prompt service handler.

Returns:

The prompt service implementation.