com.day.cq.dam.api.s7dam.omnisearch.S7OmniSearchHandler Maven / Gradle / Ivy

package com.day.cq.dam.api.s7dam.omnisearch;

import com.day.cq.search.result.SearchResult;
import org.apache.sling.api.resource.ResourceResolver;

import java.util.Map;

public interface S7OmniSearchHandler {

    /**
     * invoked by AssetOmniSearchHandler in cq-dam-core bundle upon receipt of search request
     * @param resolver used to lookup name of user that initiated request
     * @param predicateParameters predicate parameter for query
     * @param damAssetSearchResults initial asset search results that we concatenate our results into
     * @return
     */
    SearchResult getResults(ResourceResolver resolver, Map predicateParameters, SearchResult damAssetSearchResults);

    /**
     * Check if the predicate contains "scene7remote" to enable remote asset query from IPS
     * @param predicateParameters predicate parameter for query
     * @param resolver resource resolver
     * @return true if predicate contains "scene7remote"; otherwise, false.
     */
    boolean containScene7Filter(Map predicateParameters, ResourceResolver resolver);

}