Package de.espirit.firstspirit.workflow

Interface WebeditElementStatusProviderPlugin

All Superinterfaces:
Plugin, Public
public interface WebeditElementStatusProviderPlugin extends Plugin
Provides information of which elements should be available for workflow actions and in which release state is a given element.
Since:
5.0.206

  • Method Details

    • getWorkflowGroups

      @NotNull @NotNull List<WorkflowGroup> getWorkflowGroups(@NotNull @NotNull IDProvider element)
      Returns a list of WorkflowGroup objects, each group should contain elements with common workflow actions.
      Parameters:
      element - The element to return the available workflow groups for.
      Returns:
      workflow groups.
      Since:
      5.0.206
      See Also:

    • getWorkflowGroups

      @NotNull default @NotNull List<WorkflowGroup> getWorkflowGroups(@NotNull @NotNull IDProvider element, @NotNull @NotNull Language language)
      Returns a list of WorkflowGroup objects in the context of a specific project language, each group should contain elements with workflow actions shared between its elements. By default, this method returns the language-independent workflows determined by getWorkflowGroups(IDProvider).
      Parameters:
      element - The element to return the available workflow groups for.
      language - The contextual language in which the workflows are requested.
      Returns:
      workflow groups.
      Since:
      5.2.250602
      See Also:

    • getReleaseState

      @NotNull @NotNull WebeditElementStatusProviderPlugin.State getReleaseState(@NotNull @NotNull IDProvider element)
      Returns the release state of the given element, consider depending objects like it's page or references media.
      Parameters:
      element - The element to return the release state for.
      Returns:
      release state of the given element.
      Since:
      5.0.206
      See Also:

    • getReleaseState

      @NotNull default @NotNull WebeditElementStatusProviderPlugin.State getReleaseState(@NotNull @NotNull IDProvider element, @NotNull @NotNull Language language)
      Returns the release state of the given element and persistency language. Depending on the implementation of this plugin and available workflows, this implementation may also consider dependencies like the associated Page or referenced Media. By default, this method returns the language-independent status determined by getReleaseState(IDProvider).
      Parameters:
      element - The element to return the language-specific release state for.
      language - The language to determine the release state for.
      Returns:
      The release of the given element and language.
      Since:
      5.2.250602
      See Also:

    • isSupported

      default boolean isSupported(@NotNull @NotNull IDProvider element)
      Returns whether or not this plugin can provide status information for the given element. By default this method supports PageRef and Dataset elements.
      Parameters:
      element - The element to check for support.
      Returns:
      true if this plugin supports this element type, false otherwise.
      Since:
      5.2.201208