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
|
/*
* 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 com.smartdevicelink.proxy.rpc.enums.HMILevel;
import java.util.Hashtable;
import java.util.List;
/**
* Defining sets of HMI levels, which are permitted or prohibited for a given RPC.
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
* <th>Type</th>
* <th>Description</th>
* <th>SmartDeviceLink Ver. Available</th>
* </tr>
* <tr>
* <td>allowed</td>
* <td>HMILevel</td>
* <td>A set of all HMI levels that are permitted for this given RPC.
* <ul>
* <li>Min: 0</li>
* <li>Max: 100</li>
* </ul>
* </td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
* <td>userDisallowed</td>
* <td>HMILevel</td>
* <td>A set of all HMI levels that are prohibited for this given RPC.
* <ul>
* <li>Min: 0</li>
* <li>Max: 100</li>
* </ul>
* </td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* </table>
*
* @since SmartDeviceLink 2.0
*/
public class HMIPermissions extends RPCStruct {
public static final String KEY_ALLOWED = "allowed";
public static final String KEY_USER_DISALLOWED = "userDisallowed";
/**
* Constructs a newly allocated HMIPermissions object
*/
public HMIPermissions() {
}
/**
* Constructs a newly allocated HMIPermissions object indicated by the Hashtable parameter
*
* @param hash The Hashtable to use
*/
public HMIPermissions(Hashtable<String, Object> hash) {
super(hash);
}
/**
* Constructs a newly allocated HMIPermissions object
*
* @param allowed HMI level that is permitted for this given RPC
* @param userDisallowed HMI level that is prohibited for this given RPC
*/
public HMIPermissions(@NonNull List<HMILevel> allowed, @NonNull List<HMILevel> userDisallowed) {
this();
setAllowed(allowed);
setUserDisallowed(userDisallowed);
}
/**
* get a set of all HMI levels that are permitted for this given RPC.
*
* @return a set of all HMI levels that are permitted for this given RPC
*/
@SuppressWarnings("unchecked")
public List<HMILevel> getAllowed() {
return (List<HMILevel>) getObject(HMILevel.class, KEY_ALLOWED);
}
/**
* set HMI level that is permitted for this given RPC.
*
* @param allowed HMI level that is permitted for this given RPC
*/
public HMIPermissions setAllowed(@NonNull List<HMILevel> allowed) {
setValue(KEY_ALLOWED, allowed);
return this;
}
/**
* get a set of all HMI levels that are prohibited for this given RPC
*
* @return a set of all HMI levels that are prohibited for this given RPC
*/
@SuppressWarnings("unchecked")
public List<HMILevel> getUserDisallowed() {
return (List<HMILevel>) getObject(HMILevel.class, KEY_USER_DISALLOWED);
}
/**
* set a set of all HMI levels that are prohibited for this given RPC
*
* @param userDisallowed HMI level that is prohibited for this given RPC
*/
public HMIPermissions setUserDisallowed(@NonNull List<HMILevel> userDisallowed) {
setValue(KEY_USER_DISALLOWED, userDisallowed);
return this;
}
}
|
