org.fcrepo.oai

Interface ResumptionToken

All Known Implementing Classes:

SimpleResumptionToken

public interface ResumptionToken

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

Author:

Chris Wilper

See Also:

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

Method Summary

Methods

Modifier and Type	Method and Description
long	getCompleteListSize() Get the size of the list.
long	getCursor() Get the position in the list that this record starts at.
Date	getExpirationDate() Get the expiration date of the token.
String	getValue() Get the value of the token.

Method Detail

getValue

String getValue()

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

getExpirationDate

Date getExpirationDate()

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

getCompleteListSize

long getCompleteListSize()

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

getCursor

long getCursor()

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