Interface DisplayElementOperation
public interface DisplayElementOperation
Operation providing means to display an element in the client.
- Since:
- 5.0.102
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
Marker for client specific configurators, providing means to define client depending settings. -
Field Summary
Modifier and TypeFieldDescriptionstatic final OperationType<DisplayElementOperation>
Operation providing means to display an element in the client. -
Method Summary
Modifier and TypeMethodDescription<C extends DisplayElementOperation.ClientSpecificConfigurator>
CgetConfigurator
(Class<C> configuratorType) Provides an instance of a configurator as requested by the given type.void
perform
(@NotNull IDProvider element) Perform this operation wrt. the given element.void
setLanguage
(Language language) Defines the language to be displayed.
-
Field Details
-
TYPE
Operation providing means to display an element in the client.- Since:
- 5.0.102
-
-
Method Details
-
setLanguage
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
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
-