Interface IPolySettingsService

com.poly.polyos.settings

Interface IPolySettingsService

---

public interface IPolySettingsService

Settings exposed for PolyOS Clients

Since:
3.0.11

See Also:
IPolySettings

Method Summary

Modifier and Type	Method and Description
java.util.List<Setting>	getSetting(IPolySettingsListener listener, Setting.KEY... keys)
	Returns the List of Setting for the given keys
ResponseStatus.Status	setSetting(Setting setting)
	Sets the given Setting
ResponseStatus.Status	setSetting(java.lang.String batchKey , Setting... settings)
	Sets each given Setting
IPolySettingsService	targetLocal()
	Returns a IPolySettingsService targeting the calls to the local DeviceType
void	unRegisterSettingsListener (IPolySettingsListener listener)
	Unregisters a IPolySettingsListener

Method Detail

getSetting

java.util.List<Setting> getSetting(IPolySettingsListener listener,
                                   Setting.KEY... keys)

Returns the List of Setting for the given keys

Parameters:
listener - If not null, this listener will get callback for any changes to these settings.
keys - The Setting.KEY of the settings to fetch

Since:
3.0.13

See Also:
IPolySettings

setSetting

ResponseStatus.Status setSetting(Setting setting)
Sets the given Setting

Parameters:
setting - The setting to set

Returns:
Returns the status of the set (Success, or error for failure)

See Also:
IPolySettings

setSetting

ResponseStatus.Status setSetting(java.lang.String batchKey,
                                 Setting... settings)

Sets each given Setting

Parameters:
batchKey - Optionally specify the batch key. If non null, all settings are set together as a batch
settings - The settings to set

Returns:
Returns the status of the set (Success, or error for failure)

Since:
3.0.36

See Also:
IPolySettings

unRegisterSettingsListener

void unRegisterSettingsListener(IPolySettingsListener listener)
Unregisters a IPolySettingsListener

targetLocal

IPolySettingsService targetLocal()
Returns a IPolySettingsService targeting the calls to the local DeviceType

Returns the same instance if called from DeviceType.PRIMARY.

If called from DeviceType.CONTROLLER, the returned instance targets calls to DeviceType.CONTROLLER.

By default, all calls are targeted to DeviceType.PRIMARY.

Since:
3.3.0.0-3