Package de.espirit.firstspirit.agency

Interface GenerateElementOperation

public interface GenerateElementOperation
Operation for a synchronous execution of a schedule entry generating a PageRef.
Since:
5.2.101

  • Field Details

  • Method Details

    • setScheduleEntry

      void setScheduleEntry(@Nullable @Nullable ScheduleEntry scheduleEntry)
      Configures a ScheduleEntry which should be used for the partial generation of the PageRef. If none is specified this operation will search for a schedule entry containing a partial generation task.
      Parameters:
      scheduleEntry - The schedule entry to use, or null.
      Since:
      5.2.101

    • setBaseUrl

      void setBaseUrl(@Nullable @Nullable String baseUrl)
      Configures the base url the generated content is accessible from. If none is specified this operation will use the url of staging web application.
      Parameters:
      baseUrl - The base url to use, or null.
      Since:
      5.2.101

    • perform

      @Nullable @Nullable String perform(@NotNull @NotNull PageRef element, @NotNull @NotNull Language language)
      Executes the configured ScheduleEntry and waits for its completion. This method will return an url the generated content is accessible from.
      Parameters:
      element - The element to generate.
      Returns:
      An url pointing to the generated content.
      Since:
      5.2.101