Package de.espirit.firstspirit.scheduling

Interface ScheduleTaskApplication<D extends ScheduleTaskData>

Type Parameters:
D - Type of schedule task data.
public interface ScheduleTaskApplication<D extends ScheduleTaskData>
Definition of an application providing persistency and execution means for a schedule task.
Since:
5.2.14

  • Method Summary

    Modifier and Type
    Method
    Description
    D
    createData()
    Create a new custom data container for storing application specific configuration information.
    <A> A
    getAspect(ApplicationAspectType<A> type)
    Look up a specific aspect that may be supported by this application.
    @Nullable String
    getDescription(@NotNull Locale locale)
    Provides a description for this application, preferably respecting the given locale.
    @NotNull ScheduleTaskExecutor<D>
    getExecutor()
    Provides an executor providing the application logic.
    @NotNull String
    getName(@NotNull Locale locale)
    Provides a name for this application, preferably respecting the given locale.
    boolean
    isApplicable(@NotNull ScheduleTaskDefinitionContext context)
    Indicates the applicability of this application's tasks wrt. the given task definition context.

  • Method Details

    • getAspect

      @Nullable <A> A getAspect(ApplicationAspectType<A> type)
      Look up a specific aspect that may be supported by this application.
      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.16

    • getName

      @NotNull @NotNull String getName(@NotNull @NotNull Locale locale)
      Provides a name for this application, preferably respecting the given locale.
      Parameters:
      locale - The locale the name is requested for.
      Returns:
      The application name.
      Since:
      5.2.14

    • getDescription

      @Nullable @Nullable String getDescription(@NotNull @NotNull Locale locale)
      Provides a description for this application, preferably respecting the given locale.
      Parameters:
      locale - The locale the description is requested for.
      Returns:
      The application description or null.
      Since:
      5.2.14

    • isApplicable

      boolean isApplicable(@NotNull @NotNull ScheduleTaskDefinitionContext context)
      Indicates the applicability of this application's tasks wrt. the given task definition context.
      Parameters:
      context - The context.
      Returns:
      true, if applicable for use.
      Since:
      5.2.16

    • getExecutor

      @NotNull @NotNull ScheduleTaskExecutor<D> getExecutor()
      Provides an executor providing the application logic.
      Returns:
      The application executor.
      Since:
      5.2.14

    • createData

      @Nullable D createData()
      Create a new custom data container for storing application specific configuration information.
      Returns:
      A new data container.
      Since:
      5.2.14