Uses of Interface
de.xima.fc.plugin.interfaces.IFCPlugin

Packages that use IFCPlugin

Package	Description
de.xima.fc.api.system	Package for API access to system configuration.
de.xima.fc.gui.bean.plugingui
de.xima.fc.handler.interfaces.system
de.xima.fc.handler.system
de.xima.fc.plugin
de.xima.fc.plugin.abstracts
de.xima.fc.plugin.comperator
de.xima.fc.plugin.config
de.xima.fc.plugin.entities
de.xima.fc.plugin.enums
de.xima.fc.plugin.interfaces
de.xima.fc.plugin.interfaces.auth
de.xima.fc.plugin.interfaces.backend
de.xima.fc.plugin.interfaces.form
de.xima.fc.plugin.interfaces.generic
de.xima.fc.plugin.interfaces.mail
de.xima.fc.plugin.interfaces.monitoring
de.xima.fc.plugin.interfaces.portal
de.xima.fc.plugin.interfaces.project
de.xima.fc.plugin.interfaces.replacer
de.xima.fc.plugin.interfaces.servlet
de.xima.fc.plugin.interfaces.user
de.xima.fc.plugin.interfaces.validation
de.xima.fc.plugin.interfaces.workflow
de.xima.fc.plugin.lifecycle
de.xima.fc.plugin.runtime

Uses of IFCPlugin in de.xima.fc.api.system

Method parameters in de.xima.fc.api.system with type arguments of type IFCPlugin

Modifier and Type	Method and Description
Map<EPluginScope,Set<String>>	PluginAPI.getPluginNameMap(UserContext uc, Mandant client, Class<? extends IFCPlugin> type) Deprecated.
Set<String>	PluginAPI.getPluginNames(UserContext uc, Mandant client, Class<? extends IFCPlugin> type) Method for determining plugin names.

Uses of IFCPlugin in de.xima.fc.gui.bean.plugingui

Classes in de.xima.fc.gui.bean.plugingui with type parameters of type IFCPlugin

Modifier and Type

Class and Description

class

PluginBeanHelper<TBean extends IPluginGenericCustomGUIBean,TPlugin extends IFCPlugin & IPluginGenericCustomGUI<TBean>> Helper class for handling unmanaged beans used by user interfaces provided by a plugin, eg. a dashboard plugin or a workflow action plugin: PluginBeanHelper.forCurrentViewScope(plugin, client).getOrCreateBeans(); Each helper is associated to a certain scope (request, view, session, or application scope).

Methods in de.xima.fc.gui.bean.plugingui with type parameters of type IFCPlugin

Modifier and Type	Method and Description
static <TBean extends IPluginGenericCustomGUIBean,TPlugin extends IFCPlugin & IPluginGenericCustomGUI<TBean>> PluginBeanHelper<TBean,TPlugin>	PluginBeanHelper.forCurrentApplicationScope(TPlugin plugin, Mandant client, PluginBeanOptions pluginBeanOptions) A new helper for application scoped beans of the given plugin.
static <TBean extends IPluginGenericCustomGUIBean,TPlugin extends IFCPlugin & IPluginGenericCustomGUI<TBean>> PluginBeanHelper<TBean,TPlugin>	PluginBeanHelper.forCurrentRequestScope(TPlugin plugin, Mandant client, PluginBeanOptions pluginBeanOptions) A new helper for application request beans of the given plugin.
static <TBean extends IPluginGenericCustomGUIBean,TPlugin extends IFCPlugin & IPluginGenericCustomGUI<TBean>> PluginBeanHelper<TBean,TPlugin>	PluginBeanHelper.forCurrentSessionScope(TPlugin plugin, Mandant client, PluginBeanOptions pluginBeanOptions) A new helper for session scoped beans of the given plugin.
static <TBean extends IPluginGenericCustomGUIBean,TPlugin extends IFCPlugin & IPluginGenericCustomGUI<TBean>> PluginBeanHelper<TBean,TPlugin>	PluginBeanHelper.forCurrentViewScope(TPlugin plugin, Mandant client, PluginBeanOptions pluginBeanOptions) A new helper for view scoped beans of the given plugin.

Uses of IFCPlugin in de.xima.fc.handler.interfaces.system

Method parameters in de.xima.fc.handler.interfaces.system with type arguments of type IFCPlugin

Modifier and Type	Method and Description
Map<EPluginScope,Set<String>>	IPluginHandler.getPluginNameMap(UserContext uc, Mandant mandant, Class<? extends IFCPlugin> type)
Set<String>	IPluginHandler.getPluginNames(UserContext uc, Mandant mandant, Class<? extends IFCPlugin> type)

