Interface WebeditReportPlugin<T>

Type Parameters:
T - The type of handled objects.
All Superinterfaces:
Plugin, Public

@Deprecated public interface WebeditReportPlugin<T> extends Plugin
Deprecated.
since 5.1.5 - use ReportPlugin instead
Interface for WebClient report plug-ins.
Since:
5.0.103
  • Method Summary

    Modifier and Type
    Method
    Description
    Deprecated.
    Factory method to create an object provider instance for use with this report plug-in.
    Deprecated.
    Factory method to create a renderer instance for use with this report plug-in.
    getIcon(boolean selected)
    Deprecated.
    Returns a URL for the report's icon graphic that will be shown in the WebClient.
    Deprecated.
    Returns a list of parameter definitions of this report plug-in, used to enable filter configuration by users within the user interface.
    Deprecated.
    Returns a human-readable title representing this report plug-in.

    Methods inherited from interface de.espirit.firstspirit.client.plugin.Plugin

    setUp, tearDown
  • Method Details

    • getTitle

      String getTitle()
      Deprecated.
      Returns a human-readable title representing this report plug-in.
      Returns:
      The report title.
      Since:
      5.0.103
    • getIcon

      @Nullable String getIcon(boolean selected)
      Deprecated.
      Returns a URL for the report's icon graphic that will be shown in the WebClient. The URL may be relative to the WebClient web application's root directory or absolute.

      WebClient will request either a "normal" or a "selected" icon state, depending on the context, in which the icon should be displayed:

      • The "normal" icon graphic should include the report's regular icon.
      • The "selected" icon graphic should imply an active state.
      Parameters:
      selected - The selected-state of the icon.
      Returns:
      Icon URL or null if a generic icon should be used.
      Since:
      5.0.103
    • getParameter

      @NotNull List<Parameter<?>> getParameter()
      Deprecated.
      Returns a list of parameter definitions of this report plug-in, used to enable filter configuration by users within the user interface.
      Returns:
      A Parameter list.
      Since:
      5.0.103
    • createProvider

      @NotNull ReportPluginProvider<T> createProvider()
      Deprecated.
      Factory method to create an object provider instance for use with this report plug-in.
      Returns:
      The object provider instance.
      Since:
      5.0.103
    • createRenderer

      @NotNull ReportPluginRenderer<T> createRenderer()
      Deprecated.
      Factory method to create a renderer instance for use with this report plug-in.
      Returns:
      The renderer instance.
      Since:
      5.0.103