SDL_Android/SmartDeviceLinkProxyAndroid/src/com/smartdevicelink/proxy/rpc/enums/Result.java

   1 package com.smartdevicelink.proxy.rpc.enums;\r
   2 \r
   3 /**\r
   4  * Defines the possible result codes returned by SMARTDEVICELINK to the application in a\r
   5  * Response to a requested operation\r
   6  * <p>\r
   7  * \r
   8  * @since SmartDeviceLink 1.0\r
   9  */\r
  10 public enum Result {\r
  11         /**\r
  12          * The request succeeded\r
  13          */    \r
  14         SUCCESS,\r
  15         /**\r
  16          * The data sent is invalid. For example:<br/>\r
  17          * <ul>\r
  18          * <li>Invalid Json syntax</li>\r
  19          * <li>Parameters out of bounds (number or enum range)</li>\r
  20          * <li>Mandatory parameters not provided</li>\r
  21          * <li>Parameter provided with wrong type</li>\r
  22          * <li>Invalid characters</li>\r
  23          * <li>Empty string</li>\r
  24          * </ul>\r
  25          */    \r
  26         INVALID_DATA,\r
  27         /**\r
  28          * The request is not supported by SMARTDEVICELINK\r
  29          */    \r
  30         UNSUPPORTED_REQUEST,\r
  31         /**\r
  32          * The system could not process the request because the necessary memory\r
  33          * couldn't be allocated\r
  34          */    \r
  35         OUT_OF_MEMORY,\r
  36         /**\r
  37          * There are too many requests pending (means that the response has not been\r
  38          * delivered yet). There is a limit of 1000 pending requests at a time\r
  39          */    \r
  40         TOO_MANY_PENDING_REQUESTS,\r
  41         /**\r
  42          * One of the provided IDs is not valid. For example:<br/>\r
  43          * <ul>\r
  44          * <li>CorrelationID</li>\r
  45          * <li>CommandID</li>\r
  46          * <li>MenuID</li>\r
  47          * </ul>\r
  48          */\r
  49         INVALID_ID,\r
  50         /**\r
  51          * The provided name or synonym is a duplicate of some already-defined name\r
  52          * or synonym\r
  53          */    \r
  54     DUPLICATE_NAME,\r
  55         /**\r
  56          * Specified application name is already associated with an active interface\r
  57          * registration. Attempts at doing a second <i>\r
  58          * {@linkplain com.smartdevicelink.proxy.rpc.RegisterAppInterface}</i> on a\r
  59          * given protocol session will also cause this\r
  60          */    \r
  61     TOO_MANY_APPLICATIONS,\r
  62         /**\r
  63          * SMARTDEVICELINK does not support the interface version requested by the mobile\r
  64          * application\r
  65          */    \r
  66     APPLICATION_REGISTERED_ALREADY,\r
  67         /**\r
  68          * The requested language is currently not supported. Might be because of a\r
  69          * mismatch of the currently active language\r
  70          */    \r
  71     UNSUPPORTED_VERSION,\r
  72         /**\r
  73          * The request cannot be executed because no application interface has been\r
  74          * registered via <i>\r
  75          * {@linkplain com.smartdevicelink.proxy.rpc.RegisterAppInterface}</i>\r
  76          */    \r
  77         WRONG_LANGUAGE,\r
  78         /**\r
  79          * The request cannot be executed because no application interface has been\r
  80          * registered via <i>\r
  81          * {@linkplain com.smartdevicelink.proxy.rpc.RegisterAppInterface}</i>\r
  82          */\r
  83         APPLICATION_NOT_REGISTERED,\r
  84         /**\r
  85          * The data may not be changed, because it is currently in use. For example,\r
  86          * when trying to delete a Choice Set that is currently involved in an\r
  87          * interaction\r
  88          */\r
  89         IN_USE,\r
  90         /**\r
  91          * There is already an existing subscription for this item\r
  92          */\r
  93     VEHICLE_DATA_NOT_ALLOWED,\r
  94         VEHICLE_DATA_NOT_AVAILABLE,\r
  95         /**\r
  96          * The requested operation was rejected. No attempt was made to perform the\r
  97          * operation\r
  98          */\r
  99         REJECTED,\r
 100         /**\r
 101          * The requested operation was aborted due to some pre-empting event (e.g.\r
 102          * button push, <i>{@linkplain com.smartdevicelink.proxy.rpc.Alert}</i>\r
 103          * pre-empts <i>{@linkplain com.smartdevicelink.proxy.rpc.Speak}</i>, etc.)\r
 104          */\r
 105         ABORTED,\r
 106         /**\r
 107          * The requested operation was ignored because it was determined to be\r
 108          * redundant (e.g. pause media clock when already paused)\r
 109          */\r
 110         IGNORED,\r
 111         /**\r
 112          * A button that was requested for subscription is not supported on the\r
 113          * currently connected SMARTDEVICELINK platform. See DisplayCapabilities for further\r
 114          * information on supported buttons on the currently connected SMARTDEVICELINK platform\r
 115          */\r
 116     UNSUPPORTED_RESOURCE,\r
 117     FILE_NOT_FOUND,\r
 118     GENERIC_ERROR,\r
 119     DISALLOWED,\r
 120     USER_DISALLOWED,\r
 121     TIMED_OUT,\r
 122     CANCEL_ROUTE,\r
 123     TRUNCATED_DATA,\r
 124     RETRY,\r
 125     WARNINGS;\r
 126 \r
 127     public static Result valueForString(String value) {\r
 128         return valueOf(value);\r
 129     }\r
 130 }\r