com.smartdevicelink.proxy

Class RPCResponse

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCResponse

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

AddCommandResponse, AddSubMenuResponse, AlertManeuverResponse, AlertResponse, ButtonPressResponse, CancelInteractionResponse, ChangeRegistrationResponse, CloseApplicationResponse, CreateInteractionChoiceSetResponse, CreateWindowResponse, DeleteCommandResponse, DeleteFileResponse, DeleteInteractionChoiceSetResponse, DeleteSubMenuResponse, DeleteWindowResponse, DiagnosticMessageResponse, DialNumberResponse, EndAudioPassThruResponse, GenericResponse, GetAppServiceDataResponse, GetCloudAppPropertiesResponse, GetDTCsResponse, GetFileResponse, GetInteriorVehicleDataConsentResponse, GetInteriorVehicleDataResponse, GetSystemCapabilityResponse, GetVehicleDataResponse, GetWayPointsResponse, ListFilesResponse, PerformAppServiceInteractionResponse, PerformAudioPassThruResponse, PerformInteractionResponse, PublishAppServiceResponse, PutFileResponse, ReadDIDResponse, RegisterAppInterfaceResponse, ReleaseInteriorVehicleDataModuleResponse, ResetGlobalPropertiesResponse, ScrollableMessageResponse, SendHapticDataResponse, SendLocationResponse, SetAppIconResponse, SetCloudAppPropertiesResponse, SetDisplayLayoutResponse, SetGlobalPropertiesResponse, SetInteriorVehicleDataResponse, SetMediaClockTimerResponse, ShowAppMenuResponse, ShowConstantTbtResponse, ShowResponse, SliderResponse, SpeakResponse, SubscribeButtonResponse, SubscribeVehicleDataResponse, SubscribeWayPointsResponse, SubtleAlertResponse, SystemRequestResponse, UnpublishAppServiceResponse, UnregisterAppInterfaceResponse, UnsubscribeButtonResponse, UnsubscribeVehicleDataResponse, UnsubscribeWayPointsResponse, UpdateTurnListResponse

public class RPCResponse
extends RPCMessage

Result sent by SDL after an RPC is processed, consists of four parts:

• CorrelationID:
  An integer value correlating the response to the corresponding request.
• Success:
  A Boolean indicating whether the original request was successfully processed.
• ResultCode:

  The result code provides additional information about a response returning a failed outcome.

  Any response can have at least one, or possibly more, of the following result code values: SUCCESS, INVALID_DATA, OUT_OF_MEMORY, TOO_MANY_PENDING_REQUESTS, APPLICATION_NOT_REGISTERED, GENERIC_ERROR,REJECTED.

  Any additional result codes for a given operation can be found in related RPCs

• Info:
  A string of text representing additional information returned from SDL. This could be useful in debugging.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_INFO
static String	KEY_RESULT_CODE
static String	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
RPCResponse(Hashtable<String,Object> hash) Constructs a newly allocated RPCResponse object indicated by the Hashtable parameter
RPCResponse(RPCMessage rpcMsg) Constructs a newly allocated RPCResponse object using a RPCMessage object
RPCResponse(String functionName) Constructs a newly allocated RPCResponse object using function name

Method Summary

Modifier and Type	Method and Description
Integer	getCorrelationID() Returns correlationID the ID of the request
String	getInfo() Returns a string of text representing additional information returned from SDL
Result	getResultCode() Returns ResultCode additional information about a response returning a failed outcome
Boolean	getSuccess() Returns Success whether the request is successfully processed
RPCResponse	setCorrelationID(Integer correlationID) Set the correlationID
RPCResponse	setInfo(String info) Set a string of text representing additional information returned from SDL
RPCResponse	setResultCode(Result resultCode) Set the additional information about a response returning a failed outcome
RPCResponse	setSuccess(Boolean success) Set the Success status

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

Field Detail

KEY_SUCCESS

public static final String KEY_SUCCESS

See Also:

Constant Field Values

KEY_INFO

public static final String KEY_INFO

See Also:

Constant Field Values

KEY_RESULT_CODE

public static final String KEY_RESULT_CODE

See Also:

Constant Field Values

Constructor Detail

RPCResponse

public RPCResponse(String functionName)

Constructs a newly allocated RPCResponse object using function name

Parameters:

functionName - a string that indicates the function's name

RPCResponse

public RPCResponse(Hashtable<String,Object> hash)

Constructs a newly allocated RPCResponse object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

RPCResponse

public RPCResponse(RPCMessage rpcMsg)

Constructs a newly allocated RPCResponse object using a RPCMessage object

Parameters:

rpcMsg - The RPCMessage to use

Method Detail

getCorrelationID

public Integer getCorrelationID()

Returns correlationID the ID of the request

Returns:

int the ID of the request

setCorrelationID

public RPCResponse setCorrelationID(Integer correlationID)

Set the correlationID

Parameters:

correlationID - the ID of the response

getSuccess

public Boolean getSuccess()

Returns Success whether the request is successfully processed

Returns:

Boolean the status of whether the request is successfully done

setSuccess

public RPCResponse setSuccess(@NonNull
                              Boolean success)

Set the Success status

Parameters:

success - whether the request is successfully processed

getResultCode

public Result getResultCode()

Returns ResultCode additional information about a response returning a failed outcome

Returns:

Result the status of whether the request is successfully done

setResultCode

public RPCResponse setResultCode(@NonNull
                                 Result resultCode)

Set the additional information about a response returning a failed outcome

Parameters:

resultCode - whether the request is successfully processed

getInfo

public String getInfo()

Returns a string of text representing additional information returned from SDL

Returns:

String A string of text representing additional information returned from SDL

setInfo

public RPCResponse setInfo(String info)

Set a string of text representing additional information returned from SDL

Parameters:

info - a string of text representing additional information returned from SDL