com.smartdevicelink.proxy.rpc.enums

Enum VehicleDataResultCode

java.lang.Object

java.lang.Enum<VehicleDataResultCode>

com.smartdevicelink.proxy.rpc.enums.VehicleDataResultCode

All Implemented Interfaces:

Serializable, Comparable<VehicleDataResultCode>

public enum VehicleDataResultCode
extends Enum<VehicleDataResultCode>

Enumeration that describes possible result codes of a vehicle data entry request.

Since:

SmartDeviceLink 2.0

See Also:

DIDResult, ReadDID

Enum Constant Summary

Enum Constants

Enum Constant and Description
DATA_ALREADY_SUBSCRIBED The vehicle data item is already subscribed.
DATA_NOT_SUBSCRIBED The vehicle data item cannot be unsubscribed because it is not currently subscribed.
DISALLOWED This vehicle data item is not allowed for this app .The request is not authorized in local policies.
IGNORED The request for this item is ignored because it is already in progress
INVALID_ID The ECU ID referenced is not a valid ID on the bus / system.
SUCCESS Individual vehicle data item / DTC / DID request or subscription successful
TRUNCATED_DATA DTC / DID request successful, however, not all active DTCs or full contents of DID location available
USER_DISALLOWED The user has not granted access to this type of vehicle data item at this time.
VEHICLE_DATA_NOT_AVAILABLE The requested vehicle data item / DTC / DID is not currently available or responding on the bus / system.

Method Summary

Modifier and Type	Method and Description
static VehicleDataResultCode	valueForString(String value)
static VehicleDataResultCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static VehicleDataResultCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final VehicleDataResultCode SUCCESS

Individual vehicle data item / DTC / DID request or subscription successful

TRUNCATED_DATA

public static final VehicleDataResultCode TRUNCATED_DATA

DTC / DID request successful, however, not all active DTCs or full contents of DID location available

Since:

SmartDeviceLink 4.0

DISALLOWED

public static final VehicleDataResultCode DISALLOWED

This vehicle data item is not allowed for this app .The request is not authorized in local policies.

USER_DISALLOWED

public static final VehicleDataResultCode USER_DISALLOWED

The user has not granted access to this type of vehicle data item at this time.

INVALID_ID

public static final VehicleDataResultCode INVALID_ID

The ECU ID referenced is not a valid ID on the bus / system.

VEHICLE_DATA_NOT_AVAILABLE

public static final VehicleDataResultCode VEHICLE_DATA_NOT_AVAILABLE

The requested vehicle data item / DTC / DID is not currently available or responding on the bus / system.

DATA_ALREADY_SUBSCRIBED

public static final VehicleDataResultCode DATA_ALREADY_SUBSCRIBED

The vehicle data item is already subscribed.

DATA_NOT_SUBSCRIBED

public static final VehicleDataResultCode DATA_NOT_SUBSCRIBED

The vehicle data item cannot be unsubscribed because it is not currently subscribed.

IGNORED

public static final VehicleDataResultCode IGNORED

The request for this item is ignored because it is already in progress

Method Detail

values

public static VehicleDataResultCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VehicleDataResultCode c : VehicleDataResultCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static VehicleDataResultCode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

valueForString

public static VehicleDataResultCode valueForString(String value)