001/*
002 * (C) Copyright 2016 Nuxeo SA (http://nuxeo.com/) and others.
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 *
016 * Contributors:
017 *     Gabriel Barata <gbarata@nuxeo.com>
018 */
019package org.nuxeo.ecm.platform.search.core;
020
021import java.io.Serializable;
022import java.util.Map;
023
024import org.nuxeo.ecm.core.api.DocumentModel;
025
026/**
027 * @since 8.3
028 */
029public interface SavedSearch extends Serializable {
030
031    String getId();
032
033    String getTitle();
034
035    Map<String, String> getNamedParams();
036
037    String getQueryParams();
038
039    String getQuery();
040
041    String getQueryLanguage();
042
043    String getPageProviderName();
044
045    Long getPageSize();
046
047    Long getCurrentPageIndex();
048
049    /**
050     * @since 9.3
051     */
052    Long getCurrentPageOffset();
053
054    Long getMaxResults();
055
056    String getSortBy();
057
058    String getSortOrder();
059
060    String getContentViewData();
061
062    DocumentModel getDocument();
063
064    void setTitle(String title);
065
066    void setNamedParams(Map<String, String> params);
067
068    void setQueryParams(String queryParams);
069
070    void setQuery(String query);
071
072    void setQueryLanguage(String queryLanguage);
073
074    void setPageProviderName(String pageProviderName);
075
076    void setPageSize(Long pageSize);
077
078    void setCurrentPageIndex(Long currentPageIndex);
079
080    void setMaxResults(Long maxResults);
081
082    void setSortBy(String sortBy);
083
084    void setSortOrder(String sortOrder);
085
086    void setContentViewData(String contentViewData);
087
088    void setDocument(DocumentModel doc);
089
090}