SDL_Android/SmartDeviceLinkProxyAndroid/src/com/smartdevicelink/proxy/rpc/DeleteInteractionChoiceSet.java

   1 package com.smartdevicelink.proxy.rpc;\r
   2 \r
   3 import java.util.Hashtable;\r
   4 \r
   5 import com.smartdevicelink.proxy.RPCRequest;\r
   6 import com.smartdevicelink.proxy.constants.Names;\r
   7 \r
   8 /**\r
   9  * Deletes an existing Choice Set identified by the parameter\r
  10  * interactionChoiceSetID. If the specified interactionChoiceSetID is currently\r
  11  * in use by an active <i> {@linkplain PerformInteraction}</i> this call to\r
  12  * delete the Choice Set will fail returning an IN_USE resultCode\r
  13  * <p>\r
  14  * Function Group: Base\r
  15  * <p>\r
  16  * <b>HMILevel needs to be FULL, LIMITED or BACKGROUD</b><br/>\r
  17  * </p>\r
  18  * \r
  19  * @since SmartDeviceLink 1.0\r
  20  * @see CreateInteractionChoiceSet\r
  21  * @see PerformInteraction\r
  22  */\r
  23 public class DeleteInteractionChoiceSet extends RPCRequest {\r
  24 \r
  25         /**\r
  26          * Constructs a new DeleteInteractionChoiceSet object\r
  27          */\r
  28     public DeleteInteractionChoiceSet() {\r
  29         super("DeleteInteractionChoiceSet");\r
  30     }\r
  31         /**\r
  32          * Constructs a new DeleteInteractionChoiceSet object indicated by the\r
  33          * Hashtable parameter\r
  34          * <p>\r
  35          * \r
  36          * @param hash\r
  37          *            The Hashtable to use\r
  38          */    \r
  39     public DeleteInteractionChoiceSet(Hashtable hash) {\r
  40         super(hash);\r
  41     }\r
  42         /**\r
  43          * Gets a unique ID that identifies the Choice Set\r
  44          * @return Integer -an Integer value representing the unique Choice Set ID\r
  45          */    \r
  46     public Integer getInteractionChoiceSetID() {\r
  47         return (Integer) parameters.get( Names.interactionChoiceSetID );\r
  48     }\r
  49         /**\r
  50          * Sets a unique ID that identifies the Choice Set\r
  51          * @param interactionChoiceSetID a unique ID that identifies the Choice Set\r
  52          * <p>\r
  53          * <b>Notes: </b>Min Value: 0; Max Value: 2000000000\r
  54          */    \r
  55     public void setInteractionChoiceSetID( Integer interactionChoiceSetID ) {\r
  56         if (interactionChoiceSetID != null) {\r
  57             parameters.put(Names.interactionChoiceSetID, interactionChoiceSetID );\r
  58         }\r
  59     }\r
  60 }