com.marklogic.client.query.SuggestDefinition Maven / Gradle / Ivy
/*
* Copyright 2013-2015 MarkLogic Corporation
*
* 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.
*/
package com.marklogic.client.query;
/**
* Represents the criteria for a suggestion call, in which the beginning
* of a term is supplied for possible suggested endings.
*/
public interface SuggestDefinition {
/**
* Returns the name of the query options used for this query.
* @return The options name.
*/
public String getOptionsName();
/**
* Sets the name of the query options to be used for this query.
*
* If no query options node with the specified name exists, the search will fail.
*
* @param name The name of the saved query options node on the server.
*/
public void setOptionsName(String name);
/**
* Sets one or more criteria for the suggestion call.
*
* @param pqtext A string for input to suggestions.
*/
public void setStringCriteria(String pqtext);
/**
* Returns the text of the suggestion call.
* @return The suggestion input.
*/
public String getStringCriteria();
/**
* Sets zero or more search strings to AND with the suggestion call.
*
* @param qtext Zero or more
* string queries to qualify that input string.
*/
public void setQueryStrings(String... qtext);
/**
* Returns the array of strings set for this SuggestDefinition.
* @return The query text strings and suggestion input.
*/
public String[] getQueryStrings();
/**
* Sets a limit for a suggest call. Only this number of suggestions
* will be returned by the server. Server default is 10.
*
* @param limit The maximum number of suggestions to fetch.
*/
public void setLimit(Integer limit);
/**
* Returns the maximum number of suggestions to fetch.
* @return The limit.
*/
public Integer getLimit();
/**
* Sets the cursor position to use in the suggest call.
* @param cursorPosition The cursor position.
*/
public void setCursorPosition(Integer cursorPosition);
/**
* Returns the cursor position for the suggest call.
* @return The cursor position
*/
public Integer getCursorPosition();
}