fedora.oai
Interface ResumptionToken

All Known Implementing Classes:

SimpleResumptionToken

public interface ResumptionToken

Title: ResumptionToken.java

Description: A token that can be used to retrieve the remaining portion of an incomplete list response.

-----------------------------------------------------------------------------

License and Copyright: The contents of this file are subject to the Mozilla Public License Version 1.1 (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.mozilla.org/MPL/.

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 © 2002-2005 by The Rector and Visitors of the University of Virginia and Cornell University. All rights reserved.

-----------------------------------------------------------------------------

Version:

$Id: ResumptionToken.java,v 1.7 2005/01/11 20:06:05 cwilper Exp $

Author:

cwilper@cs.cornell.edu

See Also:

http://www.openarchives.org/OAI/openarchivesprotocol.html#FlowControl

Method Summary

long	getCompleteListSize() Get the size of the list.
long	getCursor() Get the position in the list that this record starts at.
java.util.Date	getExpirationDate() Get the expiration date of the token.
java.lang.String	getValue() Get the value of the token.

Method Detail

getValue

public java.lang.String getValue()

Get the value of the token. A null value indicates that the associated list is complete.

getExpirationDate

public java.util.Date getExpirationDate()

Get the expiration date of the token. A null value indicates an unknown or unprovided expiration date.

getCompleteListSize

public long getCompleteListSize()

Get the size of the list. A negative value indicates an unknown or unprovided list size.

getCursor

public long getCursor()

Get the position in the list that this record starts at. A negative value indicates an unknown or unprovided position.