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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	WebeditElementStatusProviderPlugin.Factory	Factory to create a WorkflowGroup.
static enum	WebeditElementStatusProviderPlugin.State	Kind of release state of a given element.

Method Summary

Modifier and Type	Method	Description
@NotNull WebeditElementStatusProviderPlugin.State	getReleaseState(@NotNull IDProvider element)	Returns the release state of the given element, consider depending objects like it's page or references media.
@NotNull List<WorkflowGroup>	getWorkflowGroups(@NotNull IDProvider element)	Returns a list of WorkflowGroup objects, each group should contain elements with common workflow actions.
default boolean	isSupported(@NotNull IDProvider element)	Returns whether or not this plugin can provide status information for the given element.

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

setUp, tearDown

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:

• isSupported(IDProvider)

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:

• isSupported(IDProvider)

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