SDL_Android/SmartDeviceLinkProxyAndroid/src/com/smartdevicelink/proxy/rpc/DeleteCommand.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  * Removes a command from the Command Menu\r
  10  * <p>\r
  11  * <b>HMI Status Requirements:</b><br/>\r
  12  * HMILevel: FULL, LIMITED or BACKGROUND<br/>\r
  13  * AudioStreamingState: N/A<br/>\r
  14  * SystemContext: Should not be attempted when VRSESSION or MENU\r
  15  * </p>\r
  16  * \r
  17  * @since SmartDeviceLink 1.0\r
  18  * @see AddCommand\r
  19  * @see AddSubMenu\r
  20  * @see DeleteSubMenu\r
  21  */\r
  22 public class DeleteCommand extends RPCRequest {\r
  23 \r
  24         /**\r
  25          * Constructs a new DeleteCommand object\r
  26          */\r
  27         public DeleteCommand() {\r
  28         super("DeleteCommand");\r
  29     }\r
  30         /**\r
  31          * Constructs a new DeleteCommand object indicated by the Hashtable\r
  32          * parameter\r
  33          * <p>\r
  34          * \r
  35          * @param hash\r
  36          *            The Hashtable to use\r
  37          */    \r
  38         public DeleteCommand(Hashtable hash) {\r
  39         super(hash);\r
  40     }\r
  41         /**\r
  42          * Gets the Command ID that identifies the Command to be deleted from\r
  43          * Command Menu\r
  44          * \r
  45          * @return Integer - Integer value representing Command ID that identifies\r
  46          *         the Command to be deleted from Command Menu\r
  47          */     \r
  48     public Integer getCmdID() {\r
  49         return (Integer) parameters.get( Names.cmdID );\r
  50     }\r
  51         /**\r
  52          * Sets the Command ID that identifies the Command to be deleted from Command Menu\r
  53          * \r
  54          * @param cmdID\r
  55          *            an Integer value representing Command ID\r
  56          *            <p>\r
  57          *            <b>Notes: </b>Min Value: 0; Max Value: 2000000000\r
  58          */    \r
  59     public void setCmdID( Integer cmdID ) {\r
  60         if (cmdID != null) {\r
  61             parameters.put(Names.cmdID, cmdID );\r
  62         }\r
  63     }\r
  64 }