de.espirit.firstspirit.agency

Interface UIAgent

public interface UIAgent

Agent providing UI related functionality.

Since:

4.2.405

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UIAgent.Status Indicators for the UI's status.

Field Summary

Fields

Modifier and Type	Field and Description
static SpecialistType<UIAgent>	TYPE The specialist's technical type to be used for requesting the agent from a SpecialistsBroker.

Method Summary

Methods

Modifier and Type	Method and Description
Image	getApplicationIcon() Provides the current application icon.
Window	getApplicationWindow() Provide the application window.
String	getDescription(Resolution resolution) Provides the description for the given resolution according to the currently set UI language and display mode.
Language	getDisplayLanguage() Provides the currently set language to be used for displaying UI elements.
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.
String	getHeadline(Store store) Determines a headline to be used for the given store.
void	setStatus(UIAgent.Status status) Set the UI status, which will be visualized to the user in some form.

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

@NotNull
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

getHeadline

String getHeadline(@NotNull
                 Store store)

Determines a headline to be used for the given store.

Parameters:

store - The store.

Returns:

The according display name.

Since:

5.0.100

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

getDescription

String getDescription(Resolution resolution)

Provides the description for the given resolution according to the currently set UI language and display mode.

Parameters:

resolution - The resolution.

Returns:

The according description.

Since:

5.0.100

getDisplayLanguage

@NotNull
Language getDisplayLanguage()

Provides the currently set language to be used for displaying UI elements.

Returns:

The current language.

Since:

5.0.100

getApplicationWindow

@NotNull
Window getApplicationWindow()

Provide the application window.

Returns:

The application window.

Since:

5.0.100

getApplicationIcon

@NotNull
Image getApplicationIcon()

Provides the current application icon.

Returns:

The application icon.

Since:

5.0.100

setStatus

void setStatus(@NotNull
             UIAgent.Status status)

Set the UI status, which will be visualized to the user in some form.

Parameters:

status - The UI status to set.

Since:

5.0.100