001/* 002 * (C) Copyright 2019 Nuxeo (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.scroll; 020 021import java.util.Iterator; 022import java.util.List; 023import java.util.Map; 024 025/** 026 * Execute the scroll on large result set. 027 * 028 * @since 11.1 029 */ 030public interface Scroll extends Iterator<List<String>>, AutoCloseable { 031 032 /** 033 * Initialization of the iterator. 034 */ 035 void init(ScrollRequest request, Map<String, String> options); 036 037 @Override 038 void close(); 039}