blob: 97793558fb70f12efe83d9d6c430bb2994b7a093 (
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
156
157
158
159
160
161
|
package com.smartdevicelink.proxy.rpc;
import java.util.ArrayList;
import java.util.Hashtable;
import java.util.List;
import com.smartdevicelink.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCRequest;
/**
* Creates a Choice Set which can be used in subsequent <i>
* {@linkplain PerformInteraction}</i> Operations.
*
* <p>Function Group: Base </p>
*
* <p><b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b></p>
*
* <p>AudioStreamingState : ANY</p>
*
* <p>SystemContext: MAIN, MENU, VR</p>
*
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
* <th>Type</th>
* <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
* <th>Version</th>
* </tr>
* <tr>
* <td>interactionChoiceSetID</td>
* <td>Integer</td>
* <td>A unique ID that identifies the Choice Set</td>
* <td>Y</td>
* <td>Min Value: 0; Max Value: 2000000000</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>choiceSet</td>
* <td>Choice[]</td>
* <td>Array of one or more elements.</td>
* <td>Y</td>
* <td>Min Value: 1; Max Value: 100</td>
* <td>SmartDeviceLink 1.0 </td>
* </tr>
* </table>
*
*
* <p> <b>Note:</b></p>Second Utterance issue with CreateInteractionChoiceSet RPC. Before a perform interaction
* is sent you MUST wait for the success from the CreateInteractionChoiceSet RPC.
* If you do not wait the system may not recognize the first utterance from the user.
*
* <p><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 Choice Set was created.
*
* <p><b>Non-default Result Codes:</b></p>
* <p>SUCCESS</p>
* <p>INVALID_DATA</p>
* <p>OUT_OF_MEMORY</p>
* <p>TOO_MANY_PENDING_REQUESTS</p>
* <p>APPLICATION_NOT_REGISTERED</p>
* <p>GENERIC_ERROR</p>
* <p> REJECTED</p>
* <p> INVALID_ID</p>
* <p> DUPLICATE_NAME</p>
* <p>UNSUPPORTED_RESOURCE </p>
*
*
* @since SmartDeviceLink 1.0
* @see DeleteInteractionChoiceSet
* @see PerformInteraction
*/
public class CreateInteractionChoiceSet extends RPCRequest {
public static final String KEY_CHOICE_SET = "choiceSet";
public static final String KEY_INTERACTION_CHOICE_SET_ID = "interactionChoiceSetID";
/**
* Constructs a new CreateInteractionChoiceSet object
*/
public CreateInteractionChoiceSet() {
super(FunctionID.CREATE_INTERACTION_CHOICE_SET.toString());
}
/**
* <p>Constructs a new CreateInteractionChoiceSet object indicated by the
* Hashtable parameter</p>
*
*
* @param hash
* The Hashtable to use
*/
public CreateInteractionChoiceSet(Hashtable<String, Object> hash) {
super(hash);
}
/**
* Gets the Choice Set unique ID
*
* @return Integer -an Integer representing the Choice Set ID
*/
public Integer getInteractionChoiceSetID() {
return (Integer) parameters.get( KEY_INTERACTION_CHOICE_SET_ID );
}
/**
* Sets a unique ID that identifies the Choice Set
*
* @param interactionChoiceSetID
* an Integer value representing the Choice Set ID
*
* <b>Notes: </b>Min Value: 0; Max Value: 2000000000
*/
public void setInteractionChoiceSetID( Integer interactionChoiceSetID ) {
if (interactionChoiceSetID != null) {
parameters.put(KEY_INTERACTION_CHOICE_SET_ID, interactionChoiceSetID );
} else {
parameters.remove(KEY_INTERACTION_CHOICE_SET_ID);
}
}
/**
* Gets Choice Set Array of one or more elements
*
* @return List<Choice> -a List<Choice> representing the array of one or
* more elements
*/
@SuppressWarnings("unchecked")
public List<Choice> getChoiceSet() {
if (parameters.get(KEY_CHOICE_SET) instanceof List<?>) {
List<?> list = (List<?>)parameters.get(KEY_CHOICE_SET);
if (list != null && list.size() > 0) {
Object obj = list.get(0);
if (obj instanceof Choice) {
return (List<Choice>) list;
} else if (obj instanceof Hashtable) {
List<Choice> newList = new ArrayList<Choice>();
for (Object hashObj : list) {
newList.add(new Choice((Hashtable<String, Object>)hashObj));
}
return newList;
}
}
}
return null;
}
/**
* Sets a Choice Set that is an Array of one or more elements
*
* @param choiceSet
* a List<Choice> representing the array of one or more
* elements
*
* <b>Notes: </b>Min Value: 1; Max Value: 100
*/
public void setChoiceSet( List<Choice> choiceSet ) {
if (choiceSet != null) {
parameters.put(KEY_CHOICE_SET, choiceSet );
} else {
parameters.remove(KEY_CHOICE_SET);
}
}
}
|
