io.gravitee.rest.api.service.impl.search.lucene.DocumentSearcher Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gravitee-rest-api-service Show documentation

Gravitee IO Manager Service

There is a newer version: 3.10.0

Show newest version

/**
 * Copyright (C) 2015 The Gravitee team (http://gravitee.io)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.gravitee.rest.api.service.impl.search.lucene;

import io.gravitee.repository.exceptions.TechnicalException;
import io.gravitee.rest.api.service.impl.search.SearchResult;
import io.gravitee.rest.api.service.impl.search.lucene.handler.TypedHandler;
import io.gravitee.rest.api.service.search.query.Query;
import java.util.List;

/**
 * @author David BRASSELY (david.brassely at graviteesource.com)
 * @author GraviteeSource Team
 */
public interface DocumentSearcher extends TypedHandler {
    /**
     *
     * @param query
     * @return Returns the ID field value of the matching documents.
     */
    SearchResult search(Query query) throws TechnicalException;
}