com.smartdevicelink.proxy.rpc.UpdateTurnList 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 com.smartdevicelink.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCRequest;

import java.util.Hashtable;
import java.util.List;

/**
 * Updates the list of next maneuvers, which can be requested by the user pressing the soft button "Turns" on the
 * Navigation base screen. Three soft buttons are predefined by the system: Up, Down, Close
 *
 * Function Group: Navigation
 *
 * HMILevel needs to be FULL, LIMITED or BACKGROUND
 *
 * @see ShowConstantTbt
 * @since SmartDeviceLink 2.0
 */
public class UpdateTurnList extends RPCRequest {
    public static final String KEY_TURN_LIST = "turnList";
    public static final String KEY_SOFT_BUTTONS = "softButtons";

    /**
     * Constructs a new UpdateTurnList object
     */
    public UpdateTurnList() {
        super(FunctionID.UPDATE_TURN_LIST.toString());
    }

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

    /**
     * Sets a list of turns to be shown to the user
     *
     * @param turnList a List value representing a list of turns to be shown to the user
     *                 
     *                 Notes: Minsize=1; Maxsize=100
     */
    public UpdateTurnList setTurnList(List turnList) {
        setParameters(KEY_TURN_LIST, turnList);
        return this;
    }

    /**
     * Gets a list of turns to be shown to the user
     *
     * @return List -a List value representing a list of turns
     */
    @SuppressWarnings("unchecked")
    public List getTurnList() {
        return (List) getObject(Turn.class, KEY_TURN_LIST);
    }

    /**
     * Gets the SoftButton List object
     *
     * @return List -a List representing the List object
     * @since SmartDeviceLink 2.0
     */
    @SuppressWarnings("unchecked")
    public List getSoftButtons() {
        return (List) getObject(SoftButton.class, KEY_SOFT_BUTTONS);
    }

    /**
     * Sets the SoftButtons
     *
     * @param softButtons a List value
     *                    
     *                    Notes: 
     *                    
     *                    If omitted on supported displays, the alert will not have any SoftButton
     *                    ArrayMin: 0
     *                    ArrayMax: 1
     *                    
     * @since SmartDeviceLink 2.0
     */

    public UpdateTurnList setSoftButtons(List softButtons) {
        setParameters(KEY_SOFT_BUTTONS, softButtons);
        return this;
    }

}