001/*
002 * Copyright 2014 Global Biodiversity Information Facility (GBIF)
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 */
016package org.gbif.api.model.common.paging;
017
018import javax.validation.constraints.Min;
019
020/**
021 * Most simple paging interface for both request and responses.
022 */
023public interface Pageable {
024
025  /**
026   * Maximum number of records to be returned.
027   *
028   * @return the limit.
029   */
030  @Min(0)
031  int getLimit();
032
033  /**
034   * Defines how many items to skip before beginning to return records.
035   *
036   * @return the offset with 0 being no offset at all.
037   */
038  @Min(0)
039  long getOffset();
040
041}