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
156
157
158
|
package com.smartdevicelink.proxy.rpc;
import com.smartdevicelink.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCRequest;
import java.util.Hashtable;
/**
* <p>Add a SubMenu to the Command Menu</p>
*
* <p>A SubMenu can only be added to the Top Level Menu (i.e.a SubMenu cannot be
* added to a SubMenu), and may only contain commands as children</p>
*
*
* <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUD</b></p>
*
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
* <th>Type</th>
* <th>Description</th>
* <th> Req.</th>
* <th>Notes</th>
* <th>Version Available</th>
* </tr>
* <tr>
* <td>menuID</td>
* <td>Integer</td>
* <td>Unique ID that identifies this sub menu. This value is used in AddCommand to which SubMenu is the parent of the command being added.</td>
* <td>Y</td>
* <td></td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>position</td>
* <td>Integer</td>
* <td>Position within the items of the top level Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc. Position of any submenu will always be located before the return and exit options.</td>
* <td>N</td>
* <td>Min Value: 0 <p>Max Value: 1000</p> <p>If position is greater or equal than the number of items on top level, the sub menu will be appended by the end.</p><p>If this parameter is omitted, the entry will be added at the end of the list.</P></td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>menuName</td>
* <td>String</td>
* <td>Text which is displayed representing this submenu item</td>
* <td>Y</td>
* <td>maxlength:500</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* </table>
* <b>Response</b>
* <p>Indicates that the corresponding request either failed or succeeded. If the response returns with a SUCCESS result code, this means the SubMenu was added to the Command Menu successfully</p>
*
* <p><b>Non-default Result Codes:</b></p>
* <p>INVALID_ID</p>
* <p>DUPLICATE NAME</p>
* @since SmartDeviceLink 1.0
* @see DeleteSubMenu
* @see AddCommand
* @see DeleteCommand
*/
public class AddSubMenu extends RPCRequest {
public static final String KEY_POSITION = "position";
public static final String KEY_MENU_NAME = "menuName";
public static final String KEY_MENU_ID = "menuID";
/**
* Constructs a new AddSubMenu object
*/
public AddSubMenu() {
super(FunctionID.ADD_SUB_MENU.toString());
}
/**
* Constructs a new AddSubMenu object indicated by the Hashtable parameter
*
*
* @param hash
* The Hashtable to use
*/
public AddSubMenu(Hashtable<String, Object> hash) {
super(hash);
}
/**
* Returns an <i>Integer</i> object representing the Menu ID that identifies
* a sub menu
*
*
* @return Integer -an integer representing the Menu ID that identifies a sub
* menu
*/
public Integer getMenuID() {
return getInteger( KEY_MENU_ID );
}
/**
* <p>Sets a Menu ID that identifies a sub menu.</p><p> This value is used in
* {@linkplain AddCommand} to which SubMenu is the parent of the command
* being added</p>
*
*
* @param menuID
* an integer object representing a Menu ID
*
* <p><b>Notes:</b> Min Value: 0; Max Value: 2000000000</p>
*/
public void setMenuID( Integer menuID ) {
setParameters(KEY_MENU_ID, menuID);
}
/**
* <p>Returns an <i>Integer</i> object representing the position of menu</p>
*
*
* @return Integer -the value representing the relative position of menus
*/
public Integer getPosition() {
return getInteger( KEY_POSITION );
}
/**
* Sets a position of menu
*
* @param position
* <p>An Integer object representing the position within the items
* of the top level Command Menu. 0 will insert at the front, 1
* will insert after the first existing element, etc. Position of
* any submenu will always be located before the return and exit
* options
* </p>
* <b>Notes: </b>
* <ul>
* <li>
* Min Value: 0; Max Value: 1000</li>
* <li>If position is greater than or equal to the number of items
* on top level, the sub menu will be appended by the end</li>
* <li>If this parameter is omitted, the entry will be added at
* the end of the list</li>
* </ul>
*/
public void setPosition( Integer position ) {
setParameters(KEY_POSITION, position);
}
/**
* Returns String which is displayed representing this submenu item
*
* @return String -a Submenu item's name
*/
public String getMenuName() {
return getString( KEY_MENU_NAME );
}
/**
* Sets a menuName which is displayed representing this submenu item
*
* @param menuName
* String which will be displayed representing this submenu item
*/
public void setMenuName( String menuName ) {
setParameters(KEY_MENU_NAME, menuName);
}
}
|
