de.espirit.firstspirit.ui.operations

Interface DisplayElementOperation

public interface DisplayElementOperation

Operation providing means to display an element in the client.

Since:

5.0.102

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DisplayElementOperation.ClientSpecificConfigurator Marker for client specific configurators, providing means to define client depending settings.

Field Summary

Fields

Modifier and Type	Field and Description
static OperationType<DisplayElementOperation>	TYPE Operation providing means to display an element in the client.

Method Summary

Methods

Modifier and Type	Method and Description
<C extends DisplayElementOperation.ClientSpecificConfigurator> C	getConfigurator(Class<C> configuratorType) Provides an instance of a configurator as requested by the given type.
void	perform(IDProvider element) Perform this operation wrt. the given element.
void	setLanguage(Language language) Defines the language to be displayed.

Field Detail

TYPE

static final OperationType<DisplayElementOperation> TYPE

Operation providing means to display an element in the client.

Since:

5.0.102

Method Detail

setLanguage

void setLanguage(Language language)

Defines the language to be displayed.

Parameters:

language - The display language.

Since:

5.0.102

getConfigurator

@NotNull
<C extends DisplayElementOperation.ClientSpecificConfigurator> C getConfigurator(Class<C> configuratorType)
                                                                             throws IllegalArgumentException

Provides an instance of a configurator as requested by the given type.

Type Parameters:

C - The formal configurator type.

Parameters:

configuratorType - The type of configurator to get access to.

Returns:

An instance of the requested configurator.

Throws:

IllegalArgumentException - If the requested type is not supported.

Since:

5.0.102

perform

void perform(@NotNull
           IDProvider element)
             throws OperationSetupException

Perform this operation wrt. the given element.

Parameters:

element - The element to be displayed.

Throws:

OperationSetupException - If the operation cannot be performed with the given setup.

Since:

5.0.102