com.smartdevicelink.proxy.rpc

Class GenericResponse

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCResponse

com.smartdevicelink.proxy.rpc.GenericResponse

All Implemented Interfaces:

Cloneable

public class GenericResponse
extends RPCResponse

Generic Response is sent, when the name of a received msg cannot be retrieved. Only used in case of an error. Currently, only resultCode INVALID_DATA is used.

Parameter List

Param Name	Type	Description	Req.	Notes	Version Available
success	Boolean	true, if successful; false, if failed			SmartDeviceLink 1.0
resultCode	Result	Defines the possible result codes returned by SDL to the application in a Response to a requested operation			SmartDeviceLink 1.0
info	String	Provides additional human readable info regarding the result.	N	maxlength=1000	SmartDeviceLink 1.0

Since:

SmartDeviceLink 1.0

Field Summary

Fields inherited from class com.smartdevicelink.proxy.RPCResponse

KEY_INFO, KEY_RESULT_CODE, KEY_SUCCESS

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
GenericResponse()
GenericResponse(Boolean success, Result resultCode) Constructs a new GenericResponse object
GenericResponse(Hashtable<String,Object> hash)

Method Summary

Methods inherited from class com.smartdevicelink.proxy.RPCResponse

getCorrelationID, getInfo, getResultCode, getSuccess, setCorrelationID, setInfo, setResultCode, setSuccess

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GenericResponse

public GenericResponse()

GenericResponse

public GenericResponse(Hashtable<String,Object> hash)

GenericResponse

public GenericResponse(@NonNull
                       Boolean success,
                       @NonNull
                       Result resultCode)

Constructs a new GenericResponse object

Parameters:

success - whether the request is successfully processed

resultCode - whether the request is successfully processed