CitationIterator.java

/**********************************************************************************
 * $URL: https://source.sakaiproject.org/svn/citations/trunk/citations-api/api/src/java/org/sakaiproject/citation/api/CitationIterator.java $
 * $Id: CitationIterator.java 105079 2012-02-24 23:08:11Z ottenhoff@longsight.com $
 ***********************************************************************************
 *
 * Copyright (c) 2006, 2007, 2008 The Sakai Foundation
 *
 * Licensed under the Educational Community 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.opensource.org/licenses/ECL-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 org.sakaiproject.citation.api;

import java.util.Comparator;
import java.util.Iterator;

/**
 * 
 */
public interface CitationIterator extends Iterator
{
	/**
     * @return
     */
    public int getPageSize();
	
	/**
	 * @return
	 */
	public boolean hasNextPage();
	
	/**
	 * @return
	 */
	public boolean hasPreviousPage();
	
	/**
	 * 
	 */
	public void nextPage();
	
	/**
	 * 
	 */
	public void previousPage();

	/**
	 * @param comparator
	 */
	public void setOrder(Comparator comparator);
	
	/**
	 * @param size
	 */
	public void setPageSize(int size);
	
	public void setStart(int i);
	
	public int getStart();
	
	public int getEnd();

}