• Home
• com.smartdevicelink
• sdl_java_se
• 5.5.0
• source code
• CreateInteractionChoiceSet.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

/*
 * 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;
import java.util.List;

/**
 * Creates a Choice Set which can be used in subsequent 
 * {@linkplain PerformInteraction} Operations.
 *
 * 
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
Y
Min Value: 0; Max Value: 2000000000
SmartDeviceLink 1.0
choiceSet
Choice[]
Array of one or more elements.
Y
Min Value: 1; Max Value: 100
SmartDeviceLink 1.0 
 *
 *
 * 
 Note:
Second Utterance issue with CreateInteractionChoiceSet RPC.  Before a perform interaction
 * is sent you MUST wait for the success from the CreateInteractionChoiceSet RPC.
 * If you do not wait the system may not recognize the first utterance from the user.
 *
 * 
Response
 * 

 * Indicates that the corresponding request either failed or succeeded. If the response returns with a SUCCESS result code, this means the Choice Set was created.
 *
 * 
Non-default Result Codes:
 * 	
SUCCESS
 * 	
INVALID_DATA
 * 	
OUT_OF_MEMORY
 * 	
TOO_MANY_PENDING_REQUESTS
 * 	
APPLICATION_NOT_REGISTERED
 * 	
GENERIC_ERROR
 * 
	REJECTED
 * 
 INVALID_ID
 * 
 DUPLICATE_NAME
 *  
UNSUPPORTED_RESOURCE 
 *
 * @see DeleteInteractionChoiceSet
 * @see PerformInteraction
 * @since SmartDeviceLink 1.0
 */
public class CreateInteractionChoiceSet extends RPCRequest {
    public static final String KEY_CHOICE_SET = "choiceSet";
    public static final String KEY_INTERACTION_CHOICE_SET_ID = "interactionChoiceSetID";

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

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

    /**
     * Constructs a new CreateInteractionChoiceSet object
     *
     * @param interactionChoiceSetID: an Integer value representing the Choice Set ID
     *                                Notes: Min Value: 0; Max Value: 2000000000
     * @param choiceSet:              a List representing the array of one or more elements
     *                                Notes: Min Value: 1; Max Value: 100
     */
    public CreateInteractionChoiceSet(@NonNull Integer interactionChoiceSetID, @NonNull List choiceSet) {
        this();
        setInteractionChoiceSetID(interactionChoiceSetID);
        setChoiceSet(choiceSet);
    }

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

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

    /**
     * Gets Choice Set Array of one or more elements
     *
     * @return List -a List representing the array of one or
     * more elements
     */
    @SuppressWarnings("unchecked")
    public List getChoiceSet() {
        return (List) getObject(Choice.class, KEY_CHOICE_SET);
    }

    /**
     * Sets a Choice Set that is an Array of one or more elements
     *
     * @param choiceSet a List representing the array of one or more
     *                  elements
     *
     *                  Notes: Min Value: 1; Max Value: 100
     */
    public CreateInteractionChoiceSet setChoiceSet(@NonNull List choiceSet) {
        setParameters(KEY_CHOICE_SET, choiceSet);
        return this;
    }
}