ai.api.RequestExtras Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of libai Show documentation
API.AI Java SDK allows using voice commands and integration with dialog scenarios defined for a particular agent in API.AI.
There is a newer version: 1.6.12
Show newest version
package ai.api;

/***********************************************************************************************************************
 *
 * API.AI Java SDK - client-side libraries for API.AI
 * =================================================
 *
 * Copyright (C) 2015 by Speaktoit, Inc. (https://www.speaktoit.com)
 * https://www.api.ai
 *
 ***********************************************************************************************************************
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 *
 ***********************************************************************************************************************/

import java.util.List;
import java.util.Map;

import ai.api.model.AIContext;
import ai.api.model.AIRequest;
import ai.api.model.Entity;
import ai.api.model.Location;

/**
 * Extra data for request
 */
public class RequestExtras {
    private List contexts;
    private List entities;

    private Boolean resetContexts;

    private Map additionalHeaders;

    private Location location;

    public RequestExtras() {
        contexts = null;
        entities = null;
    }

    public RequestExtras(final List contexts, final List entities) {
        this.contexts = contexts;
        this.entities = entities;
    }

    public List getContexts() {
        return contexts;
    }

    public void setContexts(final List contexts) {
        this.contexts = contexts;
    }

    public List getEntities() {
        return entities;
    }

    public void setEntities(final List entities) {
        this.entities = entities;
    }

    public Boolean getResetContexts() {
        return resetContexts;
    }

    public void setResetContexts(final boolean resetContexts) {
        this.resetContexts = resetContexts;
    }

    public Map getAdditionalHeaders() {
        return additionalHeaders;
    }

    /**
     * Additional headers to be passed to API.AI service. Must not be used in normal cases.
     * @param additionalHeaders map with headers
     */
    public void setAdditionalHeaders(final Map additionalHeaders) {
        this.additionalHeaders = additionalHeaders;
    }

    public Location getLocation() {
        return location;
    }

    public void setLocation(final Location location) {
        this.location = location;
    }

    public boolean hasContexts() {
        if (contexts != null && !contexts.isEmpty()) {
            return true;
        }
        return false;
    }

    public boolean hasEntities() {
        if (entities != null && !entities.isEmpty()) {
            return true;
        }
        return false;
    }

    public boolean hasAdditionalHeaders() {
        if (additionalHeaders != null && !additionalHeaders.isEmpty()) {
            return true;
        }
        return false;
    }

    public void copyTo(final AIRequest request) {
        if (hasContexts()) {
            request.setContexts(getContexts());
        }

        if (hasEntities()) {
            request.setEntities(getEntities());
        }

        if (getResetContexts() != null) {
            request.setResetContexts(getResetContexts());
        }

    }


}