com.smartdevicelink.proxy.rpc

Class GetSystemCapability

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.GetSystemCapability

All Implemented Interfaces:

Cloneable

public class GetSystemCapability
extends RPCRequest

Used to request the corresponding capability object for a given capability.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_SUBSCRIBE
static String	KEY_SYSTEM_CAPABILITY_TYPE

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

onResponseListener

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
GetSystemCapability() Constructs a new GetSystemCapability object
GetSystemCapability(Hashtable<String,Object> hash) Constructs a new GetSystemCapability object indicated by the Hashtable parameter
GetSystemCapability(SystemCapabilityType systemCapabilityType) Constructs a new GetSystemCapability object

Method Summary

Modifier and Type	Method and Description
Boolean	getSubscribe() Flag to subscribe to updates of the supplied service capability type.
SystemCapabilityType	getSystemCapabilityType() Used to get the SystemCapabilityType being requested
GetSystemCapability	setSubscribe(Boolean subscribe) Flag to subscribe to updates of the supplied service capability type.
GetSystemCapability	setSystemCapabilityType(SystemCapabilityType value) Used to set the SystemCapabilityType being requested

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

getCorrelationID, getOnRPCResponseListener, setCorrelationID, setOnRPCResponseListener

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_SYSTEM_CAPABILITY_TYPE

public static final String KEY_SYSTEM_CAPABILITY_TYPE

See Also:

Constant Field Values

KEY_SUBSCRIBE

public static final String KEY_SUBSCRIBE

See Also:

Constant Field Values

Constructor Detail

GetSystemCapability

public GetSystemCapability()

Constructs a new GetSystemCapability object

GetSystemCapability

public GetSystemCapability(Hashtable<String,Object> hash)

Constructs a new GetSystemCapability object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

GetSystemCapability

public GetSystemCapability(@NonNull
                           SystemCapabilityType systemCapabilityType)

Constructs a new GetSystemCapability object

Parameters:

systemCapabilityType - SystemCapabilityType being requested

Method Detail

getSystemCapabilityType

public SystemCapabilityType getSystemCapabilityType()

Used to get the SystemCapabilityType being requested

Returns:

the SystemCapabilityType being requested

setSystemCapabilityType

public GetSystemCapability setSystemCapabilityType(@NonNull
                                                   SystemCapabilityType value)

Used to set the SystemCapabilityType being requested

Parameters:

value - SystemCapabilityType being requested

getSubscribe

public Boolean getSubscribe()

Flag to subscribe to updates of the supplied service capability type. If true, the requester will be subscribed. If false, the requester will not be subscribed and be removed as a subscriber if it was previously subscribed.

Returns:

if the SystemCapabilityType is subscribed to

setSubscribe

public GetSystemCapability setSubscribe(Boolean subscribe)

Flag to subscribe to updates of the supplied service capability type. If true, the requester will be subscribed. If false, the requester will not be subscribed and be removed as a subscriber if it was previously subscribed.

Parameters:

subscribe - to changes in the SystemCapabilityType