Class DefaultPluginFormThemeRetVal

java.lang.Object

de.xima.fc.plugin.models.retval.form.DefaultPluginFormThemeRetVal

All Implemented Interfaces:

IPluginFormThemeRetVal

public final class DefaultPluginFormThemeRetVal
extends Object
implements IPluginFormThemeRetVal

Default POJO implementation of IPluginFormThemeRetVal with a builder.

Since:

8.3.0

Author:

XIMA MEDIA GmbH

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DefaultPluginFormThemeRetVal.Builder	Simple builder for a DefaultPluginFormThemeRetVal.

Method Summary

Modifier and Type	Method	Description
static DefaultPluginFormThemeRetVal.Builder	builder()	Creates a new builder for a DefaultPluginFormThemeRetVal.
Map<String, IFormTheme>	getThemesById()	Gets the form themes that the plugin provides for the given parameters.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getThemesById

public Map<String, IFormTheme> getThemesById()

Description copied from interface: IPluginFormThemeRetVal

Gets the form themes that the plugin provides for the given parameters. The key is the ID of the form theme and is used to identify the theme amongst all themes returned by the plugin. This ID must be unique only amongst the themes returned by an individual IPluginFormTheme instance. Different plugin could in principle return themes with the same ID.

Specified by:

getThemesById in interface IPluginFormThemeRetVal

Returns:

A map with all available form themes.

builder

public static DefaultPluginFormThemeRetVal.Builder builder()

Creates a new builder for a DefaultPluginFormThemeRetVal.

Returns:

A new builder.