SDL_Android/SmartDeviceLinkAndroidProxy - added the correct version of the proxy

[profile/ivi/smartdevicelink.git] / SDL_Android / SmartDeviceLinkProxyAndroid / src / com / smartdevicelink / proxy / rpc / CreateInteractionChoiceSet.java

diff --git a/SDL_Android/SmartDeviceLinkProxyAndroid/src/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java b/SDL_Android/SmartDeviceLinkProxyAndroid/src/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java
index 12c1977..d86095d 100755 (executable)
--- a/SDL_Android/SmartDeviceLinkProxyAndroid/src/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java
+++ b/SDL_Android/SmartDeviceLinkProxyAndroid/src/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java
@@ -1,51 +1,100 @@
-//
-// 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 CreateInteractionChoiceSet extends RPCRequest {
-
-    public CreateInteractionChoiceSet() {
-        super("CreateInteractionChoiceSet");
-    }
-    public CreateInteractionChoiceSet(Hashtable hash) {
-        super(hash);
-    }
-    public Integer getInteractionChoiceSetID() {
-        return (Integer) parameters.get( Names.interactionChoiceSetID );
-    }
-    public void setInteractionChoiceSetID( Integer interactionChoiceSetID ) {
-        if (interactionChoiceSetID != null) {
-            parameters.put(Names.interactionChoiceSetID, interactionChoiceSetID );
-        }
-    }
-    public Vector<Choice> getChoiceSet() {
-        if (parameters.get(Names.choiceSet) instanceof Vector<?>) {
-               Vector<?> list = (Vector<?>)parameters.get(Names.choiceSet);
-               if (list != null && list.size() > 0) {
-                   Object obj = list.get(0);
-                   if (obj instanceof Choice) {
-                       return (Vector<Choice>) list;
-                   } else if (obj instanceof Hashtable) {
-                       Vector<Choice> newList = new Vector<Choice>();
-                       for (Object hashObj : list) {
-                           newList.add(new Choice((Hashtable)hashObj));
-                       }
-                       return newList;
-                   }
-               }
-        }
-        return null;
-    }
-    public void setChoiceSet( Vector<Choice> choiceSet ) {
-        if (choiceSet != null) {
-            parameters.put(Names.choiceSet, choiceSet );
-        }
-    }
-}
+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
+/**\r
+ * Creates a Choice Set which can be used in subsequent <i>\r
+ * {@linkplain PerformInteraction}</i> Operations.\r
+ * <p>\r
+ * Function Group: Base \r
+ * <p>\r
+ * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>\r
+ * </p>\r
+ * \r
+ * @since SmartDeviceLink 1.0\r
+ * @see DeleteInteractionChoiceSet\r
+ * @see PerformInteraction\r
+ */\r
+public class CreateInteractionChoiceSet extends RPCRequest {\r
+\r
+       /**\r
+        * Constructs a new CreateInteractionChoiceSet object\r
+        */    \r
+       public CreateInteractionChoiceSet() {\r
+        super("CreateInteractionChoiceSet");\r
+    }\r
+       /**\r
+        * Constructs a new CreateInteractionChoiceSet object indicated by the\r
+        * Hashtable parameter\r
+        * <p>\r
+        * \r
+        * @param hash\r
+        *            The Hashtable to use\r
+        */     \r
+    public CreateInteractionChoiceSet(Hashtable hash) {\r
+        super(hash);\r
+    }\r
+       /**\r
+        * Gets the Choice Set unique ID\r
+        * \r
+        * @return Integer -an Integer representing the Choice Set ID\r
+        */    \r
+    public Integer getInteractionChoiceSetID() {\r
+        return (Integer) parameters.get( Names.interactionChoiceSetID );\r
+    }\r
+       /**\r
+        * Sets a unique ID that identifies the Choice Set\r
+        * \r
+        * @param interactionChoiceSetID\r
+        *            an Integer value representing the Choice Set ID\r
+        *            <p>\r
+        *            <b>Notes: </b>Min Value: 0; Max Value: 2000000000\r
+        */    \r
+    public void setInteractionChoiceSetID( Integer interactionChoiceSetID ) {\r
+        if (interactionChoiceSetID != null) {\r
+            parameters.put(Names.interactionChoiceSetID, interactionChoiceSetID );\r
+        }\r
+    }\r
+       /**\r
+        * Gets Choice Set Array of one or more elements\r
+        * \r
+        * @return Vector<Choice> -a Vector<Choice> representing the array of one or\r
+        *         more elements\r
+        */    \r
+    public Vector<Choice> getChoiceSet() {\r
+        if (parameters.get(Names.choiceSet) instanceof Vector<?>) {\r
+               Vector<?> list = (Vector<?>)parameters.get(Names.choiceSet);\r
+               if (list != null && list.size() > 0) {\r
+                   Object obj = list.get(0);\r
+                   if (obj instanceof Choice) {\r
+                       return (Vector<Choice>) list;\r
+                   } else if (obj instanceof Hashtable) {\r
+                       Vector<Choice> newList = new Vector<Choice>();\r
+                       for (Object hashObj : list) {\r
+                           newList.add(new Choice((Hashtable)hashObj));\r
+                       }\r
+                       return newList;\r
+                   }\r
+               }\r
+        }\r
+        return null;\r
+    }\r
+       /**\r
+        * Sets a Choice Set that is an Array of one or more elements\r
+        * \r
+        * @param choiceSet\r
+        *            a Vector<Choice> representing the array of one or more\r
+        *            elements\r
+        *            <p>\r
+        *            <b>Notes: </b>Min Value: 1; Max Value: 100\r
+        */    \r
+    public void setChoiceSet( Vector<Choice> choiceSet ) {\r
+        if (choiceSet != null) {\r
+            parameters.put(Names.choiceSet, choiceSet );\r
+        }\r
+    }\r
+}\r