Package de.espirit.firstspirit.client.plugin.dataaccess

Interface DataAccessPlugin<D>

Type Parameters:
D - Type of data access is given to.
All Superinterfaces:
Plugin, Public
public interface DataAccessPlugin<D> extends Plugin
Plug-in allowing access to data managed by some sort of container.
Since:
5.2.5

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull DataAccessSessionBuilder<D>
    createSessionBuilder()
    Provides a builder for creating a (configured) session for accessing data.
    Attention: This call should return very fast.
    <A> A
    getAspect(@NotNull DataAccessAspectType<A> type)
    Look up a specific aspect that may be supported by this plug-in.
    Attention: This method may be called very often and must return very fast.
    @Nullable Image<?>
    getIcon()
    Provides an icon to be shown when displaying this plug-in or information thereon.
    @NotNull String
    getLabel()
    Provides a human-readable label to be shown when displaying this plug-in or information thereon.

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

    setUp, tearDown

  • Method Details

    • getAspect

      @Nullable <A> A getAspect(@NotNull @NotNull DataAccessAspectType<A> type)
      Look up a specific aspect that may be supported by this plug-in.
      Attention: This method may be called very often and must return very fast.
      Type Parameters:
      A - The object type of the aspect.
      Parameters:
      type - The type of aspect.
      Returns:
      An aspect implementer or null, if the aspect is not supported.
      Since:
      5.2.5

    • getLabel

      @NotNull @NotNull String getLabel()
      Provides a human-readable label to be shown when displaying this plug-in or information thereon.
      Returns:
      Some text naming this plug-in.
      Since:
      5.2.5

    • getIcon

      @Nullable @Nullable Image<?> getIcon()
      Provides an icon to be shown when displaying this plug-in or information thereon.
      Returns:
      Some icon or null.
      Since:
      5.2.5

    • createSessionBuilder

      @NotNull @NotNull DataAccessSessionBuilder<D> createSessionBuilder()
      Provides a builder for creating a (configured) session for accessing data.
      Attention: This call should return very fast.
      Returns:
      The session builder.
      Since:
      5.2.9