fedora.oai
Class SimpleResumptionToken

java.lang.Object
  fedora.oai.SimpleResumptionToken

All Implemented Interfaces:

ResumptionToken

public class SimpleResumptionToken

extends java.lang.Object

implements ResumptionToken

Title: SimpleResumptionToken.java

Description: A simple implementation of ResumptionToken that provides getters on the values passed in the constructor.

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

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: SimpleResumptionToken.java,v 1.6 2005/01/11 20:06:05 cwilper Exp $

Author:

cwilper@cs.cornell.edu

Constructor Summary

SimpleResumptionToken(java.lang.String value, java.util.Date expirationDate, long completeListSize, long cursor)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleResumptionToken

public SimpleResumptionToken(java.lang.String value,
                             java.util.Date expirationDate,
                             long completeListSize,
                             long cursor)

Method Detail

getValue

public java.lang.String getValue()

Description copied from interface: ResumptionToken

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

Specified by:

getValue in interface ResumptionToken

getExpirationDate

public java.util.Date getExpirationDate()

Description copied from interface: ResumptionToken

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

Specified by:

getExpirationDate in interface ResumptionToken

getCompleteListSize

public long getCompleteListSize()

Description copied from interface: ResumptionToken

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

Specified by:

getCompleteListSize in interface ResumptionToken

getCursor

public long getCursor()

Description copied from interface: ResumptionToken

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

Specified by:

getCursor in interface ResumptionToken