com.smartdevicelink.proxy.rpc

Class ParameterPermissions

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.ParameterPermissions

All Implemented Interfaces:

Cloneable

public class ParameterPermissions
extends RPCStruct

Defining sets of parameters, which are permitted or prohibited for a given RPC.

Parameter List

Name	Type	Description	SmartDeviceLink Ver. Available
allowed	String	A set of all parameters that are permitted for this given RPC. Min size: 0 Max size: 100 Max length: 100	SmartDeviceLink 2.0
userDisallowed	String	A set of all parameters that are prohibited for this given RPC. Min size: 0 Max size: 100 Max length: 100	SmartDeviceLink 2.0

Since:

SmartDeviceLink 2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_ALLOWED
static String	KEY_USER_DISALLOWED

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
ParameterPermissions() Constructs a newly allocated ParameterPermissions object
ParameterPermissions(Hashtable<String,Object> hash) Constructs a newly allocated ParameterPermissions object indicated by the Hashtable parameter
ParameterPermissions(List<String> allowed, List<String> userDisallowed) Constructs a newly allocated ParameterPermissions object

Method Summary

Modifier and Type	Method and Description
List<String>	getAllowed() get a set of all parameters that are permitted for this given RPC.
List<String>	getUserDisallowed() get a set of all parameters that are prohibited for this given RPC.
ParameterPermissions	setAllowed(List<String> allowed) set a set of all parameters that are permitted for this given RPC.
ParameterPermissions	setUserDisallowed(List<String> userDisallowed) set a set of all parameters that are prohibited for this given RPC.

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, 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_ALLOWED

public static final String KEY_ALLOWED

See Also:

Constant Field Values

KEY_USER_DISALLOWED

public static final String KEY_USER_DISALLOWED

See Also:

Constant Field Values

Constructor Detail

ParameterPermissions

public ParameterPermissions()

Constructs a newly allocated ParameterPermissions object

ParameterPermissions

public ParameterPermissions(Hashtable<String,Object> hash)

Constructs a newly allocated ParameterPermissions object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

ParameterPermissions

public ParameterPermissions(@NonNull
                            List<String> allowed,
                            @NonNull
                            List<String> userDisallowed)

Constructs a newly allocated ParameterPermissions object

Parameters:

allowed - parameter that is permitted for this given RPC

userDisallowed - parameter that is prohibited for this given RPC

Method Detail

getAllowed

public List<String> getAllowed()

get a set of all parameters that are permitted for this given RPC.

Returns:

a set of all parameters that are permitted for this given RPC.

setAllowed

public ParameterPermissions setAllowed(@NonNull
                                       List<String> allowed)

set a set of all parameters that are permitted for this given RPC.

Parameters:

allowed - parameter that is permitted for this given RPC

getUserDisallowed

public List<String> getUserDisallowed()

get a set of all parameters that are prohibited for this given RPC.

Returns:

a set of all parameters that are prohibited for this given RPC

setUserDisallowed

public ParameterPermissions setUserDisallowed(@NonNull
                                              List<String> userDisallowed)

set a set of all parameters that are prohibited for this given RPC.

Parameters:

userDisallowed - parameter that is prohibited for this given RPC