Package de.espirit.firstspirit.workflow
Interface WebeditElementStatusProviderPlugin
Provides information of which elements should be available for workflow actions and in which release state is a given element.
- Since:
- 5.0.206
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic class
Factory tocreate
aWorkflowGroup
.static enum
Kind of release state of a given element. -
Method Summary
Modifier and TypeMethodDescriptiongetReleaseState
(@NotNull IDProvider element) Returns the release state of the givenelement
, consider depending objects like it's page or references media.default @NotNull WebeditElementStatusProviderPlugin.State
getReleaseState
(@NotNull IDProvider element, @NotNull Language language) Returns the release state of the given element and persistency language.@NotNull List<WorkflowGroup>
getWorkflowGroups
(@NotNull IDProvider element) Returns a list ofWorkflowGroup
objects, each group should contain elements with common workflow actions.default @NotNull List<WorkflowGroup>
getWorkflowGroups
(@NotNull IDProvider element, @NotNull Language language) Returns a list ofWorkflowGroup
objects in the context of a specific project language, each group should contain elements with workflow actions shared between its elements.default boolean
isSupported
(@NotNull IDProvider element) Returns whether or not this plugin can provide status information for the given element.
-
Method Details
-
getWorkflowGroups
Returns a list ofWorkflowGroup
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 ofWorkflowGroup
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 bygetWorkflowGroups(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 givenelement
, 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 associatedPage
or referencedMedia
. By default, this method returns the language-independent status determined bygetReleaseState(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
Returns whether or not this plugin can provide status information for the given element. By default this method supportsPageRef
andDataset
elements.- Parameters:
element
- The element to check for support.- Returns:
true
if this plugin supports this element type,false
otherwise.- Since:
- 5.2.201208
-