Uses of IFCPlugin in de.xima.fc.handler.system

Method parameters in de.xima.fc.handler.system with type arguments of type IFCPlugin

Modifier and Type	Method and Description
Map<EPluginScope,Set<String>>	PluginHandler.getPluginNameMap(UserContext uc, Mandant mandant, Class<? extends IFCPlugin> type)
Set<String>	PluginHandler.getPluginNames(UserContext uc, Mandant mandant, Class<? extends IFCPlugin> type)

Uses of IFCPlugin in de.xima.fc.plugin

Methods in de.xima.fc.plugin with type parameters of type IFCPlugin

Modifier and Type	Method and Description
static <T extends IFCPlugin> Set<T>	PluginManager.getAllPlugins(Mandant man, Class<T> clazz) Get a set of plugins with the given interface registered in system-scope OR to the given client.
static <T extends IFCPlugin> Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime,T>>	PluginManager.getAllPluginsWithRuntime(Mandant man, Class<T> clazz)
static <T extends IFCPlugin> Set<T>	PluginManager.getClientPlugins(Mandant man, Class<T> clazz) Get a set of plugins with the given interfaces registered to the given client
static <T extends IFCPlugin> Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime,T>>	PluginManager.getClientPluginsWithRuntime(Mandant man, Class<T> clazz)
static <T extends IFCPlugin> T	PluginManager.getPluginByName(Mandant man, Class<T> clazz, String pluginName) Get a plugin by name and IFCPlugin-interface from client- and system-scope
static <T extends IFCPlugin> org.apache.commons.lang3.tuple.Pair<PluginRuntime,T>	PluginManager.getPluginByNameWithRuntime(Mandant man, Class<T> clazz, String pluginName)
static <T extends IFCPlugin> Map<EPluginScope,Set<String>>	PluginManager.getPluginNameMap(Mandant mandant, Class<T> clazz) Deprecated.
static <T extends IFCPlugin> Set<String>	PluginManager.getPluginNames(Mandant mandant, Class<T> clazz) Get a set of all plugin-names with the given IFCPlugin-interface and Mandant
static <T extends IFCPlugin> Set<T>	PluginManager.getRegisteredPlugins(Class<T> clazz) Get an set with all registered plugins of the given IFCPlugin-interface
static <T extends IFCPlugin> T	PluginManager.getSystemPluginByName(Class<T> clazz, String pluginName) Get a system-plugin by name, IFCPlugin-interface
static <T extends IFCPlugin> Set<T>	PluginManager.getSystemPlugins(Class<T> clazz) Get a set of plugins with the given interfaces registered in system-scope
static <T extends IFCPlugin> Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime,T>>	PluginManager.getSystemPluginsWithRuntime(Class<T> clazz)
static <T extends IFCPlugin> void	PluginManager.registerClientPlugin(Mandant man, Class<T> clazz, String runtimeKey) Method to register a plugin-class in scope of the given client
static <T extends IFCPlugin> T	PluginHelper.registerPlugin(boolean install, boolean initialize, PluginRuntime prtm, Class<T> clazz)
static <T extends IFCPlugin> void	PluginManager.registerPlugin(boolean isInstall, PluginRuntime prtm, Class<T> clazz) Register a plugin to the given key and PluginRuntime
static <T extends IFCPlugin> void	PluginManager.registerPlugin(PluginRuntime prtm, Class<T> clazz)

Methods in de.xima.fc.plugin that return IFCPlugin

Modifier and Type	Method and Description
static IFCPlugin	PluginManager.getMandantPluginByName(Mandant man, EPluginTypes type, String pluginName) Deprecated. will be removed!
static IFCPlugin	PluginManager.getPluginByName(Mandant man, EPluginTypes type, String pluginName) Deprecated. user PluginManager.getPluginByName(Mandant, Class, String)
static IFCPlugin	PluginManager.getSystemPluginByName(EPluginTypes type, String pluginName) Deprecated. user PluginManager.getSystemPluginByName(Class, String)

Methods in de.xima.fc.plugin that return types with arguments of type IFCPlugin

Modifier and Type	Method and Description
static Set<IFCPlugin>	PluginManager.getAllPlugins(Mandant man, EPluginTypes type) Deprecated. user PluginManager.getAllPlugins(Mandant, Class)
static List<? extends Class<? extends IFCPlugin>>	PluginHelper.getAllPlugins(PluginRuntime pluginRuntime)
static List<? extends Class<? extends IFCPlugin>>	PluginHelper.getAllPlugins(org.reflections.Reflections reflect)
static SortedSet<IFCPlugin>	PluginManager.getMandantPlugins(Mandant man, EPluginTypes type) Deprecated. will be removed!
static SortedSet<IFCPlugin>	PluginManager.getSystemPlugins(EPluginTypes type) Deprecated. use PluginManager.getSystemPlugins(Class)

