001/* 002 * Licensed under the Apache License, Version 2.0 (the "License"); 003 * you may not use this file except in compliance with the License. 004 * You may obtain a copy of the License at 005 * 006 * http://www.apache.org/licenses/LICENSE-2.0 007 * 008 * Unless required by applicable law or agreed to in writing, software 009 * distributed under the License is distributed on an "AS IS" BASIS, 010 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 011 * See the License for the specific language governing permissions and 012 * limitations under the License. 013 */ 014package org.gbif.ws.util; 015 016/** 017 * Parameters used in the API webservices. 018 */ 019public final class WebserviceParameter { 020 021 /** 022 * The query string for searches. 023 * Repeated in SearchConstants, couldnt resolve dependencies. 024 */ 025 public static final String PARAM_QUERY_STRING = "q"; 026 027 /** 028 * The query fields to search within. 029 */ 030 public static final String PARAM_QUERY_FIELD = "qField"; 031 032 /** 033 * Facet param name. 034 */ 035 public static final String PARAM_FACET = "facet"; 036 037 /** 038 * Facet multiselect parameter. 039 */ 040 public static final String PARAM_FACET_MULTISELECT = "facetMultiselect"; 041 042 public static final String PARAM_FACET_LIMIT = "facetLimit"; 043 044 public static final String PARAM_FACET_OFFSET = "facetOffset"; 045 046 /** 047 * Parameter min count of facets, facets with less than this valued sholdn't be included in the response. 048 */ 049 public static final String PARAM_FACET_MINCOUNT = "facetMincount"; 050 051 public static final String PARAM_HIGHLIGHT = "hl"; 052 053 public static final String PARAM_HIGHLIGHT_FIELD = "hlField"; 054 055 public static final String PARAM_HIGHLIGHT_CONTEXT = "hlContext"; 056 057 /** 058 * spellCheck parameter. 059 */ 060 public static final String PARAM_SPELLCHECK = "spellCheck"; 061 062 /** 063 * spellCheckCount parameter. 064 */ 065 public static final String PARAM_SPELLCHECK_COUNT = "spellCheckCount"; 066 067 /** 068 * 069 */ 070 public static final String PARAM_EXTENDED = "extended"; 071 072 public static final String DEFAULT_SEARCH_PARAM_VALUE = "*"; 073 074 private WebserviceParameter() { 075 throw new UnsupportedOperationException("Can't initialize utils class"); 076 } 077}