/*
 * Copyright (c) 2005 Your Corporation. All Rights Reserved.
 */
package net.jetmaven;



/**
 * 分頁信息接口
 */
public interface Page
{
    /**
     * 是否是首頁（第一頁），第一頁頁碼為1
     *
     * @return 首頁標識
     */
    public boolean isFirstPage();

    /**
     * 是否是最后一頁
     *
     * @return 末頁標識
     */
    public boolean isLastPage();

    /**
     * 是否有下一頁
     *
     * @return 下一頁標識
     */
    public boolean hasNextPage();

    /**
     * 是否有上一頁
     *
     * @return 上一頁標識
     */
    public boolean hasPreviousPage();

    /**
     * 獲取最后一頁頁碼，也就是總頁數
     *
     * @return 最后一頁頁碼
     */
    public int getLastPageNumber();

    /**
     * 當前頁包含的數據，不同的情況可能返回的數據類型不一樣，如List，RowSet等，請參考具體的實現
     *
     * @return 當前頁數據源
     */
    public Object getThisPageElements();

    /**
     * 總的數據條目數量，0表示沒有數據
     *
     * @return 總數量
     */
    public int getTotalNumberOfElements();

    /**
     * 獲取當前頁的首條數據的行編碼
     *
     * @return 當前頁的首條數據的行編碼
     */
    public int getThisPageFirstElementNumber();

    /**
     * 獲取當前頁的末條數據的行編碼
     *
     * @return 當前頁的末條數據的行編碼
     */
    public int getThisPageLastElementNumber();

    /**
     * 獲取下一頁編碼
     *
     * @return 下一頁編碼
     */
    public int getNextPageNumber();

    /**
     * 獲取上一頁編碼
     *
     * @return 上一頁編碼
     */
    public int getPreviousPageNumber();

    /**
     * 每一頁顯示的條目數
     *
     * @return 每一頁顯示的條目數
     */
    public int getPageSize();

    /**
     * 當前頁的頁碼
     *
     * @return 當前頁的頁碼
     */
    public int getThisPageNumber();

}