com.jk.db.dynamic.paging.DataPager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jk-db-dynamic Show documentation
TBD
The newest version!
/*
 * Copyright 2002-2016 Jalal Kiswani.
 *
 * 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 com.jk.db.dynamic.paging;

/**
 * The Interface DataPager.
 *
 * @author Jalal Kiswani
 */
public interface DataPager {
	
	/**
	 * Gets the all rows count.
	 *
	 * @return the all rows count
	 * @throws PagingException
	 *             the paging exception
	 */
	public int getAllRowsCount() throws PagingException;

	/**
	 * Gets the current page.
	 *
	 * @return the current page
	 * @throws PagingException
	 *             the paging exception
	 */
	public int getCurrentPage() throws PagingException;

	/**
	 * Gets the page rows count.
	 *
	 * @return the page rows count
	 * @throws PagingException
	 *             the paging exception
	 */
	public int getPageRowsCount() throws PagingException;

	/**
	 * Gets the pages count.
	 *
	 * @return the pages count
	 * @throws PagingException
	 *             the paging exception
	 */
	public int getPagesCount() throws PagingException;

	/**
	 * Move to first page.
	 *
	 * @throws PagingException
	 *             the paging exception
	 */
	public void moveToFirstPage() throws PagingException;

	/**
	 * Move to last page.
	 *
	 * @throws PagingException
	 *             the paging exception
	 */
	public void moveToLastPage() throws PagingException;

	/**
	 * Move to next page.
	 *
	 * @throws PagingException
	 *             the paging exception
	 */
	public void moveToNextPage() throws PagingException;

	/**
	 * Move to page.
	 *
	 * @param page
	 *            the page
	 * @throws PagingException
	 *             the paging exception
	 */
	public void moveToPage(int page) throws PagingException;

	/**
	 * Move to previouse page.
	 *
	 * @throws PagingException
	 *             the paging exception
	 */
	public void moveToPreviousePage() throws PagingException;

	/**
	 * Sets the page rows count.
	 *
	 * @param pageRowsCount
	 *            the new page rows count
	 * @throws PagingException
	 *             the paging exception
	 */
	public void setPageRowsCount(int pageRowsCount) throws PagingException;
}