com.ning.billing.util.entity.Pagination Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of killbill-osgi-bundles-jruby Show documentation

There is a newer version: 0.8.14

Show newest version

/*
 * Copyright 2010-2013 Ning, Inc.
 *
 * Ning licenses this file to you 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 com.ning.billing.util.entity;

/**
 * Represents a page, i.e. a subset, of records
 *
 * @param  type of record, usually an Entity
 */
public interface Pagination extends Iterable {

    /**
     * @return offset from which these records are returned
     */
    public Long getCurrentOffset();

    /**
     * @return offset to use to retrieve the next set of records, null
     *         if this is the last page of records
     */
    public Long getNextOffset();

    /**
     * Total number of records in the complete data set, regardless of paging and filtering
     * 
     * The implementation doesn't have to guarantee accuracy.
     *
     * @return total number of records (approximation), null if unknown
     */
    public Long getMaxNbRecords();

    /**
     * Total number of records in the data set, regardless of paging, but including filtering
     * 
     * The implementation doesn't have to guarantee accuracy.
     *
     * @return total number of records (approximation), null if unknown
     */
    public Long getTotalNbRecords();
}