com.smartdevicelink.proxy.rpc

Class HMISettingsControlCapabilities

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.HMISettingsControlCapabilities

All Implemented Interfaces:

Cloneable

public class HMISettingsControlCapabilities
extends RPCStruct

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_DISPLAY_MODE_UNIT_AVAILABLE
static String	KEY_DISTANCE_UNIT_AVAILABLE
static String	KEY_MODULE_INFO
static String	KEY_MODULE_NAME
static String	KEY_TEMPERATURE_UNIT_AVAILABLE

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
HMISettingsControlCapabilities() Constructs a new HMISettingsControlCapabilities object
HMISettingsControlCapabilities(Hashtable<String,Object> hash) Constructs a new HMISettingsControlCapabilities object indicated by the Hashtable parameter
HMISettingsControlCapabilities(String moduleName)

Method Summary

Modifier and Type	Method and Description
Boolean	getDisplayModeUnitAvailable() Gets the displayModeUnitAvailable portion of the HMISettingsControlCapabilities class
Boolean	getDistanceUnitAvailable() Gets the distanceUnitAvailable portion of the HMISettingsControlCapabilities class
ModuleInfo	getModuleInfo() Gets a ModuleInfo of this capability
String	getModuleName() Gets the moduleName portion of the HMISettingsControlCapabilities class
Boolean	getTemperatureUnitAvailable() Gets the temperatureUnitAvailable portion of the HMISettingsControlCapabilities class
HMISettingsControlCapabilities	setDisplayModeUnitAvailable(Boolean displayModeUnitAvailable) Sets the displayModeUnitAvailable portion of the HMISettingsControlCapabilities class
HMISettingsControlCapabilities	setDistanceUnitAvailable(Boolean distanceUnitAvailable) Sets the distanceUnitAvailable portion of the HMISettingsControlCapabilities class
HMISettingsControlCapabilities	setModuleInfo(ModuleInfo info) Sets ModuleInfo for this capability
HMISettingsControlCapabilities	setModuleName(String moduleName) Sets the moduleName portion of the HMISettingsControlCapabilities class
HMISettingsControlCapabilities	setTemperatureUnitAvailable(Boolean temperatureUnitAvailable) Sets the temperatureUnitAvailable portion of the HMISettingsControlCapabilities class

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_MODULE_NAME

public static final String KEY_MODULE_NAME

See Also:

Constant Field Values

KEY_DISTANCE_UNIT_AVAILABLE

public static final String KEY_DISTANCE_UNIT_AVAILABLE

See Also:

Constant Field Values

KEY_TEMPERATURE_UNIT_AVAILABLE

public static final String KEY_TEMPERATURE_UNIT_AVAILABLE

See Also:

Constant Field Values

KEY_DISPLAY_MODE_UNIT_AVAILABLE

public static final String KEY_DISPLAY_MODE_UNIT_AVAILABLE

See Also:

Constant Field Values

KEY_MODULE_INFO

public static final String KEY_MODULE_INFO

See Also:

Constant Field Values

Constructor Detail

HMISettingsControlCapabilities

public HMISettingsControlCapabilities()

Constructs a new HMISettingsControlCapabilities object

HMISettingsControlCapabilities

public HMISettingsControlCapabilities(Hashtable<String,Object> hash)

Constructs a new HMISettingsControlCapabilities object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

HMISettingsControlCapabilities

public HMISettingsControlCapabilities(@NonNull
                                      String moduleName)

Method Detail

setModuleName

public HMISettingsControlCapabilities setModuleName(@NonNull
                                                    String moduleName)

Sets the moduleName portion of the HMISettingsControlCapabilities class

Parameters:

moduleName - The short friendly name of the hmi setting module. It should not be used to identify a module by mobile application.

getModuleName

public String getModuleName()

Gets the moduleName portion of the HMISettingsControlCapabilities class

Returns:

String - The short friendly name of the hmi setting module. It should not be used to identify a module by mobile application.

setDistanceUnitAvailable

public HMISettingsControlCapabilities setDistanceUnitAvailable(Boolean distanceUnitAvailable)

Sets the distanceUnitAvailable portion of the HMISettingsControlCapabilities class

Parameters:

distanceUnitAvailable - Availability of the control of distance unit.

getDistanceUnitAvailable

public Boolean getDistanceUnitAvailable()

Gets the distanceUnitAvailable portion of the HMISettingsControlCapabilities class

Returns:

Boolean - Availability of the control of distance unit.

setTemperatureUnitAvailable

public HMISettingsControlCapabilities setTemperatureUnitAvailable(Boolean temperatureUnitAvailable)

Sets the temperatureUnitAvailable portion of the HMISettingsControlCapabilities class

Parameters:

temperatureUnitAvailable - Availability of the control of temperature unit.

getTemperatureUnitAvailable

public Boolean getTemperatureUnitAvailable()

Gets the temperatureUnitAvailable portion of the HMISettingsControlCapabilities class

Returns:

Boolean - Availability of the control of temperature unit.

setDisplayModeUnitAvailable

public HMISettingsControlCapabilities setDisplayModeUnitAvailable(Boolean displayModeUnitAvailable)

Sets the displayModeUnitAvailable portion of the HMISettingsControlCapabilities class

Parameters:

displayModeUnitAvailable - Availability of the control of HMI display mode.

getDisplayModeUnitAvailable

public Boolean getDisplayModeUnitAvailable()

Gets the displayModeUnitAvailable portion of the HMISettingsControlCapabilities class

Returns:

Boolean - Availability of the control of HMI display mode.

setModuleInfo

public HMISettingsControlCapabilities setModuleInfo(ModuleInfo info)

Sets ModuleInfo for this capability

Parameters:

info - the ModuleInfo to be set

getModuleInfo

public ModuleInfo getModuleInfo()

Gets a ModuleInfo of this capability

Returns:

module info of this capability