001/*
002 *  Copyright 2020 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.plugins.workspaces.search;
017
018import org.ametys.runtime.i18n.I18nizableText;
019
020/**
021 * Interface for search module
022 */
023public interface SearchModule
024{
025    /**
026     * Get the id
027     * @return the id
028     */
029    public String getId();
030    
031    /**
032     * Get the title of the search
033     * @return title of the module
034     */ 
035    public I18nizableText getTitle();
036    
037    /**
038     * Get the search url
039     * @return URL to fetch for search
040     */
041    public String getSearchUrl();
042
043    /**
044     * Get the number of results per page
045     * @return Max number of results on the module view
046     */
047    public int getLimit();
048
049    /**
050     * Get the number of results per page on the main page (should be smaller than {@link SearchModule#getLimit()})
051     * @return Max number of results on the main view
052     */
053    public int getMinLimit();
054    
055    /**
056     * Get the module order, smaller order means that it is displayed before
057     * @return The module order value
058     */
059    public int getOrder();
060}