001/* 002 * (C) Copyright 2014-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 * bdelbosc 018 */ 019package org.nuxeo.ecm.core.api; 020 021import java.util.List; 022 023/** 024 * The result of a {@link CoreSession#scroll} call, giving access to result and the scroll id. 025 * 026 * @since 8.4 027 */ 028public interface ScrollResult { 029 030 /** 031 * Returns the scroll identifier, which can be passed to CoreSession.scroll(String scrollId) to get more results. 032 */ 033 String getScrollId(); 034 035 /** 036 * Returns the list of document ids 037 */ 038 List<String> getResultIds(); 039 040 /** 041 * Returns {@code true} when this {@code ScrollResult} contains results. 042 */ 043 boolean hasResults(); 044 045}