java.fedora.oai.ResumptionToken Maven / Gradle / Ivy
Show all versions of fcrepo-client Show documentation
/*
* -----------------------------------------------------------------------------
*
* License and Copyright: The contents of this file are subject to 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.fedora-commons.org/licenses.
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
* the specific language governing rights and limitations under the License.
*
* The entire file consists of original code.
* Copyright © 2008 Fedora Commons, Inc.
*
Copyright © 2002-2007 The Rector and Visitors of the University of
* Virginia and Cornell University
* All rights reserved.
*
* -----------------------------------------------------------------------------
*/
package fedora.oai;
import java.util.Date;
/**
*
* Title: ResumptionToken.java
* Description: A token that can be used to retrieve the remaining
* portion of an incomplete list response.
*
* @author [email protected]
* @version $Id: ResumptionToken.java 3965 2005-04-21 12:52:40Z rlw $
* @see
* http://www.openarchives.org/OAI/openarchivesprotocol.html#FlowControl
*/
public interface ResumptionToken {
/**
* Get the value of the token.
*
* A null value indicates that the associated list is complete.
*/
public abstract String getValue();
/**
* Get the expiration date of the token.
*
* A null value indicates an unknown or unprovided expiration date.
*/
public abstract Date getExpirationDate();
/**
* Get the size of the list.
*
* A negative value indicates an unknown or unprovided list size.
*/
public abstract long getCompleteListSize();
/**
* Get the position in the list that this record starts at.
*
* A negative value indicates an unknown or unprovided position.
*/
public abstract long getCursor();
}