Package de.espirit.firstspirit.agency

Interface UIAgent

public interface UIAgent
Agent providing UI related functionality.
Since:
4.2.405

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    UIAgent.Status
    Indicators for the UI's status.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final SpecialistType<UIAgent>
    TYPE
    The specialist's technical type to be used for requesting the agent from a SpecialistsBroker.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull Image
    getApplicationIcon()
    Provides the current application icon.
    @NotNull Window
    getApplicationWindow()
    Provide the application window.
    @NotNull String
    getDescription(@NotNull Resolution resolution)
    Provides the description for the given resolution according to the currently set UI language and display mode.
    @Nullable String
    getDescription(@NotNull WorkflowElement workflowElement)
    Provides the description for the given workflow element according to the currently set UI language and display mode.
    @NotNull Language
    getDisplayLanguage()
    Provides the currently set language to be used for displaying UI elements.
    @NotNull String
    getDisplayName(@NotNull Language language)
    Determines the display name for the given language according to the currently set UI language and display mode.
    @NotNull String
    getDisplayName(@NotNull Resolution resolution)
    Determines the display name for the given resolution according to the currently set UI language and display mode.
    @NotNull String
    getDisplayName(@NotNull TemplateSet templateSet)
    Provides the display name for the given template set according to the currently set UI language and display mode.
    @NotNull String
    getDisplayName(@NotNull IDProvider element)
    Determines the display name for the given id providing store element according to the currently set UI language and display mode.
    @NotNull String
    getDisplayName(@NotNull WorkflowElement workflowElement)
    Provides the display name for the given workflow element according to the currently set UI language and display mode.
    String
    getDisplayName(Store.Type type)
    Provides the display name to be used for the given store type.
    String
    getHeadline(@NotNull Store store)
    Determines a headline to be used for the given store.
    @NotNull ImageIcon
    getIcon(@NotNull IDProvider element)
    Provides an icon for the given id providing store element.
    void
    setStatus(@NotNull UIAgent.Status status)
    Set the UI status, which will be visualized to the user in some form.

  • Field Details

  • Method Details

    • getDisplayName

      @NotNull @NotNull String getDisplayName(@NotNull @NotNull IDProvider element)
      Determines the display name for the given id providing store element according to the currently set UI language and display mode.
      Note: If the requestor has no "can see rights", a respective note is returned as name.
      Parameters:
      element - The id providing store element.
      Returns:
      The according display name.
      Since:
      4.2.405

    • getIcon

      @NotNull @NotNull ImageIcon getIcon(@NotNull @NotNull IDProvider element)
      Provides an icon for the given id providing store element.
      Note: If the requestor has no "can see rights", the same icon will be returned as if no fitting icon was found.
      Parameters:
      element - The id providing store element.
      Returns:
      An icon representing the element.
      Since:
      5.1.31

    • getHeadline

      String getHeadline(@NotNull @NotNull Store store)
      Determines a headline to be used for the given store.
      Parameters:
      store - The store.
      Returns:
      The according headline.
      Since:
      5.0.100

    • getDisplayName

      String getDisplayName(@NotNull Store.Type type)
      Provides the display name to be used for the given store type.
      Parameters:
      type - The store type.
      Returns:
      The according display name.
      Since:
      5.1.8

    • getDisplayName

      @NotNull @NotNull String getDisplayName(@NotNull @NotNull Language language)
      Determines the display name for the given language according to the currently set UI language and display mode.
      Parameters:
      language - The language.
      Returns:
      the according display name.
      Since:
      4.2.405

    • getDisplayName

      @NotNull @NotNull String getDisplayName(@NotNull @NotNull Resolution resolution)
      Determines the display name for the given resolution according to the currently set UI language and display mode.
      Parameters:
      resolution - The resolution.
      Returns:
      the according display name.
      Since:
      4.2.428

    • getDescription

      @NotNull @NotNull String getDescription(@NotNull @NotNull Resolution resolution)
      Provides the description for the given resolution according to the currently set UI language and display mode.
      Parameters:
      resolution - The resolution.
      Returns:
      The according description.
      Since:
      5.0.100

    • getDisplayName

      @NotNull @NotNull String getDisplayName(@NotNull @NotNull WorkflowElement workflowElement)
      Provides the display name for the given workflow element according to the currently set UI language and display mode.
      Parameters:
      workflowElement - The workflow element.
      Returns:
      The according display name.
      Since:
      5.0.601, 5.1.4

    • getDescription

      @Nullable @Nullable String getDescription(@NotNull @NotNull WorkflowElement workflowElement)
      Provides the description for the given workflow element according to the currently set UI language and display mode.
      Parameters:
      workflowElement - The workflow element.
      Returns:
      The according description or null, if no description is set.
      Since:
      5.0.601, 5.1.4

    • getDisplayName

      @NotNull @NotNull String getDisplayName(@NotNull @NotNull TemplateSet templateSet)
      Provides the display name for the given template set according to the currently set UI language and display mode.
      Parameters:
      templateSet - The template set.
      Returns:
      The according display name.
      Since:
      5.0.601, 5.1.4

    • getDisplayLanguage

      @NotNull @NotNull Language getDisplayLanguage()
      Provides the currently set language to be used for displaying UI elements.
      Returns:
      The current language.
      Since:
      5.0.100

    • getApplicationWindow

      @NotNull @NotNull Window getApplicationWindow()
      Provide the application window.
      Returns:
      The application window.
      Since:
      5.0.100

    • getApplicationIcon

      @NotNull @NotNull Image getApplicationIcon()
      Provides the current application icon.
      Returns:
      The application icon.
      Since:
      5.0.100

    • setStatus

      void setStatus(@NotNull @NotNull UIAgent.Status status)
      Set the UI status, which will be visualized to the user in some form.
      Parameters:
      status - The UI status to set.
      Since:
      5.0.100