Package de.espirit.firstspirit.server.application

Interface ApplicationPlugin

All Superinterfaces:
Plugin, Public
public interface ApplicationPlugin extends Plugin
Definition of a plug-in describing an application connected to FirstSpirit.
Since:
5.2.1904

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    ApplicationPlugin.IconType
    The contextual icon type.

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable String
    getDescription()
    A description for the application, or null.
    @NotNull Image<?>
    getIcon(@NotNull ApplicationPlugin.IconType type)
    Returns the icon representing the application.
    @NotNull String
    getLabel()
    The label to be displayed at the application icon.
    @NotNull String
    getUrl()
    Returns the URL to be opened when starting the application on the webstart page.
    boolean
    isEnabled()
    Returns whether or not the application should be enabled in the current context.
    boolean
    isVisible()
    Returns whether or not the application should be visible in the current context.

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

    setUp, tearDown

  • Method Details

    • getIcon

      @NotNull @NotNull Image<?> getIcon(@NotNull @NotNull ApplicationPlugin.IconType type)
      Returns the icon representing the application.
      Parameters:
      type - The type of requested icon.
      Returns:
      The icon.
      Since:
      5.2.1904

    • getLabel

      @NotNull @NotNull String getLabel()
      The label to be displayed at the application icon.
      Returns:
      The label.
      Since:
      5.2.1904

    • getDescription

      @Nullable @Nullable String getDescription()
      A description for the application, or null.
      Returns:
      The description.
      Since:
      5.2.1904

    • getUrl

      @NotNull @NotNull String getUrl()
      Returns the URL to be opened when starting the application on the webstart page.
      Returns:
      The application URL.
      Since:
      5.2.1904

    • isVisible

      boolean isVisible()
      Returns whether or not the application should be visible in the current context.
      Returns:
      true if the application should be visible, false otherwise.
      Since:
      5.2.1904

    • isEnabled

      boolean isEnabled()
      Returns whether or not the application should be enabled in the current context.
      Returns:
      true if the application should be enabled, false otherwise.
      Since:
      5.2.1904