com.smartdevicelink.proxy.rpc.VehicleDataResult Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided with the
 * distribution.
 *
 * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package com.smartdevicelink.proxy.rpc;

import androidx.annotation.NonNull;

import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.VehicleDataResultCode;
import com.smartdevicelink.proxy.rpc.enums.VehicleDataType;

import java.util.Hashtable;

/**
 * Individual published data request result.
 *
 * Parameter List
 * 
 * 		
 * 			
 * 			
 * 			
 *                 
 * 			
 * 			
 * 		
 * 		
 * 			
 * 			
 * 			
 *                 
 * 			
 * 			
 * 		
 * 		
 * 			
 * 			
 * 			
 *                 
 * 			
 * 			
 * 		
 *  Param Name Type Description  Req. Notes Version Available
dataType VehicleDataType Defined published data element type. SmartDeviceLink 1.0
resultCode VehicleDataResultCode Published data result code. SmartDeviceLink 1.0
 */
public class VehicleDataResult extends RPCStruct {
    public static final String KEY_DATA_TYPE = "dataType";
    public static final String KEY_RESULT_CODE = "resultCode";
    public static final String KEY_OEM_CUSTOM_DATA_TYPE = "oemCustomDataType";

    public VehicleDataResult() {
    }

    /**
     * 
     * Constructs a new VehicleDataResult object indicated by the Hashtable
     * parameter
     * 
     *
     * @param hash the Hashtable to use
     */
    public VehicleDataResult(Hashtable hash) {
        super(hash);
    }

    /**
     * Individual published data request result.
     *
     * @param dataType   Defined published data element type.
     * @param resultCode Published data result code.
     */
    public VehicleDataResult(@NonNull VehicleDataType dataType, @NonNull VehicleDataResultCode resultCode) {
        this();
        setDataType(dataType);
        setResultCode(resultCode);
    }

    public VehicleDataResult setResultCode(@NonNull VehicleDataResultCode resultCode) {
        setValue(KEY_RESULT_CODE, resultCode);
        return this;
    }

    public VehicleDataResultCode getResultCode() {
        return (VehicleDataResultCode) getObject(VehicleDataResultCode.class, KEY_RESULT_CODE);
    }

    public VehicleDataResult setDataType(@NonNull VehicleDataType dataType) {
        setValue(KEY_DATA_TYPE, dataType);
        return this;
    }

    public VehicleDataType getDataType() {
        return (VehicleDataType) getObject(VehicleDataType.class, KEY_DATA_TYPE);
    }

    public VehicleDataResult setOEMCustomVehicleDataType(String oemCustomDataType) {
        setValue(KEY_OEM_CUSTOM_DATA_TYPE, oemCustomDataType);
        return this;
    }

    public String getOEMCustomVehicleDataType() {
        return (String) getObject(String.class, KEY_OEM_CUSTOM_DATA_TYPE);
    }
}
Param Name	Type	Description	Req.	Notes	Version Available
dataType	VehicleDataType	Defined published data element type.			SmartDeviceLink 1.0
resultCode	VehicleDataResultCode	Published data result code.			SmartDeviceLink 1.0