de.espirit.firstspirit.agency
Interface UIAgent

public interface UIAgent

Agent providing UI related functionality.

Since:

4.2.405

Field Summary

static SpecialistType<UIAgent>

TYPE The specialist's technical type to be used for requesting the agent from a SpecialistsBroker.

Method Summary

String	getDisplayName(IDProvider element) Determines the display name for the given id providing store element according to the currently set UI language and display mode.
String	getDisplayName(Language language) Determines the display name for the given language according to the currently set UI language and display mode.
String	getDisplayName(Resolution resolution) Determines the display name for the given resolution according to the currently set UI language and display mode.

Field Detail

TYPE

static final SpecialistType<UIAgent> TYPE

The specialist's technical type to be used for requesting the agent from a SpecialistsBroker.

Since:

4.2.405

Method Detail

getDisplayName

@Nullable
String getDisplayName(@NotNull
                               IDProvider element)

Determines the display name for the given id providing store element according to the currently set UI language and display mode. If no name could be resolved, null will be returned.

Note: If the requestor has no "can see rights", a respective note is returned as name.

Parameters:

element - The id providing store element.

Returns:

The according display name.

Since:

4.2.405

getDisplayName

@NotNull
String getDisplayName(@NotNull
                              Language language)

Determines the display name for the given language according to the currently set UI language and display mode.

Parameters:

language - The language.

Returns:

the according display name.

Since:

4.2.405

getDisplayName

@NotNull
String getDisplayName(@NotNull
                              Resolution resolution)

Determines the display name for the given resolution according to the currently set UI language and display mode.

Parameters:

resolution - The resolution.

Returns:

the according display name.

Since:

4.2.428