-//
-// Copyright (c) 2013 Ford Motor Company
-//
-package com.smartdevicelink.proxy.rpc;
-
-import java.util.Hashtable;
-
-import com.smartdevicelink.proxy.RPCRequest;
-import com.smartdevicelink.proxy.constants.Names;
-
-public class DeleteSubMenu extends RPCRequest {
-
- public DeleteSubMenu() {
- super("DeleteSubMenu");
- }
- public DeleteSubMenu(Hashtable hash) {
- super(hash);
- }
- public Integer getMenuID() {
- return (Integer) parameters.get( Names.menuID );
- }
- public void setMenuID( Integer menuID ) {
- if (menuID != null) {
- parameters.put(Names.menuID, menuID );
- }
- }
-}
+package com.smartdevicelink.proxy.rpc;\r
+\r
+import java.util.Hashtable;\r
+\r
+import com.smartdevicelink.proxy.RPCRequest;\r
+import com.smartdevicelink.proxy.constants.Names;\r
+\r
+/**\r
+ * Deletes a submenu from the Command Menu\r
+ * <p>\r
+ * <b>Notes: </b>When an app deletes a submenu that has child commands, those\r
+ * child commands are also deleted\r
+ * <p>\r
+ * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>\r
+ * </p>\r
+ * \r
+ * @since SmartDeviceLink 1.0\r
+ * @see AddCommand\r
+ * @see AddSubMenu\r
+ * @see DeleteCommand\r
+ */\r
+public class DeleteSubMenu extends RPCRequest {\r
+ /**\r
+ * Constructs a new DeleteSubMenu object\r
+ */\r
+ public DeleteSubMenu() {\r
+ super("DeleteSubMenu");\r
+ }\r
+ /**\r
+ * Constructs a new DeleteSubMenu object indicated by the Hashtable parameter<p> \r
+ * @param hash The Hashtable to use\r
+ */\r
+ public DeleteSubMenu(Hashtable hash) {\r
+ super(hash);\r
+ }\r
+ /**\r
+ * Gets the Menu ID that identifies the SubMenu to be delete\r
+ * @return Integer -an Integer value representing menuID that identifies the SubMenu to be delete\r
+ */ \r
+ public Integer getMenuID() {\r
+ return (Integer) parameters.get( Names.menuID );\r
+ }\r
+ /**\r
+ * Sets the MenuID that identifies the SubMenu to be delete \r
+ * @param menuID an Integer value representing menuID that identifies the SubMenu to be delete\r
+ * <p>\r
+ * <b>Notes: </b>Min Value: 0; Max Value: 2000000000\r
+ */ \r
+ public void setMenuID( Integer menuID ) {\r
+ if (menuID != null) {\r
+ parameters.put(Names.menuID, menuID );\r
+ }\r
+ }\r
+}
\ No newline at end of file