Methods in de.xima.fc.plugin with parameters of type IFCPlugin

Modifier and Type	Method and Description
static String	PluginHelper.getDisplayName(IFCPlugin plugin, Locale locale) Returns the display name of the plugin if it is not null.

Method parameters in de.xima.fc.plugin with type arguments of type IFCPlugin

Modifier and Type	Method and Description
static void	PluginManager.registerMandantPlugin(Mandant man, EPluginTypes typ, Class<? extends IFCPlugin> clazz) Deprecated. use PluginManager.registerClientPlugin(Mandant, Class, String)
static void	PluginManager.registerSystemPlugin(Class<? extends IFCPlugin> clazz, String runtimeKey) Method to register a plugin-class in system-scope
static void	PluginManager.registerSystemPlugin(EPluginTypes typ, Class<? extends IFCPlugin> clazz) Deprecated. use PluginManager.registerSystemPlugin(Class, String)

Uses of IFCPlugin in de.xima.fc.plugin.abstracts

Classes in de.xima.fc.plugin.abstracts that implement IFCPlugin

Modifier and Type	Class and Description
class	AFCPlugin Deprecated. class will be removed. Only use the interfaces and helper within the plugin-lifecycle-methods (install,uninstall,...)

Uses of IFCPlugin in de.xima.fc.plugin.comperator

Methods in de.xima.fc.plugin.comperator with parameters of type IFCPlugin

Modifier and Type	Method and Description
int	PluginNameComperator.compare(IFCPlugin o1, IFCPlugin o2)

Uses of IFCPlugin in de.xima.fc.plugin.config

Subinterfaces of IFCPlugin in de.xima.fc.plugin.config

Modifier and Type	Interface and Description
interface	IDescriptionProvidingPlugin Deprecated. Implement IFCPlugin instead and use getDescription(java.util.Locale).
interface	IPluginConfigParamList Interface for workflow action plugins (IPluginProcessing).
interface	IPluginCustomGUI Interface for a processing plugin with a custom user interface.
interface	IPluginShutdown Deprecated. Implement IFCPlugin-and use shutdown(de.xima.fc.interfaces.plugin.lifecycle.IPluginShutdownData) and uninstall(de.xima.fc.interfaces.plugin.lifecycle.IPluginUninstallData).

Uses of IFCPlugin in de.xima.fc.plugin.entities

Subinterfaces of IFCPlugin in de.xima.fc.plugin.entities

Modifier and Type	Interface and Description
interface	IPluginEntities Interface for an entities plugin.

Uses of IFCPlugin in de.xima.fc.plugin.enums

Methods in de.xima.fc.plugin.enums that return types with arguments of type IFCPlugin

Modifier and Type	Method and Description
Class<? extends IFCPlugin>	EPluginTypes.getPluginInterface() Deprecated. Getter für das Interfaze zu dem Plugin-Typ

Uses of IFCPlugin in de.xima.fc.plugin.interfaces

Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces

Modifier and Type	Interface and Description
interface	IFCRemoteSyncPlugin Markup interface for plugins which need to be synchronized with the frontend server.

Uses of IFCPlugin in de.xima.fc.plugin.interfaces.auth

Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.auth

Modifier and Type	Interface and Description
interface	IPluginAuthenticatorType Interface for custom authenticator types.

Uses of IFCPlugin in de.xima.fc.plugin.interfaces.backend

Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.backend

Modifier and Type	Interface and Description
interface	IPluginBackendTheme Interface for backend theme plugins.
interface	IPluginClientDashboard Interface for client dashboard plugins.
interface	IPluginMenuEntries Plugin for adding custom menu entries to the backend UI of FORMCYCLE.
interface	IPluginProjectMenu Plugin interface for providing custom menus for projects with a specified scope

Uses of IFCPlugin in de.xima.fc.plugin.interfaces.form

Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.form

Modifier and Type	Interface and Description
interface	IPluginDataSource Interface for a data source plugin.
interface	IPluginFormElementCatalogue Interface for plugins that may add a set of form items to the designer.
interface	IPluginFormElementWidget Interface for plugins to integrate own widgets within designer
interface	IPluginFormPrePersist Interface for form pre-persist plugins.
interface	IPluginFormPreProcess Interface for a form pre-process plugin.
interface	IPluginFormPreRender Interface for form pre-render plugins.
interface	IPluginFormPreRespond Interface for a form pre-respond plugin.
interface	IPluginFormPreview Interface für Plugins vom Typ FormPreview
interface	IPluginFormResource Interface for plugins to integrate form resources like CSS or JavaScript

