001/*
002 *  Copyright 2019 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.web.frontoffice.search.requesttime.input;
017
018import java.util.List;
019import java.util.Map;
020
021import org.apache.commons.lang3.tuple.Pair;
022
023import org.ametys.cms.search.Sort;
024import org.ametys.cms.search.Sort.Order;
025
026/**
027 * Object that represents the search user inputs.
028 */
029public interface SearchUserInputs
030{
031    /**
032     * Gets the user criteria
033     * @return the user criteria
034     */
035    Map<String, Object> criteria();
036
037    /**
038     * Set criteria
039     * @param criteria the new criteria
040     */
041    void setCriteria(Map<String, Object> criteria);
042
043    /**
044     * Gets the user facets
045     * @return the user criteria
046     */
047    Map<String, List<String>> facets();
048
049    /**
050     * Set facets
051     * @param facets the new facets
052     */
053    void setFacets(Map<String, List<String>> facets);
054
055    /**
056     * Gets the user sorts
057     * @return the user sorts
058     */
059    List<Pair<String, Sort.Order>> sorts();
060
061    /**
062     * Set sorts
063     * @param sorts the new sorts
064     */
065    void setSorts(List<Pair<String, Order>> sorts);
066}