/*
 * Copyright (C) 2000 - 2015 Silverpeas
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * As a special exception to the terms and conditions of version 3.0 of
 * the GPL, you may redistribute this Program in connection with Free/Libre
 * Open Source Software ("FLOSS") applications as described in Silverpeas's
 * FLOSS exception. You should have received a copy of the text describing
 * the FLOSS exception, and it is also available here:
 * "https://www.silverpeas.org/legal/floss_exception.html"
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
package org.silverpeas.components.whitepages.service;

import org.silverpeas.core.contribution.contentcontainer.content.GlobalSilverContent;
import org.silverpeas.core.index.indexing.model.FieldDescription;
import org.silverpeas.core.pdc.pdc.model.SearchContext;
import org.silverpeas.core.util.ServiceProvider;

import java.util.Collection;
import java.util.List;
import java.util.Map;

public interface MixedSearchService {

  static MixedSearchService get() {
    return ServiceProvider.getService(MixedSearchService.class);
  }

  /**
   * @param spaceId the space identifier
   * @param componentId the component instance identifier
   * @param userId the user identifier
   * @param queryString standard search
   * @param pdcContext PDC filter
   * @param xmlFields xml fields filter
   * @param xmlTemplate xml template filter
   * @param fieldsQuery ldap and silverpeas fields filter
   * @param language
   * @return a collection of global silver content
   * @throws Exception
   */
  public Collection<GlobalSilverContent> search(String spaceId, String componentId, String userId,
      String queryString, SearchContext pdcContext, Map<String, String> xmlFields,
      String xmlTemplate, List<FieldDescription> fieldsQuery, String language) throws Exception;
}