Uses of IFCPlugin in de.xima.fc.plugin.interfaces.generic

Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.generic

Modifier and Type	Interface and Description
interface	IPluginGeneric Interface for a generic plugin.

Uses of IFCPlugin in de.xima.fc.plugin.interfaces.mail

Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.mail

Modifier and Type	Interface and Description
interface	IPluginMailEncryption Interface for plugins of type email encryption.

Uses of IFCPlugin in de.xima.fc.plugin.interfaces.monitoring

Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.monitoring

Modifier and Type	Interface and Description
interface	IPluginMonitor A plugin for checking the current status of the FORMCYCLE system via monitoring MBeans.

Uses of IFCPlugin in de.xima.fc.plugin.interfaces.portal

Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.portal

Modifier and Type	Interface and Description
interface	IPluginPortal Plugin for creating custom portals with own ui

Uses of IFCPlugin in de.xima.fc.plugin.interfaces.project

Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.project

Modifier and Type	Interface and Description
interface	IPluginProjectTemplate Interface for plugins of the typ project template.

Uses of IFCPlugin in de.xima.fc.plugin.interfaces.replacer

Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.replacer

Modifier and Type	Interface and Description
interface	IPluginFormReplacer Interface for a form replacer plugin.
interface	IPluginSessionReplacer Interface for a system replacer plugin.
interface	IPluginSystemReplacer Interface for a system replacer plugin.
interface	IPluginTemplateReplacer Interface for a template replacer plugin.

Uses of IFCPlugin in de.xima.fc.plugin.interfaces.servlet

Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.servlet

Modifier and Type	Interface and Description
interface	IPluginServletAction Interface for plugins servlet action plugins.

Uses of IFCPlugin in de.xima.fc.plugin.interfaces.user

Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.user

Modifier and Type	Interface and Description
interface	IPluginAccessProperties A plugin for adding custom IPluginAccessPropertys to the FORMCYCLE backend.

Uses of IFCPlugin in de.xima.fc.plugin.interfaces.validation

Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.validation

Modifier and Type	Interface and Description
interface	IPluginValidationRule Interface for validation rule plugins.

Uses of IFCPlugin in de.xima.fc.plugin.interfaces.workflow

Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.workflow

Modifier and Type	Interface and Description
interface	IPluginProcessing Interface for plugins of type processing.

Uses of IFCPlugin in de.xima.fc.plugin.lifecycle

Classes in de.xima.fc.plugin.lifecycle with type parameters of type IFCPlugin

Modifier and Type	Interface and Description
interface	IPluginLifecycleListener<TPlugin extends IFCPlugin> The callback method that is invoked when the event occurred for which the listener was registered.

Methods in de.xima.fc.plugin.lifecycle with type parameters of type IFCPlugin

Modifier and Type	Method and Description
static <TPlugin extends IFCPlugin> void	PluginLifecycleEventManager.deregisterListener(EPluginLifecycleEvent event, Class<TPlugin> pluginType, IPluginLifecycleListener<TPlugin> listener) Deregisters a listener for a plugin event and a certain plugin type.
static <TPlugin extends IFCPlugin> void	PluginLifecycleEventManager.registerListener(EPluginLifecycleEvent event, Class<TPlugin> pluginType, IPluginLifecycleListener<TPlugin> listener) Registers a listener for a plugin event.

Methods in de.xima.fc.plugin.lifecycle with parameters of type IFCPlugin

Modifier and Type	Method and Description
static void	PluginLifecycleEventManager.fireEvent(EPluginLifecycleEvent event, PluginRuntime pluginRuntime, IFCPlugin plugin) Calls all registered events listeners for the given event.

Method parameters in de.xima.fc.plugin.lifecycle with type arguments of type IFCPlugin

Modifier and Type	Method and Description
static void	PluginLifecycleEventManager.deregisterListeners(EPluginLifecycleEvent event, Class<? extends IFCPlugin> pluginType) Deregisters all listeners for a plugin event and a certain plugin type.

Uses of IFCPlugin in de.xima.fc.plugin.runtime

Methods in de.xima.fc.plugin.runtime with type parameters of type IFCPlugin

Modifier and Type	Method and Description
<T extends IFCPlugin> void	PluginRuntime.addPlugin(T plugin)
<T extends IFCPlugin> Set<T>	PluginRuntime.getPluginsOfType(Class<T> clazz)

Methods in de.xima.fc.plugin.runtime that return types with arguments of type IFCPlugin

Modifier and Type	Method and Description
Set<IFCPlugin>	PluginRuntime.getAllPlugins()