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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sdl_java_se Show documentation

The app library component of SDL is meant to run on the end userâs smart-device from within SDL enabled apps, as an embedded app, or connected to the cloud. App libraries allow the apps to connect to SDL enabled head-units and hardware through bluetooth, USB, and TCP for Android, and cloud and embedded apps can connect through web sockets, Java Beans, and other custom transports. Once the library establishes a connection between the smart device and head-unit through the preferred method of transport, the two components are able to communicate using the SDL defined protocol. The app integrating this library project is then able to expose its functionality to the head-unit through text, media, and other interactive elements.

There is a newer version: 5.7.0

Show newest version

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

import java.util.Hashtable;

/**
 * Deletes an existing Choice Set identified by the parameter
 * interactionChoiceSetID. If the specified interactionChoiceSetID is currently
 * in use by an active  {@linkplain PerformInteraction} this call to
 * delete the Choice Set will fail returning an IN_USE resultCode
 *
 * Function Group: Base
 *
 * HMILevel needs to be FULL, LIMITED or BACKGROUND
 *
 * AudioStreamingState: Any
 *
 * SystemContext: MAIN, MENU, VR 
 *
 * Parameter List
 *
 * 
 * 		
 * 			
 * 			
 * 			
 *                 
 *               
 * 			
 * 		
 * 		
 * 			
 * 			
 * 			
 *                 
 *                 
 * 			
 * 		
 *  Name Type Description Reg. Notes Version
interactionChoiceSetID Integer  A unique ID that identifies the Choice Set (specified in a previous call to CreateInteractionChoiceSet) Y Min Value: 0 ; Max Value: 2000000000 SmartDeviceLink 1.0
 *
 * Response 
 * 
 * If a resultCode of "SUCCESS" is returned, the requested choice set has been created and can now be referenced by the application using the value of interactionChoiceSetID provided by the application.
 *
 * 
Non-default Result Codes:
 * 	SUCCESS
 * 	INVALID_DATA
 * 	OUT_OF_MEMORY
 * 	TOO_MANY_PENDING_REQUESTS
 * 	APPLICATION_NOT_REGISTERED
 * 	GENERIC_ERROR
 * 	REJECTED
 *   INVALID_ID
 *
 * @see CreateInteractionChoiceSet
 * @see PerformInteraction
 * @since SmartDeviceLink 1.0
 */
public class DeleteInteractionChoiceSet extends RPCRequest {
    public static final String KEY_INTERACTION_CHOICE_SET_ID = "interactionChoiceSetID";

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

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

    /**
     * Constructs a new DeleteInteractionChoiceSet object
     *
     * @param interactionChoiceSetID a unique ID that identifies the Choice Set
     *                               Notes: Min Value: 0; Max Value: 2000000000 
     */
    public DeleteInteractionChoiceSet(@NonNull Integer interactionChoiceSetID) {
        this();
        setInteractionChoiceSetID(interactionChoiceSetID);
    }

    /**
     * Gets a unique ID that identifies the Choice Set
     *
     * @return Integer -an Integer value representing the unique Choice Set ID
     */
    public Integer getInteractionChoiceSetID() {
        return getInteger(KEY_INTERACTION_CHOICE_SET_ID);
    }

    /**
     * Sets a unique ID that identifies the Choice Set
     *
     * @param interactionChoiceSetID a unique ID that identifies the Choice Set
     *                               Notes: Min Value: 0; Max Value: 2000000000 
     */
    public DeleteInteractionChoiceSet setInteractionChoiceSetID(@NonNull Integer interactionChoiceSetID) {
        setParameters(KEY_INTERACTION_CHOICE_SET_ID, interactionChoiceSetID);
        return this;
    }
}