Interface IBeanProvidingPluginLocator<Key, Plugin extends IFCPlugin>

Type Parameters:
Key - The key used to identify which bean to retrieve, e.g. a workflow node handler's type.
Plugin - The interface type of the plugin that provides the beans, must implement IFCPlugin.
All Superinterfaces:
Serializable
All Known Implementing Classes:
PromptServicePluginLocator
public interface IBeanProvidingPluginLocator<Key, Plugin extends IFCPlugin> extends Serializable
Used by GuiBeanCache. Locates the plugin, if any, for a given key. When the UI is from a built-in, may return null to indicate so.
Since:
8.5.0

  • Method Summary

    Modifier and Type
    Method
    Description
    Plugin
    findPlugin(Mandant client, Key key)
    Finds the plugin that provides the UI and the bean for the given key.

  • Method Details

    • findPlugin

      Plugin findPlugin(Mandant client, Key key) throws Exception
      Finds the plugin that provides the UI and the bean for the given key. When the UI is from a built-in, this method should return null.
      Parameters:
      client - The current client scope, or null if no client is available. When given, plugins from that client scope should be included. When not given, only system scoped should be considered.
      key - The key used to identify which bean to retrieve, e.g. a workflow node handler's type.
      Returns:
      The plugin that provides the bean for the given key, or null if it comes from a built-in.
      Throws:
      Exception - If an error occurs while finding the plugin.