-//
-// Copyright (c) 2013 Ford Motor Company
-//
-package com.smartdevicelink.proxy.rpc;
-
-import java.util.Hashtable;
-import java.util.Vector;
-
-import com.smartdevicelink.proxy.RPCRequest;
-import com.smartdevicelink.proxy.constants.Names;
-
-public class SetGlobalProperties extends RPCRequest {
-
- public SetGlobalProperties() {
- super("SetGlobalProperties");
- }
- public SetGlobalProperties(Hashtable hash) {
- super(hash);
- }
- public Vector<TTSChunk> getHelpPrompt() {
- if (parameters.get(Names.helpPrompt) instanceof Vector<?>) {
- Vector<?> list = (Vector<?>)parameters.get(Names.helpPrompt);
- if (list != null && list.size() > 0) {
- Object obj = list.get(0);
- if (obj instanceof TTSChunk) {
- return (Vector<TTSChunk>) list;
- } else if (obj instanceof Hashtable) {
- Vector<TTSChunk> newList = new Vector<TTSChunk>();
- for (Object hashObj : list) {
- newList.add(new TTSChunk((Hashtable)hashObj));
- }
- return newList;
- }
- }
- }
- return null;
- }
- public void setHelpPrompt( Vector<TTSChunk> helpPrompt ) {
- if (helpPrompt != null) {
- parameters.put(Names.helpPrompt, helpPrompt );
- }
- }
- public Vector<TTSChunk> getTimeoutPrompt() {
- if (parameters.get(Names.timeoutPrompt) instanceof Vector<?>) {
- Vector<?> list = (Vector<?>)parameters.get(Names.timeoutPrompt);
- if (list != null && list.size() > 0) {
- Object obj = list.get(0);
- if (obj instanceof TTSChunk) {
- return (Vector<TTSChunk>) list;
- } else if (obj instanceof Hashtable) {
- Vector<TTSChunk> newList = new Vector<TTSChunk>();
- for (Object hashObj : list) {
- newList.add(new TTSChunk((Hashtable)hashObj));
- }
- return newList;
- }
- }
- }
- return null;
- }
- public void setTimeoutPrompt( Vector<TTSChunk> timeoutPrompt ) {
- if (timeoutPrompt != null) {
- parameters.put(Names.timeoutPrompt, timeoutPrompt );
- }
- }
-}
+package com.smartdevicelink.proxy.rpc;\r
+\r
+import java.util.Hashtable;\r
+import java.util.Vector;\r
+\r
+import com.smartdevicelink.proxy.RPCRequest;\r
+import com.smartdevicelink.proxy.constants.Names;\r
+/**\r
+ * Sets value(s) for the specified global property(ies)\r
+ * <p>\r
+ * Function Group: Base <p>\r
+ * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>\r
+ * </p>\r
+ * \r
+ * @since SmartDeviceLink 1.0\r
+ * @see ResetGlobalProperties\r
+ */\r
+public class SetGlobalProperties extends RPCRequest {\r
+ /**\r
+ * Constructs a new SetGlobalProperties object\r
+ */\r
+ public SetGlobalProperties() {\r
+ super("SetGlobalProperties");\r
+ }\r
+ /**\r
+ * Constructs a new SetGlobalProperties object indicated by the Hashtable\r
+ * parameter\r
+ * <p>\r
+ * \r
+ * @param hash\r
+ * The Hashtable to use\r
+ */ \r
+ public SetGlobalProperties(Hashtable hash) {\r
+ super(hash);\r
+ }\r
+ /**\r
+ * Gets a Vector<TTSChunk> for Help Prompt representing Array of one or more\r
+ * TTSChunk elements specifying the help prompt used in an interaction\r
+ * started by PTT\r
+ * \r
+ * @return Vector<TTSChunk> -an Array of one or more TTSChunk elements\r
+ * specifying the help prompt used in an interaction started by PTT\r
+ */ \r
+ public Vector<TTSChunk> getHelpPrompt() {\r
+ if (parameters.get(Names.helpPrompt) instanceof Vector<?>) {\r
+ Vector<?> list = (Vector<?>)parameters.get(Names.helpPrompt);\r
+ if (list != null && list.size() > 0) {\r
+ Object obj = list.get(0);\r
+ if (obj instanceof TTSChunk) {\r
+ return (Vector<TTSChunk>) list;\r
+ } else if (obj instanceof Hashtable) {\r
+ Vector<TTSChunk> newList = new Vector<TTSChunk>();\r
+ for (Object hashObj : list) {\r
+ newList.add(new TTSChunk((Hashtable)hashObj));\r
+ }\r
+ return newList;\r
+ }\r
+ }\r
+ }\r
+ return null;\r
+ }\r
+ /**\r
+ * Sets a Vector<TTSChunk> for Help Prompt that Array of one or more\r
+ * TTSChunk elements specifying the help prompt used in an interaction\r
+ * started by PTT\r
+ * \r
+ * @param helpPrompt\r
+ * a Vector<TTSChunk> of one or more TTSChunk elements\r
+ * <p>\r
+ * <b>Notes: </b>\r
+ * <ul>\r
+ * <li>Array must have at least one element</li>\r
+ * <li>Only optional it timeoutPrompt has been specified</li>\r
+ * </ul>\r
+ */ \r
+ public void setHelpPrompt(Vector<TTSChunk> helpPrompt) {\r
+ if (helpPrompt != null) {\r
+ parameters.put(Names.helpPrompt, helpPrompt);\r
+ }\r
+ }\r
+ /**\r
+ * Gets a Vector<TTSChunk> for Timeout Prompt representing Array of one or\r
+ * more TTSChunk elements specifying the help prompt used in an interaction\r
+ * started by PTT\r
+ * \r
+ * @return Vector<TTSChunk> -an Array of one or more TTSChunk elements\r
+ * specifying the help prompt used in an interaction started by PTT\r
+ */ \r
+ public Vector<TTSChunk> getTimeoutPrompt() {\r
+ if (parameters.get(Names.timeoutPrompt) instanceof Vector<?>) {\r
+ Vector<?> list = (Vector<?>)parameters.get(Names.timeoutPrompt);\r
+ if (list != null && list.size() > 0) {\r
+ Object obj = list.get(0);\r
+ if (obj instanceof TTSChunk) {\r
+ return (Vector<TTSChunk>) list;\r
+ } else if (obj instanceof Hashtable) {\r
+ Vector<TTSChunk> newList = new Vector<TTSChunk>();\r
+ for (Object hashObj : list) {\r
+ newList.add(new TTSChunk((Hashtable)hashObj));\r
+ }\r
+ return newList;\r
+ }\r
+ }\r
+ }\r
+ return null;\r
+ }\r
+ /**\r
+ * Sets a Vector<TTSChunk> for Timeout Prompt representing Array of one or\r
+ * more TTSChunk elements specifying the help prompt used in an interaction\r
+ * started by PTT\r
+ * \r
+ */ \r
+ public void setTimeoutPrompt(Vector<TTSChunk> timeoutPrompt) {\r
+ if (timeoutPrompt != null) {\r
+ parameters.put(Names.timeoutPrompt, timeoutPrompt);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Gets a voice recognition Help Title\r
+ * \r
+ * @return String - a String value representing the text, which is shown as\r
+ * title of the VR help screen used in an interaction started by PTT\r
+ * @since SmartDeviceLink 2.0\r
+ */\r
+ public String getVrHelpTitle() {\r
+ return (String) parameters.get(Names.vrHelpTitle);\r
+ }\r
+\r
+ /**\r
+ * Sets a voice recognition Help Title\r
+ * \r
+ * @param vrHelpTitle\r
+ * a String value representing a voice recognition Help Title\r
+ * <p>\r
+ * <b>Notes: </b><br/>\r
+ * <ul>\r
+ * <li>If omitted on supported displays, the default SMARTDEVICELINK help\r
+ * title will be used</li>\r
+ * <li>If omitted and one or more vrHelp items are provided, the\r
+ * request will be rejected.</li>\r
+ * <li>String Maxlength = 500</li>\r
+ * </ul>\r
+ * @since SmartDeviceLink 2.0\r
+ */\r
+ public void setVrHelpTitle(String vrHelpTitle) {\r
+ if (vrHelpTitle != null) {\r
+ parameters.put(Names.vrHelpTitle, vrHelpTitle);\r
+ } else {\r
+ parameters.remove(Names.vrHelpTitle);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Gets items listed in the VR help screen used in an interaction started by\r
+ * PTT\r
+ * \r
+ * @return Vector<VrHelpItem> - a Vector value representing items listed in\r
+ * the VR help screen used in an interaction started by PTT\r
+ * @since SmartDeviceLink 2.0\r
+ */\r
+ public Vector<VrHelpItem> getVrHelp() {\r
+ if (parameters.get(Names.vrHelp) instanceof Vector<?>) {\r
+ Vector<?> list = (Vector<?>)parameters.get(Names.vrHelp);\r
+ if (list != null && list.size() > 0) {\r
+ Object obj = list.get(0);\r
+ if (obj instanceof VrHelpItem) {\r
+ return (Vector<VrHelpItem>) list;\r
+ } else if (obj instanceof Hashtable) {\r
+ Vector<VrHelpItem> newList = new Vector<VrHelpItem>();\r
+ for (Object hashObj : list) {\r
+ newList.add(new VrHelpItem((Hashtable)hashObj));\r
+ }\r
+ return newList;\r
+ }\r
+ }\r
+ }\r
+ return null;\r
+ }\r
+\r
+ /**\r
+ * Sets the items listed in the VR help screen used in an interaction\r
+ * started by PTT\r
+ * \r
+ * @param vrHelp\r
+ * a Vector value representing items listed in the VR help screen\r
+ * used in an interaction started by PTT\r
+ * <p>\r
+ * <b>Notes: </b><br/>\r
+ * <ul>\r
+ * <li>If omitted on supported displays, the default SmartDeviceLink VR\r
+ * help / What Can I Say? screen will be used</li>\r
+ * <li>If the list of VR Help Items contains nonsequential\r
+ * positions (e.g. [1,2,4]), the RPC will be rejected</li>\r
+ * <li>If omitted and a vrHelpTitle is provided, the request\r
+ * will be rejected</li>\r
+ * <li>Array Minsize: = 1</li>\r
+ * <li>Array Maxsize = 100</li>\r
+ * </ul>\r
+ * @since SmartDeviceLink 2.0\r
+ */\r
+ public void setVrHelp(Vector<VrHelpItem> vrHelp) {\r
+ if (vrHelp != null) {\r
+ parameters.put(Names.vrHelp, vrHelp);\r
+ } else {\r
+ parameters.remove(Names.vrHelp);\r
+ }\r
+ }\r
+}\r
projects / profile / ivi / smartdevicelink.git / blobdiff