com.github.ydespreaux.spring.data.elasticsearch.ScrolledPage Maven / Gradle / Ivy
/*
* Copyright (C) 2018 Yoann Despréaux
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; see the file COPYING . If not, write to the
* Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*
* Please send bugreports with examples or suggestions to [email protected]
*/
package com.github.ydespreaux.spring.data.elasticsearch;
import java.util.List;
/**
* Pagination for searches result
*
* @param Items data type
* @author Yoann Despréaux
* @since 0.0.1
*/
public interface ScrolledPage {
/**
* @return current scrollId
*/
String getScrollId();
/**
*
* @return Returns the total number of elements
*/
Long getTotalElements();
/**
*
* @return Returns the list of elements of the current page
*/
List getContent();
/**
*
* @return Returns true if the current page contains elements
*/
Boolean hasContent();
}