org.humanistika.oxygen.tei.completer.remote.Client Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tei-completer Show documentation

An Oxygen XML Editor plugin for customizable attribute and value completion for TEI P5 documents

The newest version!

/**
 * TEI Completer
 * An Oxygen XML Editor plugin for customizable attribute and value completion for TEI P5 documents
 * Copyright (C) 2016 Belgrade Center for Digital Humanities
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
package org.humanistika.oxygen.tei.completer.remote;

import org.humanistika.ns.tei_completer.Suggestions;
import org.humanistika.oxygen.tei.completer.configuration.beans.RequestInfo;
import org.humanistika.oxygen.tei.completer.configuration.beans.ResponseAction;
import javax.annotation.Nullable;

/**
 * TEI Completer Client interface for getting auto-complete suggestions from a remote server
 *
 * @author Adam Retter, Evolved Binary Ltd
 * @version 1.0
 * @serial 20160126
 */
public interface Client {

    /**
     * Retrieve the suggestions for auto-complete from the server
     *
     * @param requestInfo The base details for the request
     * @param selection The selection
     * @param dependent The dependent or null
     * @param responseAction An optional action to take upon the response, or otherwise null
     *
     * @return A list of auto-complete suggestions from the server
     */
    Suggestions getSuggestions(final RequestInfo requestInfo, final String selection, final String dependent, @Nullable final ResponseAction responseAction);
}