summaryrefslogtreecommitdiff
path: root/base/src/main/java/com/smartdevicelink/proxy/rpc/HMISettingsControlCapabilities.java
blob: d62b646bace749e90b2a50d3f6d7fc599b03aa3b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
/*
 * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided with the
 * distribution.
 *
 * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from this 
 * software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package com.smartdevicelink.proxy.rpc;

import androidx.annotation.NonNull;

import com.smartdevicelink.proxy.RPCStruct;

import java.util.Hashtable;

public class HMISettingsControlCapabilities extends RPCStruct {
	public static final String KEY_MODULE_NAME = "moduleName";
	public static final String KEY_DISTANCE_UNIT_AVAILABLE = "distanceUnitAvailable";
	public static final String KEY_TEMPERATURE_UNIT_AVAILABLE = "temperatureUnitAvailable";
	public static final String KEY_DISPLAY_MODE_UNIT_AVAILABLE = "displayModeUnitAvailable";
	public static final String KEY_MODULE_INFO = "moduleInfo";

	/**
	 * Constructs a new HMISettingsControlCapabilities object
	 */
	public HMISettingsControlCapabilities() {
	}

	/**
	 * <p>Constructs a new HMISettingsControlCapabilities object indicated by the Hashtable parameter
	 * </p>
	 *
	 * @param hash The Hashtable to use
	 */
	public HMISettingsControlCapabilities(Hashtable<String, Object> hash) {
		super(hash);
	}

	public HMISettingsControlCapabilities(@NonNull String moduleName) {
		this();
		setModuleName(moduleName);
	}

	/**
	 * Sets the moduleName portion of the HMISettingsControlCapabilities class
	 *
	 * @param moduleName The short friendly name of the hmi setting module. It should not be used to identify a module by mobile application.
	 */
	public void setModuleName(@NonNull String moduleName) {
		setValue(KEY_MODULE_NAME, moduleName);
	}

	/**
	 * Gets the moduleName portion of the HMISettingsControlCapabilities class
	 *
	 * @return String - The short friendly name of the hmi setting module. It should not be used to identify a module by mobile application.
	 */
	public String getModuleName() {
		return getString(KEY_MODULE_NAME);
	}

	/**
	 * Sets the distanceUnitAvailable portion of the HMISettingsControlCapabilities class
	 *
	 * @param distanceUnitAvailable Availability of the control of distance unit.
	 */
	public void setDistanceUnitAvailable(Boolean distanceUnitAvailable) {
		setValue(KEY_DISTANCE_UNIT_AVAILABLE, distanceUnitAvailable);
	}

	/**
	 * Gets the distanceUnitAvailable portion of the HMISettingsControlCapabilities class
	 *
	 * @return Boolean - Availability of the control of distance unit.
	 */
	public Boolean getDistanceUnitAvailable() {
		return getBoolean(KEY_DISTANCE_UNIT_AVAILABLE);
	}

	/**
	 * Sets the temperatureUnitAvailable portion of the HMISettingsControlCapabilities class
	 *
	 * @param temperatureUnitAvailable Availability of the control of temperature unit.
	 */
	public void setTemperatureUnitAvailable(Boolean temperatureUnitAvailable) {
		setValue(KEY_TEMPERATURE_UNIT_AVAILABLE, temperatureUnitAvailable);
	}

	/**
	 * Gets the temperatureUnitAvailable portion of the HMISettingsControlCapabilities class
	 *
	 * @return Boolean - Availability of the control of temperature unit.
	 */
	public Boolean getTemperatureUnitAvailable() {
		return getBoolean(KEY_TEMPERATURE_UNIT_AVAILABLE);
	}

	/**
	 * Sets the displayModeUnitAvailable portion of the HMISettingsControlCapabilities class
	 *
	 * @param displayModeUnitAvailable Availability of the control of HMI display mode.
	 */
	public void setDisplayModeUnitAvailable(Boolean displayModeUnitAvailable) {
		setValue(KEY_DISPLAY_MODE_UNIT_AVAILABLE, displayModeUnitAvailable);
	}

	/**
	 * Gets the displayModeUnitAvailable portion of the HMISettingsControlCapabilities class
	 *
	 * @return Boolean - Availability of the control of HMI display mode.
	 */
	public Boolean getDisplayModeUnitAvailable() {
		return getBoolean(KEY_DISPLAY_MODE_UNIT_AVAILABLE);
	}

	/**
	 * Sets ModuleInfo for this capability
	 * @param info the ModuleInfo to be set
	 */
	public void setModuleInfo(ModuleInfo info) {
		setValue(KEY_MODULE_INFO, info);
	}

	/**
	 * Gets a ModuleInfo of this capability
	 * @return module info of this capability
	 */
	public ModuleInfo getModuleInfo() {
		return (ModuleInfo) getObject(ModuleInfo.class, KEY_MODULE_INFO);
	}
}