Package net.solarnetwork.settings

Interface GroupSettingSpecifier

All Superinterfaces:

MappableSpecifier, SettingSpecifier

All Known Implementing Classes:

BasicGroupSettingSpecifier

public interface GroupSettingSpecifier
extends SettingSpecifier, MappableSpecifier

A grouping of other settings.

Version:

1.0

Author:

matt

Nested Class Summary

Nested classes/interfaces inherited from interface net.solarnetwork.settings.MappableSpecifier

MappableSpecifier.Mapper

Method Summary

Modifier and Type	Method	Description
String	getFooterText()	Localizable text to display at the end of the group's content.
List<SettingSpecifier>	getGroupSettings()	Get the settings in this group.
String	getKey()	Get the key for this setting.
boolean	isDynamic()	Get dynamic flag.

Methods inherited from interface net.solarnetwork.settings.MappableSpecifier

mappedTo, mappedWithMapper, mappedWithPlaceholer

Methods inherited from interface net.solarnetwork.settings.SettingSpecifier

getTitle, getType

Method Details

getKey

String getKey()

Get the key for this setting.

Returns:

the key to associate with this setting

getFooterText

String getFooterText()

Localizable text to display at the end of the group's content.

Returns:

localizable

getGroupSettings

List<SettingSpecifier> getGroupSettings()

Get the settings in this group.

Returns:

the list of group settings

isDynamic

boolean isDynamic()

Get dynamic flag. A dynamic group is one that a user can manage any number of copies of the group settings, adding and removing as necessary.

Returns:

The dynamic flag.