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
021/**
022 * A Scroll request.
023 *
024 * @since 11.1
025 */
026public interface ScrollRequest {
027
028    /**
029     * The type of Scroll.
030     */
031    String getType();
032
033    /**
034     * The Scroll implementation name. Returns {@code null} for default implementation.
035     */
036    String getName();
037
038    /**
039     * The number of items to return per iteration.
040     */
041    int getSize();
042}