com.smartdevicelink.proxy.rpc

Class ModuleInfo

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.ModuleInfo

All Implemented Interfaces:

Cloneable

public class ModuleInfo
extends RPCStruct

Struct that describes a module within different SystemCapabilities

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_MODULE_ID
static String	KEY_MODULE_LOCATION
static String	KEY_MODULE_SERVICE_AREA
static String	KEY_MULTIPLE_ACCESS_ALLOWED

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
ModuleInfo()
ModuleInfo(Hashtable<String,Object> hash)
ModuleInfo(String moduleId) Struct that describes a module within different SystemCapabilities

Method Summary

Modifier and Type	Method and Description
String	getModuleId() Gets the Module ID for this module
Grid	getModuleLocation() Gets the location of this Module
Grid	getModuleServiceArea() Gets the service area of this Module
Boolean	getMultipleAccessAllowance() Gets the multiple allowance access of this Module
ModuleInfo	setModuleId(String id) Sets the Module ID for this Module
ModuleInfo	setModuleLocation(Grid location) Sets the location of this Module
ModuleInfo	setModuleServiceArea(Grid serviceArea) Sets the service area of this Module
ModuleInfo	setMultipleAccessAllowance(Boolean isMultipleAccess) Sets the multiple access allowance for this Module

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_MODULE_ID

public static final String KEY_MODULE_ID

See Also:

Constant Field Values

KEY_MODULE_LOCATION

public static final String KEY_MODULE_LOCATION

See Also:

Constant Field Values

KEY_MODULE_SERVICE_AREA

public static final String KEY_MODULE_SERVICE_AREA

See Also:

Constant Field Values

KEY_MULTIPLE_ACCESS_ALLOWED

public static final String KEY_MULTIPLE_ACCESS_ALLOWED

See Also:

Constant Field Values

Constructor Detail

ModuleInfo

public ModuleInfo()

ModuleInfo

public ModuleInfo(Hashtable<String,Object> hash)

ModuleInfo

public ModuleInfo(@NonNull
                  String moduleId)

Struct that describes a module within different SystemCapabilities

Parameters:

moduleId - Sets the Module ID for this Module

Method Detail

setModuleId

public ModuleInfo setModuleId(@NonNull
                              String id)

Sets the Module ID for this Module

Parameters:

id - the id to be set

getModuleId

public String getModuleId()

Gets the Module ID for this module

Returns:

the Module ID as a String

setModuleLocation

public ModuleInfo setModuleLocation(Grid location)

Sets the location of this Module

Parameters:

location - the location to be set

getModuleLocation

public Grid getModuleLocation()

Gets the location of this Module

Returns:

the location of this Module

setModuleServiceArea

public ModuleInfo setModuleServiceArea(Grid serviceArea)

Sets the service area of this Module

Parameters:

serviceArea - the service area of this Module

getModuleServiceArea

public Grid getModuleServiceArea()

Gets the service area of this Module

Returns:

the service area of this Module

setMultipleAccessAllowance

public ModuleInfo setMultipleAccessAllowance(Boolean isMultipleAccess)

Sets the multiple access allowance for this Module

Parameters:

isMultipleAccess - the access to be set

getMultipleAccessAllowance

public Boolean getMultipleAccessAllowance()

Gets the multiple allowance access of this Module

Returns:

the multiple access allowance of this Module