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.SortOrder;
024
025/**
026 * Object that represents the search user inputs.
027 */
028public interface SearchUserInputs
029{
030    /**
031     * Gets the user criteria
032     * @return the user criteria
033     */
034    Map<String, Object> criteria();
035
036    /**
037     * Set criteria
038     * @param criteria the new criteria
039     */
040    void setCriteria(Map<String, Object> criteria);
041
042    /**
043     * Gets the user facets
044     * @return the user criteria
045     */
046    Map<String, List<String>> facets();
047
048    /**
049     * Set facets
050     * @param facets the new facets
051     */
052    void setFacets(Map<String, List<String>> facets);
053
054    /**
055     * Gets the user sorts
056     * @return the user sorts
057     */
058    List<Pair<String, SortOrder>> sorts();
059
060    /**
061     * Set sorts
062     * @param sorts the new sorts
063     */
064    void setSorts(List<Pair<String, SortOrder>> sorts);
065}