at.molindo.esi4j.action.MultiSearchResponseWrapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of esi4j Show documentation

The newest version!

/**
 * Copyright 2010 Molindo GmbH
 *
 * 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 at.molindo.esi4j.action;

import java.util.List;

import org.elasticsearch.action.search.MultiSearchResponse;
import org.elasticsearch.action.search.SearchResponse;

/**
 * wraps a {@link SearchResponse}, allows to get returned results as a {@link List} of {@link SearchHitWrapper}
 */
public interface MultiSearchResponseWrapper {

	MultiSearchResponse getMultiSearchResponse();

	List getMultiSearchItemResponses();

	List getSearchHits();

	/**
	 * @see #getObjects(Class)
	 */
	List getObjects();

	/**
	 * @return {@link List} of objects of cast to given type. may contain null if ID does not exist or
	 *         {@link TypeMapping#read(GetResponse))} returns null
	 */
	 List getObjects(Class type);

}