Paginatable.java

/* MyMAM - Open Source Digital Media Asset Management.
 * http://www.mymam.net
 *
 * Copyright 2013, MyMAM contributors as indicated by the @author tag.
 *
 * Licensed 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 net.mymam.controller;

/**
 * Classes implementing {@link Paginatable} can be paginated using the {@link PaginatorBean}.
 *
 * @author fstab
 */
public interface Paginatable {

    /**
     * Total number of pages.
     *
     * @return total number of pages.
     */
    public int getNumberOfPages();

    /**
     * Current page (the first page is page 1, not page 0)
     *
     * @return current page, >= 1.
     */
    public int getCurrentPage();

    /**
     * Set the current page (the first page is page 1, not page 0)
     *
     * @param page the new value for current page, >= 1.
     */
    public void selectPage(int page);
}