com.smartdevicelink.proxy.rpc

Class AppServiceRecord

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.AppServiceRecord

All Implemented Interfaces:

Cloneable

public class AppServiceRecord
extends RPCStruct

This manifest contains all the information necessary for the service to be published, activated, and consumers able to interact with it

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_SERVICE_ACTIVE
static String	KEY_SERVICE_ID
static String	KEY_SERVICE_MANIFEST
static String	KEY_SERVICE_PUBLISHED

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
AppServiceRecord()
AppServiceRecord(Hashtable<String,Object> hash)
AppServiceRecord(String serviceID, AppServiceManifest serviceManifest, Boolean servicePublished, Boolean serviceActive)

Method Summary

Modifier and Type	Method and Description
Boolean	getServiceActive() If true, the service is the active primary service of the supplied service type.
String	getServiceID() ID of this service
AppServiceManifest	getServiceManifest() the App Service Manifest
Boolean	getServicePublished() If true, the service is published and available.
AppServiceRecord	setServiceActive(Boolean serviceActive) If true, the service is the active primary service of the supplied service type.
AppServiceRecord	setServiceID(String serviceID) ID of this service
AppServiceRecord	setServiceManifest(AppServiceManifest serviceManifest) the App Service Manifest
AppServiceRecord	setServicePublished(Boolean servicePublished) If true, the service is published and available.

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_SERVICE_ID

public static final String KEY_SERVICE_ID

See Also:

Constant Field Values

KEY_SERVICE_MANIFEST

public static final String KEY_SERVICE_MANIFEST

See Also:

Constant Field Values

KEY_SERVICE_PUBLISHED

public static final String KEY_SERVICE_PUBLISHED

See Also:

Constant Field Values

KEY_SERVICE_ACTIVE

public static final String KEY_SERVICE_ACTIVE

See Also:

Constant Field Values

Constructor Detail

AppServiceRecord

public AppServiceRecord()

AppServiceRecord

public AppServiceRecord(Hashtable<String,Object> hash)

AppServiceRecord

public AppServiceRecord(@NonNull
                        String serviceID,
                        @NonNull
                        AppServiceManifest serviceManifest,
                        @NonNull
                        Boolean servicePublished,
                        @NonNull
                        Boolean serviceActive)

Method Detail

setServiceID

public AppServiceRecord setServiceID(@NonNull
                                     String serviceID)

ID of this service

Parameters:

serviceID - - the service ID

getServiceID

public String getServiceID()

ID of this service

Returns:

serviceId

setServiceManifest

public AppServiceRecord setServiceManifest(@NonNull
                                           AppServiceManifest serviceManifest)

the App Service Manifest

Parameters:

serviceManifest - - the App Service Manifest

getServiceManifest

public AppServiceManifest getServiceManifest()

the App Service Manifest

Returns:

serviceManifest - the App Service Manifest

setServicePublished

public AppServiceRecord setServicePublished(@NonNull
                                            Boolean servicePublished)

If true, the service is published and available. If false, the service has likely just been unpublished, and should be considered unavailable.

Parameters:

servicePublished - - boolean

getServicePublished

public Boolean getServicePublished()

If true, the service is published and available. If false, the service has likely just been unpublished, and should be considered unavailable.

Returns:

servicePublished - boolean

setServiceActive

public AppServiceRecord setServiceActive(@NonNull
                                         Boolean serviceActive)

If true, the service is the active primary service of the supplied service type. It will receive all potential RPCs that are passed through to that service type. If false, it is not the primary service of the supplied type. See servicePublished for its availability.

Parameters:

serviceActive - - boolean

getServiceActive

public Boolean getServiceActive()

If true, the service is the active primary service of the supplied service type. It will receive all potential RPCs that are passed through to that service type. If false, it is not the primary service of the supplied type. See servicePublished for its availability.

Returns:

serviceActive - boolean