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.
String	getDescription(WorkflowElement workflowElement) Provides the description for the given workflow element 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	getDisplayName(Store.Type type) Provides the display name to be used for the given store type.
String	getDisplayName(TemplateSet templateSet) Provides the display name for the given template set according to the currently set UI language and display mode.
String	getDisplayName(WorkflowElement workflowElement) Provides the display name for the given workflow element according to the currently set UI language and display mode.
String	getHeadline(Store store) Determines a headline to be used for the given store.
ImageIcon	getIcon(IDProvider element) Provides an icon for the given id providing store element.
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.

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

getIcon

@NotNull
ImageIcon getIcon(@NotNull
                        IDProvider element)

Provides an icon for the given id providing store element.

Note: If the requestor has no "can see rights", the same icon will be returned as if no fitting icon was found.

Parameters:

element - The id providing store element.

Returns:

An icon representing the element.

Since:

5.1.31

getHeadline

String getHeadline(@NotNull
                 Store store)

Determines a headline to be used for the given store.

Parameters:

store - The store.

Returns:

The according headline.

Since:

5.0.100

getDisplayName

String getDisplayName(@NotNull
                    Store.Type type)

Provides the display name to be used for the given store type.

Parameters:

type - The store type.

Returns:

The according display name.

Since:

5.1.8

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

@NotNull
String getDescription(@NotNull
                            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

getDisplayName

@NotNull
String getDisplayName(@NotNull
                            WorkflowElement workflowElement)

Provides the display name for the given workflow element according to the currently set UI language and display mode.

Parameters:

workflowElement - The workflow element.

Returns:

The according display name.

Since:

5.1.4

getDescription

@Nullable
String getDescription(@NotNull
                             WorkflowElement workflowElement)

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

Parameters:

workflowElement - The workflow element.

Returns:

The according description or null, if no description is set.

Since:

5.1.4

getDisplayName

@NotNull
String getDisplayName(@NotNull
                            TemplateSet templateSet)

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

Parameters:

templateSet - The template set.

Returns:

The according display name.

Since:

5.1.4

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